diff --git a/docs-util/packages/typedoc-config/entities.js b/docs-util/packages/typedoc-config/entities.js index 4a31015bba..70c9e059c3 100644 --- a/docs-util/packages/typedoc-config/entities.js +++ b/docs-util/packages/typedoc-config/entities.js @@ -11,11 +11,31 @@ module.exports = { tsconfig: path.join(pathPrefix, "packages/medusa/tsconfig.json"), name: "Entities Reference", indexTitle: "Entities Reference", - entryDocument: "index.md", + entryDocument: "_index.mdx", hideInPageTOC: true, hideBreadcrumbs: true, - plugin: [...globalTypedocOptions.plugin, "typedoc-plugin-frontmatter"], + plugin: ["typedoc-plugin-markdown-medusa", "typedoc-plugin-frontmatter"], frontmatterData: { displayed_sidebar: "entitiesSidebar", }, + formatting: { + "*": { + showCommentsAsHeader: true, + sections: { + member_sources_definedIn: false, + reflection_hierarchy: false, + }, + parameterStyle: "component", + parameterComponent: "ParameterTypes", + mdxImports: [ + `import ParameterTypes from "@site/src/components/ParameterTypes"`, + ], + reflectionGroups: { + Constructors: false, + Methods: false, + }, + }, + }, + objectLiteralTypeDeclarationStyle: "component", + mdxOutput: true, } diff --git a/docs-util/packages/typedoc-config/js-client.js b/docs-util/packages/typedoc-config/js-client.js index 3778ef27ec..3eb24da4ea 100644 --- a/docs-util/packages/typedoc-config/js-client.js +++ b/docs-util/packages/typedoc-config/js-client.js @@ -12,7 +12,7 @@ module.exports = { tsconfig: path.join(pathPrefix, "packages/medusa-js/tsconfig.json"), name: "JS Client Reference", indexTitle: "JS Client Reference", - entryDocument: "index.md", + entryDocument: "_index.mdx", hideInPageTOC: true, hideBreadcrumbs: true, plugin: [ diff --git a/docs-util/packages/typedoc-config/modules.js b/docs-util/packages/typedoc-config/modules.js index c8b8acc6da..1b43bb6105 100644 --- a/docs-util/packages/typedoc-config/modules.js +++ b/docs-util/packages/typedoc-config/modules.js @@ -86,7 +86,6 @@ module.exports = ({ "typedoc-plugin-rename-defaults", "typedoc-plugin-frontmatter", ], - hideMembersSymbol: true, formatting, allReflectionsHaveOwnDocument: true, objectLiteralTypeDeclarationStyle: "component", diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/index.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/index.ts index cb1d3864e1..849986bf8c 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/index.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/index.ts @@ -71,7 +71,7 @@ export function load(app: Application) { help: "[Markdown Plugin] Do not add special symbols for class members.", name: "hideMembersSymbol", type: ParameterType.Boolean, - defaultValue: false, + defaultValue: true, }) app.options.addDeclaration({ diff --git a/www/apps/docs/content/development/batch-jobs/index.mdx b/www/apps/docs/content/development/batch-jobs/index.mdx index a8187d9ca1..faed836020 100644 --- a/www/apps/docs/content/development/batch-jobs/index.mdx +++ b/www/apps/docs/content/development/batch-jobs/index.mdx @@ -21,7 +21,7 @@ You can also create a custom batch job or overwrite Medusa’s batch jobs. ### BatchJob Entity Overview -A batch job is stored in the database as a [BatchJob](../../references/entities/classes/BatchJob) entity. Some of its important attributes are: +A batch job is stored in the database as a [BatchJob](../../references/entities/classes/BatchJob.mdx) entity. Some of its important attributes are: - `status`: A string that determines the current status of the Batch Job. - `context`: An object that can be used to store configurations related to the batch job. For example, you can use it to store listing configurations such as the limit or offset of the list to be retrieved during the processing of the batch job. diff --git a/www/apps/docs/content/development/events/events-list.md b/www/apps/docs/content/development/events/events-list.md index 0f3bb93e8e..d4b7605450 100644 --- a/www/apps/docs/content/development/events/events-list.md +++ b/www/apps/docs/content/development/events/events-list.md @@ -1948,7 +1948,7 @@ Triggered when a payment is created. -The entire payment passed as an object. You can refer to the [Payment entity](../../references/entities/classes/Payment.md) for an idea of what fields to expect. +The entire payment passed as an object. You can refer to the [Payment entity](../../references/entities/classes/Payment.mdx) for an idea of what fields to expect. @@ -1966,7 +1966,7 @@ Triggered when a payment is updated. -The entire payment passed as an object. You can refer to the [Payment entity](../../references/entities/classes/Payment.md) for an idea of what fields to expect. +The entire payment passed as an object. You can refer to the [Payment entity](../../references/entities/classes/Payment.mdx) for an idea of what fields to expect. @@ -1984,7 +1984,7 @@ Triggered when a payment is captured. -The entire payment passed as an object. You can refer to the [Payment entity](../../references/entities/classes/Payment.md) for an idea of what fields to expect. +The entire payment passed as an object. You can refer to the [Payment entity](../../references/entities/classes/Payment.mdx) for an idea of what fields to expect. @@ -2002,7 +2002,7 @@ Triggered when the capturing of a payment fails. -The entire payment passed as an object. You can refer to the [Payment entity](../../references/entities/classes/Payment.md) for an idea of what fields to expect. +The entire payment passed as an object. You can refer to the [Payment entity](../../references/entities/classes/Payment.mdx) for an idea of what fields to expect. In addition, an error object is passed within the same object as the Payment Processor: @@ -2034,7 +2034,7 @@ Triggered when a refund of a payment is created. -The entire refund passed as an object. You can refer to the [Refund entity](../../references/entities/classes/Refund.md) for an idea of what fields to expect. +The entire refund passed as an object. You can refer to the [Refund entity](../../references/entities/classes/Refund.mdx) for an idea of what fields to expect. @@ -2052,7 +2052,7 @@ Triggered when a payment's refund fails. -The entire payment passed as an object. You can refer to the [Payment entity](../../references/entities/classes/Payment.md) for an idea of what fields to expect. +The entire payment passed as an object. You can refer to the [Payment entity](../../references/entities/classes/Payment.mdx) for an idea of what fields to expect. @@ -2095,7 +2095,7 @@ Triggered when a payment collection is created. -The entire payment collection passed as an object. You can refer to the [Payment Collection entity](../../references/entities/classes/PaymentCollection.md) for an idea of what fields to expect. +The entire payment collection passed as an object. You can refer to the [Payment Collection entity](../../references/entities/classes/PaymentCollection.mdx) for an idea of what fields to expect. @@ -2113,7 +2113,7 @@ Triggered when a payment collection is update. -The entire payment collection passed as an object. You can refer to the [Payment Collection entity](../../references/entities/classes/PaymentCollection.md) for an idea of what fields to expect. +The entire payment collection passed as an object. You can refer to the [Payment Collection entity](../../references/entities/classes/PaymentCollection.mdx) for an idea of what fields to expect. @@ -2131,7 +2131,7 @@ Triggered when a payment collection is deleted. -The entire payment collection passed as an object. You can refer to the [Payment Collection entity](../../references/entities/classes/PaymentCollection.md) for an idea of what fields to expect. +The entire payment collection passed as an object. You can refer to the [Payment Collection entity](../../references/entities/classes/PaymentCollection.mdx) for an idea of what fields to expect. @@ -2149,7 +2149,7 @@ Triggered when a payment collection is either marked authorized or its payment s -The entire payment collection passed as an object. You can refer to the [Payment Collection entity](../../references/entities/classes/PaymentCollection.md) for an idea of what fields to expect. +The entire payment collection passed as an object. You can refer to the [Payment Collection entity](../../references/entities/classes/PaymentCollection.mdx) for an idea of what fields to expect. @@ -2216,7 +2216,7 @@ Triggered when a product and data associated with it (options, variant orders, e -The entire product passed as an object. You can refer to the [Product entity](../../references/entities/classes/Product.md) for an idea of what fields to expect. +The entire product passed as an object. You can refer to the [Product entity](../../references/entities/classes/Product.mdx) for an idea of what fields to expect. In one case, when the `/admin/products/{id}` API Route is used to update the product, the payload is an object of the following format: diff --git a/www/apps/docs/content/development/notification/overview.mdx b/www/apps/docs/content/development/notification/overview.mdx index 54938fc204..0206e8d3e4 100644 --- a/www/apps/docs/content/development/notification/overview.mdx +++ b/www/apps/docs/content/development/notification/overview.mdx @@ -58,7 +58,7 @@ A Notification also represents a resent notification. So, when a notification is ### Notification Entity Overview -The two most important properties in the [`Notification`](../../references/entities/classes/Notification.md) entity are the `to` and `data` properties. +The two most important properties in the [`Notification`](../../references/entities/classes/Notification.mdx) entity are the `to` and `data` properties. The `to` property is a string that represents the receiver of the Notification. For example, if the Notification was sent to an email address, the `to` property holds the email address the Notification was sent to. diff --git a/www/apps/docs/content/development/strategies/override-strategy.md b/www/apps/docs/content/development/strategies/override-strategy.md index fe4e3cf8fb..40da7cd681 100644 --- a/www/apps/docs/content/development/strategies/override-strategy.md +++ b/www/apps/docs/content/development/strategies/override-strategy.md @@ -37,7 +37,7 @@ There are other resources that provide steps specific to a strategy type: - [How to override the Cart Completion Strategy](../../modules/carts-and-checkout/backend/cart-completion-strategy.md) - [How to override the Tax Calculation Strategy](../../modules/taxes/backend/tax-calculation-strategy.md) -- [How to override the Price Selection Strategy](../../modules/price-lists/backend/override-price-selection-strategy.md) +- [How to override the Price Selection Strategy](../../modules/price-lists/backend/override-price-selection-strategy.mdx) - [How to override a Batch Job Strategy](../batch-jobs/customize-import.md) --- diff --git a/www/apps/docs/content/modules/carts-and-checkout/backend/add-fulfillment-provider.md b/www/apps/docs/content/modules/carts-and-checkout/backend/add-fulfillment-provider.md index d655f9fe29..83f5c46d23 100644 --- a/www/apps/docs/content/modules/carts-and-checkout/backend/add-fulfillment-provider.md +++ b/www/apps/docs/content/modules/carts-and-checkout/backend/add-fulfillment-provider.md @@ -262,7 +262,7 @@ It accepts four parameters: 1. If the resource the fulfillment is being created for is a claim, the `is_claim` property in the object will be `true`. 2. If the resource the fulfillment is being created for is a swap, the `is_swap` property in the object will be `true`. 3. Otherwise, the resource is an order. -4. The fourth parameter is an object of type [Fulfillment](../../../references/entities/classes/Fulfillment.md), which is the fulfillment being created. +4. The fourth parameter is an object of type [Fulfillment](../../../references/entities/classes/Fulfillment.mdx), which is the fulfillment being created. You can use the `data` property in the shipping method (first parameter) to access the data specific to the shipping option. This is based on your implementation of previous methods. @@ -328,7 +328,7 @@ This method receives three parameters: 1. If the price is being calculated for the list of shipping options available for a cart, it's the `data` object of the shipping option. 2. If the price is being calculated when the shipping method is being created, it's the data returned by the [validateFulfillmentData](#validatefulfillmentdata) method used during the shipping method creation. 3. If the price is being calculated while calculating the cart's totals, it will be the `data` object of the cart's shipping method. -3. The third parameter is either the [Cart](../../../references/entities/classes/Cart.md) or the [Order](../../../references/entities/classes/Order.md) object. +3. The third parameter is either the [Cart](../../../references/entities/classes/Cart.mdx) or the [Order](../../../references/entities/classes/Order.mdx) object. The method is expected to return a number that will be used to set the price of the shipping method or option, based on the context it's used in. @@ -368,7 +368,7 @@ Fulfillment providers can also be used to return products. A shipping option can This method is used when the admin [creates a return request](https://docs.medusajs.com/api/admin#orders_postordersorderreturns) for an order, [creates a swap](https://docs.medusajs.com/api/admin#orders_postordersorderswaps) for an order, or when the customer [creates a return of their order](https://docs.medusajs.com/api/store#returns_postreturns). The fulfillment is created automatically for the order return. -The method receives as a parameter the [Return](../../../references/entities/classes/Return.md) object, which is the return that the fulfillment is being created for. +The method receives as a parameter the [Return](../../../references/entities/classes/Return.mdx) object, which is the return that the fulfillment is being created for. The method must return an object that will be used to set the value of the `shipping_data` attribute of the return being created. diff --git a/www/apps/docs/content/modules/carts-and-checkout/backend/add-payment-provider.md b/www/apps/docs/content/modules/carts-and-checkout/backend/add-payment-provider.md index a822b6e2ec..a1f63e4132 100644 --- a/www/apps/docs/content/modules/carts-and-checkout/backend/add-payment-provider.md +++ b/www/apps/docs/content/modules/carts-and-checkout/backend/add-payment-provider.md @@ -138,7 +138,7 @@ class MyPaymentProcessor extends AbstractPaymentProcessor { Record | PaymentProcessorError > { - throw new Error("Method not implemented."); + throw new Error("Method not implemented.") } } @@ -440,7 +440,7 @@ An example of a minimal implementation of `updatePaymentData` that returns the ` ```ts import { - PaymentProcessorError + PaymentProcessorError, } from "@medusajs/medusa" // ... diff --git a/www/apps/docs/content/modules/carts-and-checkout/cart.md b/www/apps/docs/content/modules/carts-and-checkout/cart.md index d7774e9875..2d8ce9ec90 100644 --- a/www/apps/docs/content/modules/carts-and-checkout/cart.md +++ b/www/apps/docs/content/modules/carts-and-checkout/cart.md @@ -26,7 +26,7 @@ A cart is represented by the `Cart` entity. Some of the `Cart` entity’s attrib - `completed_at`: the date the cart was completed. A completed cart means that it has been used for its main purpose. For example, if the cart is used to place an order, then a completed cart means that the order was placed. - `payment_authorized_at`: the date a payment was authorized. -There are other important attributes discussed in later sections. Check out the [full Cart entity in the entities reference](../../references/entities/classes/Cart.md). +There are other important attributes discussed in later sections. Check out the [full Cart entity in the entities reference](../../references/entities/classes/Cart.mdx). --- diff --git a/www/apps/docs/content/modules/carts-and-checkout/payment.md b/www/apps/docs/content/modules/carts-and-checkout/payment.md index cd5bd8c31b..31dbc630fe 100644 --- a/www/apps/docs/content/modules/carts-and-checkout/payment.md +++ b/www/apps/docs/content/modules/carts-and-checkout/payment.md @@ -58,7 +58,7 @@ It’s important to enable a payment processor in a region, or else the payment ### PaymentProvider Entity Overview -The [`PaymentProvider`](../../references/entities/classes/PaymentProvider.md) entity only has 2 attributes: `is_installed` which is a boolean value indicating whether the Payment Processor is installed; and `id` which is the unique identifier that you define in the Payment Processor service. +The [`PaymentProvider`](../../references/entities/classes/PaymentProvider.mdx) entity only has 2 attributes: `is_installed` which is a boolean value indicating whether the Payment Processor is installed; and `id` which is the unique identifier that you define in the Payment Processor service. --- @@ -82,7 +82,7 @@ Among the Payment Sessions available only one will be selected based on the cust ### PaymentSession Entity Overview -The [`PaymentSession`](../../references/entities/classes/PaymentSession.md) entity belongs to a `Cart`. This is the customer‘s cart that was used for checkout which lead to the creation of the Payment Session. +The [`PaymentSession`](../../references/entities/classes/PaymentSession.mdx) entity belongs to a `Cart`. This is the customer‘s cart that was used for checkout which lead to the creation of the Payment Session. The `PaymentSession` instance also belongs to a `PaymentProvider` instance. This is the Payment Processor that was used to create the Payment Session and that controls it for further actions like authorizing the payment. @@ -116,7 +116,7 @@ When the store operator then chooses to capture the order from the Medusa Admin, ### Payment Entity Overview -The [`Payment`](../../references/entities/classes/Payment.md) entity belongs to the `Cart` that it was originally created from when the customer’s payment was authorized. It also belongs to an `Order` once it’s placed. Additionally, it belongs to a `PaymentProvider` which is the payment processor that the customer chose on checkout. +The [`Payment`](../../references/entities/classes/Payment.mdx) entity belongs to the `Cart` that it was originally created from when the customer’s payment was authorized. It also belongs to an `Order` once it’s placed. Additionally, it belongs to a `PaymentProvider` which is the payment processor that the customer chose on checkout. In case a `Swap` is created for an order, `Payment` will be associated with that swap to handle payment operations related to it. diff --git a/www/apps/docs/content/modules/carts-and-checkout/shipping.md b/www/apps/docs/content/modules/carts-and-checkout/shipping.md index 845adb8508..f319c7dec0 100644 --- a/www/apps/docs/content/modules/carts-and-checkout/shipping.md +++ b/www/apps/docs/content/modules/carts-and-checkout/shipping.md @@ -49,7 +49,7 @@ Once the Fulfillment Provider is added to the backend, the store operator will b ### FulfillmentProvider Entity Overview -The [`FulfillmentProvider`](../../references/entities/classes/FulfillmentProvider.md) entity only has 2 attributes: `is_installed` to indicate if the fulfillment provider is installed and its value is a boolean; and `id` which is the unique identifier that you define in the Fulfillment Provider Service. +The [`FulfillmentProvider`](../../references/entities/classes/FulfillmentProvider.mdx) entity only has 2 attributes: `is_installed` to indicate if the fulfillment provider is installed and its value is a boolean; and `id` which is the unique identifier that you define in the Fulfillment Provider Service. --- @@ -73,7 +73,7 @@ For example, shipping heavy items might be more expensive than others, which wou ### ShippingProfile Entity Overview -The [`ShippingProfile`](../../references/entities/classes/ShippingProfile.md) entity can have a set of `Product` instances. These would be the products the shipping profile is providing shipping options for. +The [`ShippingProfile`](../../references/entities/classes/ShippingProfile.mdx) entity can have a set of `Product` instances. These would be the products the shipping profile is providing shipping options for. The `ShippingProfile` has a `type` attribute that can be `default`, `gift_card`, or `custom`. @@ -101,7 +101,7 @@ Think of a shipping option as a template defined by the admin that indicates wha ### ShippingOption Entity Overview -The [`ShippingOption`](../../references/entities/classes/ShippingOption.md) entity belongs to the `ShippingProfile` entity. +The [`ShippingOption`](../../references/entities/classes/ShippingOption.mdx) entity belongs to the `ShippingProfile` entity. The `ShippingOption` entity also belongs to a `FulfillmentProvider`. This can be either a custom third-party provider or one of Medusa’s default fulfillment providers. @@ -139,7 +139,7 @@ This separation allows for developers to implement the custom integration with t A lot of the shipping method’s attributes are similar to the shipping option’s attribute. -The [`ShippingMethod`](../../references/entities/classes/ShippingMethod.md) entity belongs to a `ShippingOption`. +The [`ShippingMethod`](../../references/entities/classes/ShippingMethod.mdx) entity belongs to a `ShippingOption`. Similar to the `data` attribute explained for the `ShippingOption` entity, a `ShippingMethod` has a similar `data` attribute that includes all the data to be sent to the fulfillment provider when fulfilling the order. diff --git a/www/apps/docs/content/modules/customers/customer-groups.md b/www/apps/docs/content/modules/customers/customer-groups.md index ba629c926d..6557f32431 100644 --- a/www/apps/docs/content/modules/customers/customer-groups.md +++ b/www/apps/docs/content/modules/customers/customer-groups.md @@ -24,7 +24,7 @@ The customer groups feature can be used in a variety of use cases including: ## CustomerGroup Entity Overview -A customer group is stored in the database as a [CustomerGroup](../../references/entities/classes/CustomerGroup.md) entity. This entity has two attributes other than the `id`: `name` and `metadata`. +A customer group is stored in the database as a [CustomerGroup](../../references/entities/classes/CustomerGroup.mdx) entity. This entity has two attributes other than the `id`: `name` and `metadata`. Similar to all entities in Medusa, you can use the `metadata` object attribute to store any custom data you want. For example, you can add some flag or tag to the customer group for a custom use case: diff --git a/www/apps/docs/content/modules/discounts/discounts.md b/www/apps/docs/content/modules/discounts/discounts.md index 72523782de..1c89da61cc 100644 --- a/www/apps/docs/content/modules/discounts/discounts.md +++ b/www/apps/docs/content/modules/discounts/discounts.md @@ -32,7 +32,7 @@ Discounts can be used in many use cases including: ## Discount Entity Overview -A discount is represented by the [`Discount`](../../references/entities/classes/Discount.md) entity. Some of its important attributes are: +A discount is represented by the [`Discount`](../../references/entities/classes/Discount.mdx) entity. Some of its important attributes are: - `code` is a unique code that you specify when you create the discount. Customers use this code to apply the discount during checkout. The code can only include upper-case letters and numbers. - `rule_id` is the ID of the rule of this discount. The `rule` attribute is the expanded object of the `DiscountRule` entity. You can use the `rule` attribute to get details regarding the discount type. You can learn more about this in the [`DiscountRule` entity overview](#discountrule-entity-overview) later. @@ -54,7 +54,7 @@ The `is_dynamic` attribute in the `Discount` entity is a boolean value that dete ## DiscountRule Entity Overview -Every `Discount` entity belongs to a [`DiscountRule`](../../references/entities/classes/DiscountRule.md) entity. `DiscountRule` includes details such as the type of discount, the amount to be discounted, and more. +Every `Discount` entity belongs to a [`DiscountRule`](../../references/entities/classes/DiscountRule.mdx) entity. `DiscountRule` includes details such as the type of discount, the amount to be discounted, and more. Some of the `DiscountRule` entity’s important attributes are: @@ -71,7 +71,7 @@ Some of the `DiscountRule` entity’s important attributes are: A discount can optionally have discount conditions. Discount conditions are used to further add limitations on when the discount can be applied. -A [`DiscountCondition`](../../references/entities/classes/DiscountCondition.md) belongs to a `DiscountRule` entity. The `discount_rule_id` attribute indicates the ID of the `DiscountRule` it belongs to. +A [`DiscountCondition`](../../references/entities/classes/DiscountCondition.mdx) belongs to a `DiscountRule` entity. The `discount_rule_id` attribute indicates the ID of the `DiscountRule` it belongs to. Discount conditions have an attribute `type` that indicates the condition’s type. Its value must be one of the following: @@ -92,11 +92,11 @@ Discount conditions also have an attribute `operator` that indicates how the con Based on the value of `type`, one of the following relations can be used to retrieve the condition’s items: -- `products` is an array of products that this condition applies to if the condition’s `type` is `products`. Each item of the array would be a [`DiscountConditionProduct`](../../references/entities/classes/DiscountConditionProduct.md). -- `product_types` is an array of product types that this condition applies to if the condition’s `type` is `product_types`. Each item of the array would be a [`DiscountConditionProductType`](../../references/entities/classes/DiscountConditionProductType.md). -- `product_collections` is an array of product collections that this condition applies to if the condition’s `type` is `product_collections`. Each item of the array would be a [`DiscountConditionProductCollection`](../../references/entities/classes/DiscountConditionProductCollection.md). -- `product_tags` is an array of product tags that this condition applies to if the condition’s `type` is `product_tags`. Each item of the array would be a [`DiscountConditionProductTag`](../../references/entities/classes/DiscountConditionProductTag.md). -- `customer_groups` is an array of customer groups that this condition applies to if the condition’s `type` is `customer_groups`. Each item of the array would be a [`DiscountConditionCustomerGroup`](../../references/entities/classes/DiscountConditionCustomerGroup.md). +- `products` is an array of products that this condition applies to if the condition’s `type` is `products`. Each item of the array would be a [`DiscountConditionProduct`](../../references/entities/classes/DiscountConditionProduct.mdx). +- `product_types` is an array of product types that this condition applies to if the condition’s `type` is `product_types`. Each item of the array would be a [`DiscountConditionProductType`](../../references/entities/classes/DiscountConditionProductType.mdx). +- `product_collections` is an array of product collections that this condition applies to if the condition’s `type` is `product_collections`. Each item of the array would be a [`DiscountConditionProductCollection`](../../references/entities/classes/DiscountConditionProductCollection.mdx). +- `product_tags` is an array of product tags that this condition applies to if the condition’s `type` is `product_tags`. Each item of the array would be a [`DiscountConditionProductTag`](../../references/entities/classes/DiscountConditionProductTag.mdx). +- `customer_groups` is an array of customer groups that this condition applies to if the condition’s `type` is `customer_groups`. Each item of the array would be a [`DiscountConditionCustomerGroup`](../../references/entities/classes/DiscountConditionCustomerGroup.mdx). ![Discounts Architecture](https://res.cloudinary.com/dza7lstvk/image/upload/v1678372360/Medusa%20Docs/Diagrams/discounts_ioivrl.png) diff --git a/www/apps/docs/content/modules/gift-cards/gift-cards.md b/www/apps/docs/content/modules/gift-cards/gift-cards.md index a51d5c231e..a03c0e27e6 100644 --- a/www/apps/docs/content/modules/gift-cards/gift-cards.md +++ b/www/apps/docs/content/modules/gift-cards/gift-cards.md @@ -34,7 +34,7 @@ As custom gift cards can be used once they’re created, they’re also represen ## GiftCard Entity Overview -Some of the [GiftCard](../../references/entities/classes/GiftCard.md) entity’s attributes are: +Some of the [GiftCard](../../references/entities/classes/GiftCard.mdx) entity’s attributes are: - `code`: a unique string of random characters. This is the code that the customer can use during their checkout to redeem the gift card. - `value`: The amount of the gift card. This is the amount the customer purchased, or was gifted in the case of custom gift cards. diff --git a/www/apps/docs/content/modules/orders/admin/manage-orders.mdx b/www/apps/docs/content/modules/orders/admin/manage-orders.mdx index 1199569cf3..6c5df5dc86 100644 --- a/www/apps/docs/content/modules/orders/admin/manage-orders.mdx +++ b/www/apps/docs/content/modules/orders/admin/manage-orders.mdx @@ -208,7 +208,7 @@ curl -L -X GET '/admin/orders?status[]=completed' \ :::note -You can check available order statuses [here](../../../references/entities/enums/OrderStatus). +You can check available order statuses [here](../../../references/entities/enums/OrderStatus.mdx). ::: diff --git a/www/apps/docs/content/modules/orders/claims.md b/www/apps/docs/content/modules/orders/claims.md index ca60ad9783..7c48dd8441 100644 --- a/www/apps/docs/content/modules/orders/claims.md +++ b/www/apps/docs/content/modules/orders/claims.md @@ -19,12 +19,12 @@ The Medusa core provides the necessary implementation and functionalities that a A claim is represented by the `ClaimOrder` entity. Some of its attributes include: - `type`: a string indicating the type of the claim. Its value can be either `refund` or `replace`. -- `payment_status`: a string indicating the status of the claim’s payment. Its possible values are indicated by the [ClaimPaymentStatus enum](../../references/entities/enums/ClaimPaymentStatus.md). This attribute is useful to check the status of the payment if the claim’s type is `refund`. -- `fulfillment_status`: a string indicating the status of the claim’s fulfillment. Its possible values are indicated by the [ClaimFulfillmentStatus enum](../../references/entities/enums/ClaimFulfillmentStatus.md). This attribute is useful to check the status of the fulfillment if the claim’s type is `replace`. +- `payment_status`: a string indicating the status of the claim’s payment. Its possible values are indicated by the [ClaimPaymentStatus enum](../../references/entities/enums/ClaimPaymentStatus.mdx). This attribute is useful to check the status of the payment if the claim’s type is `refund`. +- `fulfillment_status`: a string indicating the status of the claim’s fulfillment. Its possible values are indicated by the [ClaimFulfillmentStatus enum](../../references/entities/enums/ClaimFulfillmentStatus.mdx). This attribute is useful to check the status of the fulfillment if the claim’s type is `replace`. - `refund_amount`: an integer used to indicate the amount that should be refunded to the customer. This is only useful if the claim’s type is `refund`. - `canceled_at`: a date indicating when the claim was canceled. -There are other important attributes discussed in later sections. Check out the [full ClaimOrder entity in the entities reference](../../references/entities/classes/ClaimOrder.md). +There are other important attributes discussed in later sections. Check out the [full ClaimOrder entity in the entities reference](../../references/entities/classes/ClaimOrder.mdx). --- diff --git a/www/apps/docs/content/modules/orders/draft-orders.md b/www/apps/docs/content/modules/orders/draft-orders.md index c6a32c728c..6080e07146 100644 --- a/www/apps/docs/content/modules/orders/draft-orders.md +++ b/www/apps/docs/content/modules/orders/draft-orders.md @@ -26,7 +26,7 @@ Some of the `DraftOrder`'s attributes include: - `completed_at`: a date indicating when the draft order was completed. - `no_notification_order`: a boolean indicating whether the customer should receive notifications when the order is updated. -There are other important attributes discussed in later sections. Check out the [full DraftOrder entity in the entities reference](../../references/entities/classes/DraftOrder.md). +There are other important attributes discussed in later sections. Check out the [full DraftOrder entity in the entities reference](../../references/entities/classes/DraftOrder.mdx). --- diff --git a/www/apps/docs/content/modules/orders/fulfillments.md b/www/apps/docs/content/modules/orders/fulfillments.md index 8fe202f6a3..bc9410d34e 100644 --- a/www/apps/docs/content/modules/orders/fulfillments.md +++ b/www/apps/docs/content/modules/orders/fulfillments.md @@ -27,7 +27,7 @@ Some of the `Fulfillment` entity’s attributes include: - `shipped_at`: a date indicating when the fulfillment was shipped. - `canceled_at`: a date indicating when the fulfillment was canceled. -There are other important attributes discussed in later sections. Check out the [full Fulfillment entity in the entities reference](../../references/entities/classes/Fulfillment.md). +There are other important attributes discussed in later sections. Check out the [full Fulfillment entity in the entities reference](../../references/entities/classes/Fulfillment.mdx). --- diff --git a/www/apps/docs/content/modules/orders/orders.md b/www/apps/docs/content/modules/orders/orders.md index 03970119d6..a2c8a1c509 100644 --- a/www/apps/docs/content/modules/orders/orders.md +++ b/www/apps/docs/content/modules/orders/orders.md @@ -37,7 +37,7 @@ Some of the attributes of the `Order` entity include: - `no_notification`: a boolean value indicating whether the customer should receive notifications when the order is updated. - `external_id`: a string indicating an ID of the order in an external system. This can be useful if you’re migrating your orders from another commerce system or you’re linking your order to a third-party service. -There are other important attributes discussed in later sections. Check out the full [Order entity in the entities reference](../../references/entities/classes/Order.md). +There are other important attributes discussed in later sections. Check out the full [Order entity in the entities reference](../../references/entities/classes/Order.mdx). --- @@ -145,7 +145,7 @@ Some of the `OrderEdit`'s other attributes include: - `confirmed_by`: a string that typically should hold the ID of who confirmed the order edit. Similar to the `created_by` attribute, there are no restrictions on what value this attribute can actually hold. - `declined_by`: a string that typically should hold the ID of who declined the order edit. Similar to the `created_by` attribute, there are no restrictions on what value this attribute can actually hold. -There are other attributes explained in other sections. You can also check out the full [OrderEdit entity in the entities reference](../../references/entities/classes/OrderEdit.md). +There are other attributes explained in other sections. You can also check out the full [OrderEdit entity in the entities reference](../../references/entities/classes/OrderEdit.mdx). ### Item Changes diff --git a/www/apps/docs/content/modules/orders/returns.md b/www/apps/docs/content/modules/orders/returns.md index 404f7983df..277e857f61 100644 --- a/www/apps/docs/content/modules/orders/returns.md +++ b/www/apps/docs/content/modules/orders/returns.md @@ -28,7 +28,7 @@ Some of the `Return` entity’s attributes include: - `no_notification`: a boolean value indicating whether the customer should receive notification updates when there are any changes in the return. - `shipping_data`: this is a JSONB object that can hold any data related to the fulfillment associated with the return. -There are other important attributes discussed in later sections. Check out the [full Return entity in the entities reference](../../references/entities/classes/Return.md). +There are other important attributes discussed in later sections. Check out the [full Return entity in the entities reference](../../references/entities/classes/Return.mdx). --- diff --git a/www/apps/docs/content/modules/orders/swaps.md b/www/apps/docs/content/modules/orders/swaps.md index dd2d59fcac..4ccfb1dcc9 100644 --- a/www/apps/docs/content/modules/orders/swaps.md +++ b/www/apps/docs/content/modules/orders/swaps.md @@ -18,8 +18,8 @@ The Medusa core provides the necessary implementation and functionalities that a Some of the attributes of the `Swap` entity include: -- `fulfillment_status`: a string indicating the status of the swap’s fulfillment. Its possible values indicated by the [SwapFulfillmentStatus enum](../../references/entities/enums/SwapFulfillmentStatus.md) can determine whether all items have been fulfilled, shipped, or canceled. -- `payment_status`: a string indicating the status of the swap’s payment. Its possible values indicated by the [SwapPaymentStatus enum](../../references/entities/enums/SwapFulfillmentStatus.md) can determine whether the payment of the swap has been captured or refunded. +- `fulfillment_status`: a string indicating the status of the swap’s fulfillment. Its possible values indicated by the [SwapFulfillmentStatus enum](../../references/entities/enums/SwapFulfillmentStatus.mdx) can determine whether all items have been fulfilled, shipped, or canceled. +- `payment_status`: a string indicating the status of the swap’s payment. Its possible values indicated by the [SwapPaymentStatus enum](../../references/entities/enums/SwapFulfillmentStatus.mdx) can determine whether the payment of the swap has been captured or refunded. - `difference_due`: An integer indicating the difference amount between the order’s original total and the new total imposed by the swap. - If the value of `difference_due` is negative, that means the customer should be refunded. - If it’s positive, that means the customer must authorize additional payment. @@ -29,7 +29,7 @@ Some of the attributes of the `Swap` entity include: - `no_notification`: a boolean value indicating whether the customer should receive notifications when the order is updated. - `allow_backorder`: a boolean value indicating whether a swap can be created and completed with items that are out of stock. -There are other important attributes discussed in later sections. Check out the full [Swap entity in the entities reference](../../references/entities/classes/Swap.md). +There are other important attributes discussed in later sections. Check out the full [Swap entity in the entities reference](../../references/entities/classes/Swap.mdx). --- diff --git a/www/apps/docs/content/modules/price-lists/backend/override-price-selection-strategy.md b/www/apps/docs/content/modules/price-lists/backend/override-price-selection-strategy.md deleted file mode 100644 index f820118e78..0000000000 --- a/www/apps/docs/content/modules/price-lists/backend/override-price-selection-strategy.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -description: 'Learn how to override the price selection strategy. The price selection strategy is used to determine the best price based on a specific context.' -addHowToData: true ---- - -# How to Override Price Selection Strategy - -In this document, you’ll learn how to override Medusa’s price selection strategy to create a custom pricing strategy. - -:::note - -If you’re interested in learning what a price selection strategy is and how it works, check out [this documentation](../price-selection-strategy.md) instead. - -::: - -## 1. Create Class - -Create a TypeScript or JavaScript file in `src/strategies` of your Medusa backend project with a class that extends the `AbstractPriceSelectionStrategy` class: - -```ts title=src/strategies/price.ts -import { - AbstractPriceSelectionStrategy, - IPriceSelectionStrategy, - PriceSelectionContext, - PriceSelectionResult, -} from "@medusajs/medusa" - -import { EntityManager } from "typeorm" - -export default class MyStrategy extends - AbstractPriceSelectionStrategy { - withTransaction( - manager: EntityManager - ): IPriceSelectionStrategy { - if (!manager) { - return this - } - - return new MyStrategy() - } - - async calculateVariantPrice( - variant_id: string, - context: PriceSelectionContext - ): Promise { - // TODO - } -} -``` - -You can use services or repositories in the strategy by adding them to the constructor and updating the parameters passed to the `MyStrategy` constructor in `withTransaction`. For example: - -```ts -import { - AbstractPriceSelectionStrategy, - CustomerService, - IPriceSelectionStrategy, - PriceSelectionContext, - PriceSelectionResult, -} from "@medusajs/medusa" - -export default class MyStrategy extends - AbstractPriceSelectionStrategy { - private customerService: CustomerService - - constructor({ - customerService, - }) { - super() - this.customerService = customerService - } - - withTransaction( - manager: EntityManager - ): IPriceSelectionStrategy { - if (!manager) { - return this - } - - return new MyStrategy({ - customerService: this.customerService, - }) - } - // ... -} -``` - ---- - -## 2. Implement calculateVariantPrice - -Implement the price selection strategy you want inside the `calculateVariantPrice` method. - -This method accepts the variant ID as a first parameter and the [context](../price-selection-strategy.md#context-object) object as a second parameter. - -This method must return an object having the following fields: - -```ts noReport -{ - originalPrice, // number | null - calculatedPrice, // number | null - prices // MoneyAmount[] -} -``` - -You can learn more about optional properties and the meaning behind every property [here](../price-selection-strategy.md#calculatevariantprice-method). - ---- - -## 3. Run Build Command - -In your terminal, run the build command to transpile the files in the `src` directory into the `dist` directory: - -```bash npm2yarn -npm run build -``` - ---- - -## Test it Out - -Run your backend to test it out: - -```bash npm2yarn -npx medusa develop -``` - -Then, try out your strategy using any of the [Products](https://docs.medusajs.com/api/store#products) or [Carts](https://docs.medusajs.com/api/store#carts) API Routes which include retrieving product variants and line items respectively. You should then see the prices in the response based on your implemented strategy. diff --git a/www/apps/docs/content/modules/price-lists/backend/override-price-selection-strategy.mdx b/www/apps/docs/content/modules/price-lists/backend/override-price-selection-strategy.mdx new file mode 100644 index 0000000000..346705af89 --- /dev/null +++ b/www/apps/docs/content/modules/price-lists/backend/override-price-selection-strategy.mdx @@ -0,0 +1,295 @@ +--- +description: 'Learn how to override the price selection strategy. The price selection strategy is used to determine the best price based on a specific context.' +addHowToData: true +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# How to Override Price Selection Strategy + +In this document, you’ll learn how to override Medusa’s price selection strategy to create a custom pricing strategy. + +:::note + +If you’re interested in learning what a price selection strategy is and how it works, check out [this documentation](../price-selection-strategy.md) instead. + +::: + +## 1. Create Class + +Create a TypeScript or JavaScript file in `src/strategies` of your Medusa backend project with a class that extends the `AbstractPriceSelectionStrategy` class: + +```ts title=src/strategies/price.ts +import { + AbstractPriceSelectionStrategy, + PriceSelectionContext, + PriceSelectionResult, +} from "@medusajs/medusa" +import { + TaxServiceRate, +} from "@medusajs/medusa/dist/types/tax-service" + +export default class MyStrategy extends + AbstractPriceSelectionStrategy { + + async calculateVariantPrice( + data: { + variantId: string; + taxRates: TaxServiceRate[]; + quantity?: number + }[], + context: PriceSelectionContext + ): Promise> { + throw new Error("Method not implemented.") + } +} +``` + +### Resolve Resources + +You can resolve resources like services or repositories using [dependency injection](../../../development/fundamentals/dependency-injection.md). + +For example: + +```ts title=src/strategies/price.ts +import { + AbstractPriceSelectionStrategy, + CustomerService, + PriceSelectionContext, + PriceSelectionResult, +} from "@medusajs/medusa" +import { + TaxServiceRate, +} from "@medusajs/medusa/dist/types/tax-service" + +type InjectedDependencies = { + customerService: CustomerService +} + +export default class MyStrategy extends + AbstractPriceSelectionStrategy { + + protected customerService_: CustomerService + + constructor(container: InjectedDependencies) { + super(container) + this.customerService_ = container.customerService + } + + // ... +} +``` + +--- + +## 2. Implement calculateVariantPrice + +In this method, you can implement your price selection strategy. + +### Parameters + +You can learn more about optional properties and the meaning behind every property [here](../price-selection-strategy.md#calculatevariantprice-method). + + + +### Returns + +>", + description: "A map, each key is an ID of a variant, and its value is an object holding the price selection result.", + optional: false, + children: [ + { + name: "PriceSelectionResult", + type: "PriceSelectionResult", + description: "The price selection result of a variant.", + optional: false, + children: [ + { + name: "originalPrice", + type: "number | null", + description: "The original price of the variant which depends on the selected region or currency code in the context object. If both region ID and currency code are available in the context object, the region has higher precedence.", + optional: false + }, + { + name: "originalPriceIncludesTax", + type: "boolean | null", + description: "Whether the original price includes taxes or not. This is only available for [Tax-Inclusive Pricing](../../taxes/inclusive-pricing.md).", + optional: true + }, + { + name: "calculatedPrice", + type: "number | null", + description: "The lowest price among the prices of the product variant retrieved using the context object.", + optional: false + }, + { + name: "calculatedPriceIncludesTax", + type: "boolean | null", + description: "Whether the calculated price includes taxes or not. This is only available for [Tax-Inclusive Pricing](../../taxes/inclusive-pricing.md).", + optional: true + }, + { + name: "calculatedPriceType", + type: "enum", + description: "Either `default` if the `calculatedPrice` is the original price, or the type of the price list applied, which can be `override` or `sale`.", + optional: true + }, + { + name: "prices", + type: "[MoneyAmount](../../../references/entities/classes/MoneyAmount.mdx)[]", + description: "The prices of the variant retrieved using the `context` object. It can include its original price and its price lists if there are any.", + optional: false + } + ], + } + ], + }, +]} /> + +--- + +## 3. Run Build Command + +In your terminal, run the build command to transpile the files in the `src` directory into the `dist` directory: + +```bash npm2yarn +npm run build +``` + +--- + +## Test it Out + +Run your backend to test it out: + +```bash npm2yarn +npx medusa develop +``` + +Then, try out your strategy using any of the [Products](https://docs.medusajs.com/api/store#products) or [Carts](https://docs.medusajs.com/api/store#carts) API Routes which include retrieving product variants and line items respectively. You should then see the prices in the response based on your implemented strategy. diff --git a/www/apps/docs/content/modules/price-lists/price-lists.md b/www/apps/docs/content/modules/price-lists/price-lists.md index fb6eccf564..b5a97c36f8 100644 --- a/www/apps/docs/content/modules/price-lists/price-lists.md +++ b/www/apps/docs/content/modules/price-lists/price-lists.md @@ -20,7 +20,7 @@ Price lists can be used for a variety of use cases including: ### Price List Entity Overview -A price list is stored in the database as a [PriceList](../../references/entities/classes/PriceList.md) entity. Some of its important attributes are: +A price list is stored in the database as a [PriceList](../../references/entities/classes/PriceList.mdx) entity. Some of its important attributes are: - `type`: The price list's type. Can be either a `sale` or an `override`. - `status`: The status of the price list. Can be `active` or `draft`. If a price list is a `draft`, its prices won't be applied even if its conditions are met. diff --git a/www/apps/docs/content/modules/price-lists/price-selection-strategy.md b/www/apps/docs/content/modules/price-lists/price-selection-strategy.md index a1671185bc..f5b110b816 100644 --- a/www/apps/docs/content/modules/price-lists/price-selection-strategy.md +++ b/www/apps/docs/content/modules/price-lists/price-selection-strategy.md @@ -8,7 +8,7 @@ In this document, you’ll learn what a price selection strategy is. :::note -If you’re interested to learn how to override the price selection strategy, check out [this documentation](./backend/override-price-selection-strategy.md) instead. +If you’re interested to learn how to override the price selection strategy, check out [this documentation](./backend/override-price-selection-strategy.mdx) instead. ::: @@ -69,4 +69,4 @@ The context that is passed to the `calculateVariantPrice` method is an object th ## See Also -- [Override the Price Selection Strategy](./backend/override-price-selection-strategy.md) \ No newline at end of file +- [Override the Price Selection Strategy](./backend/override-price-selection-strategy.mdx) \ No newline at end of file diff --git a/www/apps/docs/content/modules/products/storefront/show-products.mdx b/www/apps/docs/content/modules/products/storefront/show-products.mdx index bb989afc6e..5a2a95a9a2 100644 --- a/www/apps/docs/content/modules/products/storefront/show-products.mdx +++ b/www/apps/docs/content/modules/products/storefront/show-products.mdx @@ -613,8 +613,8 @@ fetch(`/store/products/search`, { "Content-Type": "application/json", }, body: JSON.stringify({ - q: "Shirt" - }) + q: "Shirt", + }), }) .then((response) => response.json()) .then(({ hits }) => { diff --git a/www/apps/docs/content/modules/regions-and-currencies/regions.md b/www/apps/docs/content/modules/regions-and-currencies/regions.md index b61eba5a84..5eab52741b 100644 --- a/www/apps/docs/content/modules/regions-and-currencies/regions.md +++ b/www/apps/docs/content/modules/regions-and-currencies/regions.md @@ -43,7 +43,7 @@ There is no limit on how many regions you can create, and regions can share simi ## Region Entity Overview -A region is stored in the database as a [Region](../../references/entities/classes/Region.md) entity. Some of its important attributes are: +A region is stored in the database as a [Region](../../references/entities/classes/Region.mdx) entity. Some of its important attributes are: - `name`: The name of the region. Customers will see this name on the storefront. - `tax_rate`: A number that indicates the tax rate. The tax rate is a percentage. diff --git a/www/apps/docs/content/modules/sales-channels/sales-channels.md b/www/apps/docs/content/modules/sales-channels/sales-channels.md index 77722ea0ca..9f3c20be02 100644 --- a/www/apps/docs/content/modules/sales-channels/sales-channels.md +++ b/www/apps/docs/content/modules/sales-channels/sales-channels.md @@ -24,7 +24,7 @@ The sales channel feature can be used in a variety of use cases including: ## SalesChannel Entity Overview -A sales channel is stored in the database as a [SalesChannel](../../references/entities/classes/SalesChannel.md) entity. Some of its important attributes are: +A sales channel is stored in the database as a [SalesChannel](../../references/entities/classes/SalesChannel.mdx) entity. Some of its important attributes are: - `name`: The name of the sales channel. - `is_disabled`: A boolean value indicating of the Sales Channel is disabled or not. @@ -37,13 +37,13 @@ A sales channel is stored in the database as a [SalesChannel](../../references/e A store has a default sales channel. When you first run your Medusa backend or seed your database, a default sales channel is created, if it doesn’t exist, and associated with the store. -The relation is implemented in the [Store](../../references/entities/classes/Store.md) entity. You can access the default sales channel of a store by expanding the `default_sales_channel` relation and using `store.default_sales_channel`. You can also access the ID of the default sales channel using `store.default_sales_channel_id`. +The relation is implemented in the [Store](../../references/entities/classes/Store.mdx) entity. You can access the default sales channel of a store by expanding the `default_sales_channel` relation and using `store.default_sales_channel`. You can also access the ID of the default sales channel using `store.default_sales_channel_id`. ### Product Products can be available in more than one sales channel. You can then filter products by a sales channel using the Storefront and Admin APIs. -The relation is implemented in the [Product](../../references/entities/classes/Product.md) entity. You can access the sales channels a product is available in by expanding the `sales_channels` relation and using `product.sales_channels`. +The relation is implemented in the [Product](../../references/entities/classes/Product.mdx) entity. You can access the sales channels a product is available in by expanding the `sales_channels` relation and using `product.sales_channels`. ### Cart @@ -51,13 +51,13 @@ When you create a cart, you can optionally specify the sales channel it belongs A cart can belong to only one sales channel. Only products that belong to the same sales channel as the cart can be added to it. -The relation is implemented in the [Cart](../../references/entities/classes/Cart.md) entity. You can access the sales channel a cart is associated with by expanding the `sales_channel` relation and using `cart.sales_channel`. You can also access the ID of the sales channel using `cart.sales_channel_id`. +The relation is implemented in the [Cart](../../references/entities/classes/Cart.mdx) entity. You can access the sales channel a cart is associated with by expanding the `sales_channel` relation and using `cart.sales_channel`. You can also access the ID of the sales channel using `cart.sales_channel_id`. ### Order Orders can optionally be associated with a sales channel. You can filter orders by a sales channel using the Storefront and Admin APIs. -The relation is implemented in the [Order](../../references/entities/classes/Order.md) entity. You can access the sales channel an order is associated with by expanding the `sales_channel` relation and using `order.sales_channel`. You can also access the ID of the sales channel using `order.sales_channel_id`. +The relation is implemented in the [Order](../../references/entities/classes/Order.mdx) entity. You can access the sales channel an order is associated with by expanding the `sales_channel` relation and using `order.sales_channel`. You can also access the ID of the sales channel using `order.sales_channel_id`. --- diff --git a/www/apps/docs/content/modules/taxes/backend/tax-calculation-strategy.md b/www/apps/docs/content/modules/taxes/backend/tax-calculation-strategy.md index a187f77fbe..1aa126e8a5 100644 --- a/www/apps/docs/content/modules/taxes/backend/tax-calculation-strategy.md +++ b/www/apps/docs/content/modules/taxes/backend/tax-calculation-strategy.md @@ -89,8 +89,8 @@ If automatic tax calculation is disabled, then the tax calculation strategy will The `calculate` method expects three parameters: -- `items`: the first parameter is an array of [line item](../../../references/entities/classes/LineItem.md) objects. -- `taxLines`: the second parameter is an array of either [shipping method tax line](../../../references/entities/classes/ShippingMethodTaxLine.md) or [line item tax line](../../../references/entities/classes/LineItemTaxLine.md) objects. +- `items`: the first parameter is an array of [line item](../../../references/entities/classes/LineItem.mdx) objects. +- `taxLines`: the second parameter is an array of either [shipping method tax line](../../../references/entities/classes/ShippingMethodTaxLine.mdx) or [line item tax line](../../../references/entities/classes/LineItemTaxLine.mdx) objects. - `calculationContext`: an object holding the context of the tax calculation. The object has the following properties: - `shipping_address`: an optional address object used for shipping. - `customer`: an optional customer object. diff --git a/www/apps/docs/content/plugins/file-service/s3.mdx b/www/apps/docs/content/plugins/file-service/s3.mdx index 298ff2333c..2ab5361d1e 100644 --- a/www/apps/docs/content/plugins/file-service/s3.mdx +++ b/www/apps/docs/content/plugins/file-service/s3.mdx @@ -121,7 +121,7 @@ const plugins = [ // optional download_file_duration: process.env.S3_DOWNLOAD_FILE_DURATION, - prefix: process.env.S3_PREFIX + prefix: process.env.S3_PREFIX, }, }, ] diff --git a/www/apps/docs/content/recipes/pos.mdx b/www/apps/docs/content/recipes/pos.mdx index 92cfe7f9cf..2fbae2a8fc 100644 --- a/www/apps/docs/content/recipes/pos.mdx +++ b/www/apps/docs/content/recipes/pos.mdx @@ -67,7 +67,7 @@ Medusa's modular architecture removes any restrictions you may have while making POS systems make the checkout process smoother by integrating a barcode scanner. Merchants can scan a product by its barcode to check its details or add it to the customer's purchase. -Medusa’s [Product Variant entity](../references/entities/classes/ProductVariant.md) includes the necessary attributes to implement this integration, mainly the `barcode` attribute. Other notable attributes include `ean`, `upc`, and `hs_code`, among others. +Medusa’s [Product Variant entity](../references/entities/classes/ProductVariant.mdx) includes the necessary attributes to implement this integration, mainly the `barcode` attribute. Other notable attributes include `ean`, `upc`, and `hs_code`, among others. To search through product variants by their barcode, you can create a custom API Route and call it within your POS. diff --git a/www/apps/docs/content/references/entities/_index.mdx b/www/apps/docs/content/references/entities/_index.mdx new file mode 100644 index 0000000000..4a90976cec --- /dev/null +++ b/www/apps/docs/content/references/entities/_index.mdx @@ -0,0 +1,119 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Entities Reference + +## Enumerations + +- [AllocationType](enums/AllocationType.mdx) +- [CartType](enums/CartType.mdx) +- [ClaimFulfillmentStatus](enums/ClaimFulfillmentStatus.mdx) +- [ClaimPaymentStatus](enums/ClaimPaymentStatus.mdx) +- [ClaimReason](enums/ClaimReason.mdx) +- [ClaimType](enums/ClaimType.mdx) +- [DiscountConditionOperator](enums/DiscountConditionOperator.mdx) +- [DiscountConditionType](enums/DiscountConditionType.mdx) +- [DiscountRuleType](enums/DiscountRuleType.mdx) +- [DraftOrderStatus](enums/DraftOrderStatus.mdx) +- [FulfillmentStatus](enums/FulfillmentStatus.mdx) +- [OrderEditItemChangeType](enums/OrderEditItemChangeType.mdx) +- [OrderEditStatus](enums/OrderEditStatus.mdx) +- [OrderStatus](enums/OrderStatus.mdx) +- [PaymentCollectionStatus](enums/PaymentCollectionStatus.mdx) +- [PaymentCollectionType](enums/PaymentCollectionType.mdx) +- [PaymentSessionStatus](enums/PaymentSessionStatus.mdx) +- [PaymentStatus](enums/PaymentStatus.mdx) +- [ProductStatus](enums/ProductStatus.mdx) +- [RefundReason](enums/RefundReason.mdx) +- [RequirementType](enums/RequirementType.mdx) +- [ReturnStatus](enums/ReturnStatus.mdx) +- [ShippingOptionPriceType](enums/ShippingOptionPriceType.mdx) +- [ShippingProfileType](enums/ShippingProfileType.mdx) +- [SwapFulfillmentStatus](enums/SwapFulfillmentStatus.mdx) +- [SwapPaymentStatus](enums/SwapPaymentStatus.mdx) +- [UserRoles](enums/UserRoles.mdx) + +## Classes + +- [Address](classes/Address.mdx) +- [AnalyticsConfig](classes/AnalyticsConfig.mdx) +- [BatchJob](classes/BatchJob.mdx) +- [Cart](classes/Cart.mdx) +- [ClaimImage](classes/ClaimImage.mdx) +- [ClaimItem](classes/ClaimItem.mdx) +- [ClaimOrder](classes/ClaimOrder.mdx) +- [ClaimTag](classes/ClaimTag.mdx) +- [Country](classes/Country.mdx) +- [Currency](classes/Currency.mdx) +- [CustomShippingOption](classes/CustomShippingOption.mdx) +- [Customer](classes/Customer.mdx) +- [CustomerGroup](classes/CustomerGroup.mdx) +- [Discount](classes/Discount.mdx) +- [DiscountCondition](classes/DiscountCondition.mdx) +- [DiscountConditionCustomerGroup](classes/DiscountConditionCustomerGroup.mdx) +- [DiscountConditionProduct](classes/DiscountConditionProduct.mdx) +- [DiscountConditionProductCollection](classes/DiscountConditionProductCollection.mdx) +- [DiscountConditionProductTag](classes/DiscountConditionProductTag.mdx) +- [DiscountConditionProductType](classes/DiscountConditionProductType.mdx) +- [DiscountRule](classes/DiscountRule.mdx) +- [DraftOrder](classes/DraftOrder.mdx) +- [Fulfillment](classes/Fulfillment.mdx) +- [FulfillmentItem](classes/FulfillmentItem.mdx) +- [FulfillmentProvider](classes/FulfillmentProvider.mdx) +- [GiftCard](classes/GiftCard.mdx) +- [GiftCardTransaction](classes/GiftCardTransaction.mdx) +- [IdempotencyKey](classes/IdempotencyKey.mdx) +- [Image](classes/Image.mdx) +- [Invite](classes/Invite.mdx) +- [LineItem](classes/LineItem.mdx) +- [LineItemAdjustment](classes/LineItemAdjustment.mdx) +- [LineItemTaxLine](classes/LineItemTaxLine.mdx) +- [MoneyAmount](classes/MoneyAmount.mdx) +- [Note](classes/Note.mdx) +- [Notification](classes/Notification.mdx) +- [Oauth](classes/Oauth.mdx) +- [Order](classes/Order.mdx) +- [OrderEdit](classes/OrderEdit.mdx) +- [OrderItemChange](classes/OrderItemChange.mdx) +- [Payment](classes/Payment.mdx) +- [PaymentCollection](classes/PaymentCollection.mdx) +- [PaymentProvider](classes/PaymentProvider.mdx) +- [PaymentSession](classes/PaymentSession.mdx) +- [PriceList](classes/PriceList.mdx) +- [Product](classes/Product.mdx) +- [ProductCategory](classes/ProductCategory.mdx) +- [ProductCollection](classes/ProductCollection.mdx) +- [ProductOption](classes/ProductOption.mdx) +- [ProductOptionValue](classes/ProductOptionValue.mdx) +- [ProductTag](classes/ProductTag.mdx) +- [ProductTaxRate](classes/ProductTaxRate.mdx) +- [ProductType](classes/ProductType.mdx) +- [ProductTypeTaxRate](classes/ProductTypeTaxRate.mdx) +- [ProductVariant](classes/ProductVariant.mdx) +- [ProductVariantInventoryItem](classes/ProductVariantInventoryItem.mdx) +- [ProductVariantMoneyAmount](classes/ProductVariantMoneyAmount.mdx) +- [PublishableApiKey](classes/PublishableApiKey.mdx) +- [PublishableApiKeySalesChannel](classes/PublishableApiKeySalesChannel.mdx) +- [Refund](classes/Refund.mdx) +- [Region](classes/Region.mdx) +- [Return](classes/Return.mdx) +- [ReturnItem](classes/ReturnItem.mdx) +- [ReturnReason](classes/ReturnReason.mdx) +- [SalesChannel](classes/SalesChannel.mdx) +- [SalesChannelLocation](classes/SalesChannelLocation.mdx) +- [ShippingMethod](classes/ShippingMethod.mdx) +- [ShippingMethodTaxLine](classes/ShippingMethodTaxLine.mdx) +- [ShippingOption](classes/ShippingOption.mdx) +- [ShippingOptionRequirement](classes/ShippingOptionRequirement.mdx) +- [ShippingProfile](classes/ShippingProfile.mdx) +- [ShippingTaxRate](classes/ShippingTaxRate.mdx) +- [StagedJob](classes/StagedJob.mdx) +- [Store](classes/Store.mdx) +- [Swap](classes/Swap.mdx) +- [TaxProvider](classes/TaxProvider.mdx) +- [TaxRate](classes/TaxRate.mdx) +- [TrackingLink](classes/TrackingLink.mdx) +- [User](classes/User.mdx) diff --git a/www/apps/docs/content/references/entities/classes/Address.md b/www/apps/docs/content/references/entities/classes/Address.md deleted file mode 100644 index ff70c0fb8c..0000000000 --- a/www/apps/docs/content/references/entities/classes/Address.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Address - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`Address`** - -## Constructors - -### constructor - -• **new Address**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### address\_1 - -• **address\_1**: ``null`` \| `string` - -#### Defined in - -[models/address.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L36) - -___ - -### address\_2 - -• **address\_2**: ``null`` \| `string` - -#### Defined in - -[models/address.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L39) - -___ - -### city - -• **city**: ``null`` \| `string` - -#### Defined in - -[models/address.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L42) - -___ - -### company - -• **company**: ``null`` \| `string` - -#### Defined in - -[models/address.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L27) - -___ - -### country - -• **country**: ``null`` \| [`Country`](Country.md) - -#### Defined in - -[models/address.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L49) - -___ - -### country\_code - -• **country\_code**: ``null`` \| `string` - -#### Defined in - -[models/address.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L45) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### customer - -• **customer**: ``null`` \| [`Customer`](Customer.md) - -#### Defined in - -[models/address.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L24) - -___ - -### customer\_id - -• **customer\_id**: ``null`` \| `string` - -#### Defined in - -[models/address.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L20) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### first\_name - -• **first\_name**: ``null`` \| `string` - -#### Defined in - -[models/address.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L30) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### last\_name - -• **last\_name**: ``null`` \| `string` - -#### Defined in - -[models/address.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L33) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/address.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L61) - -___ - -### phone - -• **phone**: ``null`` \| `string` - -#### Defined in - -[models/address.ts:58](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L58) - -___ - -### postal\_code - -• **postal\_code**: ``null`` \| `string` - -#### Defined in - -[models/address.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L55) - -___ - -### province - -• **province**: ``null`` \| `string` - -#### Defined in - -[models/address.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L52) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/address.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/address.ts#L64) diff --git a/www/apps/docs/content/references/entities/classes/Address.mdx b/www/apps/docs/content/references/entities/classes/Address.mdx new file mode 100644 index 0000000000..c8b56a2fef --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Address.mdx @@ -0,0 +1,156 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Address + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/AnalyticsConfig.md b/www/apps/docs/content/references/entities/classes/AnalyticsConfig.md deleted file mode 100644 index 267f2e37ba..0000000000 --- a/www/apps/docs/content/references/entities/classes/AnalyticsConfig.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: AnalyticsConfig - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`AnalyticsConfig`** - -## Constructors - -### constructor - -• **new AnalyticsConfig**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### anonymize - -• **anonymize**: `boolean` - -#### Defined in - -[models/analytics-config.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/analytics-config.ts#L17) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### opt\_out - -• **opt\_out**: `boolean` - -#### Defined in - -[models/analytics-config.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/analytics-config.ts#L14) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### user\_id - -• **user\_id**: `string` - -#### Defined in - -[models/analytics-config.ts:11](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/analytics-config.ts#L11) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/analytics-config.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/analytics-config.ts#L20) diff --git a/www/apps/docs/content/references/entities/classes/AnalyticsConfig.mdx b/www/apps/docs/content/references/entities/classes/AnalyticsConfig.mdx new file mode 100644 index 0000000000..a39497c6a4 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/AnalyticsConfig.mdx @@ -0,0 +1,68 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AnalyticsConfig + +## Properties + + diff --git a/www/apps/docs/content/references/entities/classes/BatchJob.md b/www/apps/docs/content/references/entities/classes/BatchJob.md deleted file mode 100644 index 8eb38d4fff..0000000000 --- a/www/apps/docs/content/references/entities/classes/BatchJob.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: BatchJob - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`BatchJob`** - -## Constructors - -### constructor - -• **new BatchJob**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### canceled\_at - -• `Optional` **canceled\_at**: `Date` - -#### Defined in - -[models/batch-job.ts:62](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L62) - -___ - -### completed\_at - -• `Optional` **completed\_at**: `Date` - -#### Defined in - -[models/batch-job.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L59) - -___ - -### confirmed\_at - -• `Optional` **confirmed\_at**: `Date` - -#### Defined in - -[models/batch-job.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L56) - -___ - -### context - -• **context**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/batch-job.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L33) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### created\_by - -• **created\_by**: ``null`` \| `string` - -#### Defined in - -[models/batch-job.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L26) - -___ - -### created\_by\_user - -• **created\_by\_user**: [`User`](User.md) - -#### Defined in - -[models/batch-job.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L30) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### dry\_run - -• **dry\_run**: `boolean` = `false` - -#### Defined in - -[models/batch-job.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L47) - -___ - -### failed\_at - -• `Optional` **failed\_at**: `Date` - -#### Defined in - -[models/batch-job.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L65) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### pre\_processed\_at - -• `Optional` **pre\_processed\_at**: `Date` - -#### Defined in - -[models/batch-job.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L50) - -___ - -### processing\_at - -• `Optional` **processing\_at**: `Date` - -#### Defined in - -[models/batch-job.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L53) - -___ - -### result - -• **result**: { `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: (`string` \| `BatchJobResultError`)[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: `BatchJobResultStatDescriptor`[] } & `Record`<`string`, `unknown`\> - -#### Defined in - -[models/batch-job.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L36) - -___ - -### status - -• **status**: `BatchJobStatus` - -#### Defined in - -[models/batch-job.ts:67](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L67) - -___ - -### type - -• **type**: `string` - -#### Defined in - -[models/batch-job.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L23) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/batch-job.ts:95](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L95) - -___ - -### loadStatus - -▸ **loadStatus**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/batch-job.ts:70](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L70) - -___ - -### toJSON - -▸ **toJSON**(): [`BatchJob`](BatchJob.md) - -#### Returns - -[`BatchJob`](BatchJob.md) - -#### Defined in - -[models/batch-job.ts:99](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/batch-job.ts#L99) diff --git a/www/apps/docs/content/references/entities/classes/BatchJob.mdx b/www/apps/docs/content/references/entities/classes/BatchJob.mdx new file mode 100644 index 0000000000..69d1527f28 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/BatchJob.mdx @@ -0,0 +1,278 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# BatchJob + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by_user", + "type": "[`User`](User.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`User`](User.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "api_token", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "role", + "type": "[`UserRoles`](../enums/UserRoles.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ADMIN", + "type": "``\"admin\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEVELOPER", + "type": "``\"developer\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "MEMBER", + "type": "``\"member\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "dry_run", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "`false`", + "children": [] + }, + { + "name": "failed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "pre_processed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "processing_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "result", + "type": "{ `advancement_count?`: `number` ; `count?`: `number` ; `errors?`: (`string` \\| `BatchJobResultError`)[] ; `file_key?`: `string` ; `file_size?`: `number` ; `progress?`: `number` ; `stat_descriptors?`: `BatchJobResultStatDescriptor`[] } & Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`BatchJobStatus`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Cart.md b/www/apps/docs/content/references/entities/classes/Cart.md deleted file mode 100644 index 49d4940db8..0000000000 --- a/www/apps/docs/content/references/entities/classes/Cart.md +++ /dev/null @@ -1,485 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Cart - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`Cart`** - -## Constructors - -### constructor - -• **new Cart**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### billing\_address - -• **billing\_address**: [`Address`](Address.md) - -#### Defined in - -[models/cart.ts:288](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L288) - -___ - -### billing\_address\_id - -• **billing\_address\_id**: `string` - -#### Defined in - -[models/cart.ts:282](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L282) - -___ - -### completed\_at - -• **completed\_at**: `Date` - -#### Defined in - -[models/cart.ts:373](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L373) - -___ - -### context - -• **context**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/cart.ts:382](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L382) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### customer - -• **customer**: [`Customer`](Customer.md) - -#### Defined in - -[models/cart.ts:347](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L347) - -___ - -### customer\_id - -• **customer\_id**: `string` - -#### Defined in - -[models/cart.ts:343](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L343) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### discount\_total - -• `Optional` **discount\_total**: `number` - -#### Defined in - -[models/cart.ts:397](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L397) - -___ - -### discounts - -• **discounts**: [`Discount`](Discount.md)[] - -#### Defined in - -[models/cart.ts:325](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L325) - -___ - -### email - -• **email**: `string` - -#### Defined in - -[models/cart.ts:278](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L278) - -___ - -### gift\_card\_tax\_total - -• `Optional` **gift\_card\_tax\_total**: `number` - -#### Defined in - -[models/cart.ts:407](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L407) - -___ - -### gift\_card\_total - -• `Optional` **gift\_card\_total**: `number` - -#### Defined in - -[models/cart.ts:406](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L406) - -___ - -### gift\_cards - -• **gift\_cards**: [`GiftCard`](GiftCard.md)[] - -#### Defined in - -[models/cart.ts:339](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L339) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -[models/cart.ts:379](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L379) - -___ - -### item\_tax\_total - -• `Optional` **item\_tax\_total**: ``null`` \| `number` - -#### Defined in - -[models/cart.ts:399](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L399) - -___ - -### items - -• **items**: [`LineItem`](LineItem.md)[] - -#### Defined in - -[models/cart.ts:303](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L303) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/cart.ts:385](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L385) - -___ - -### object - -• `Readonly` **object**: ``"cart"`` - -#### Defined in - -[models/cart.ts:275](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L275) - -___ - -### payment - -• **payment**: [`Payment`](Payment.md) - -#### Defined in - -[models/cart.ts:362](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L362) - -___ - -### payment\_authorized\_at - -• **payment\_authorized\_at**: `Date` - -#### Defined in - -[models/cart.ts:376](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L376) - -___ - -### payment\_id - -• **payment\_id**: `string` - -#### Defined in - -[models/cart.ts:358](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L358) - -___ - -### payment\_session - -• **payment\_session**: ``null`` \| [`PaymentSession`](PaymentSession.md) - -#### Defined in - -[models/cart.ts:349](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L349) - -___ - -### payment\_sessions - -• **payment\_sessions**: [`PaymentSession`](PaymentSession.md)[] - -#### Defined in - -[models/cart.ts:354](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L354) - -___ - -### raw\_discount\_total - -• `Optional` **raw\_discount\_total**: `number` - -#### Defined in - -[models/cart.ts:398](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L398) - -___ - -### refundable\_amount - -• `Optional` **refundable\_amount**: `number` - -#### Defined in - -[models/cart.ts:405](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L405) - -___ - -### refunded\_total - -• `Optional` **refunded\_total**: `number` - -#### Defined in - -[models/cart.ts:402](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L402) - -___ - -### region - -• **region**: [`Region`](Region.md) - -#### Defined in - -[models/cart.ts:311](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L311) - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -[models/cart.ts:307](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L307) - -___ - -### sales\_channel - -• **sales\_channel**: [`SalesChannel`](SalesChannel.md) - -#### Defined in - -[models/cart.ts:394](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L394) - -___ - -### sales\_channel\_id - -• **sales\_channel\_id**: ``null`` \| `string` - -#### Defined in - -[models/cart.ts:388](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L388) - -___ - -### shipping\_address - -• **shipping\_address**: ``null`` \| [`Address`](Address.md) - -#### Defined in - -[models/cart.ts:298](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L298) - -___ - -### shipping\_address\_id - -• **shipping\_address\_id**: `string` - -#### Defined in - -[models/cart.ts:292](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L292) - -___ - -### shipping\_methods - -• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[] - -#### Defined in - -[models/cart.ts:367](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L367) - -___ - -### shipping\_tax\_total - -• `Optional` **shipping\_tax\_total**: ``null`` \| `number` - -#### Defined in - -[models/cart.ts:400](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L400) - -___ - -### shipping\_total - -• `Optional` **shipping\_total**: `number` - -#### Defined in - -[models/cart.ts:396](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L396) - -___ - -### subtotal - -• `Optional` **subtotal**: `number` - -#### Defined in - -[models/cart.ts:404](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L404) - -___ - -### tax\_total - -• `Optional` **tax\_total**: ``null`` \| `number` - -#### Defined in - -[models/cart.ts:401](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L401) - -___ - -### total - -• `Optional` **total**: `number` - -#### Defined in - -[models/cart.ts:403](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L403) - -___ - -### type - -• **type**: [`CartType`](../enums/CartType.md) - -#### Defined in - -[models/cart.ts:370](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L370) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### afterLoad - -▸ `Private` **afterLoad**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/cart.ts:410](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L410) - -___ - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/cart.ts:417](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L417) diff --git a/www/apps/docs/content/references/entities/classes/Cart.mdx b/www/apps/docs/content/references/entities/classes/Cart.mdx new file mode 100644 index 0000000000..a4a918386c --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Cart.mdx @@ -0,0 +1,9057 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Cart + +## Properties + + [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allocation", + "type": "[`AllocationType`](../enums/AllocationType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "conditions", + "type": "[`DiscountCondition`](DiscountCondition.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemAdjustment`](LineItemAdjustment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemTaxLine`](LineItemTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_initiated", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_selected", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_2", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_3", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "num_code", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentProvider`](PaymentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannelLocation`](SalesChannelLocation.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CLAIM", + "type": "``\"claim\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEFAULT", + "type": "``\"default\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DRAFT_ORDER", + "type": "``\"draft_order\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PAYMENT_LINK", + "type": "``\"payment_link\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SWAP", + "type": "``\"swap\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ClaimImage.md b/www/apps/docs/content/references/entities/classes/ClaimImage.md deleted file mode 100644 index bb2d490c60..0000000000 --- a/www/apps/docs/content/references/entities/classes/ClaimImage.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ClaimImage - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ClaimImage`** - -## Constructors - -### constructor - -• **new ClaimImage**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### claim\_item - -• **claim\_item**: [`ClaimItem`](ClaimItem.md) - -#### Defined in - -[models/claim-image.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-image.ts#L23) - -___ - -### claim\_item\_id - -• **claim\_item\_id**: `string` - -#### Defined in - -[models/claim-image.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-image.ts#L19) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/claim-image.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-image.ts#L29) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### url - -• **url**: `string` - -#### Defined in - -[models/claim-image.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-image.ts#L26) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/claim-image.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-image.ts#L32) diff --git a/www/apps/docs/content/references/entities/classes/ClaimImage.mdx b/www/apps/docs/content/references/entities/classes/ClaimImage.mdx new file mode 100644 index 0000000000..cd2261f06b --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ClaimImage.mdx @@ -0,0 +1,1203 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimImage + +## Properties + + [`ClaimItem`](ClaimItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`ClaimImage`](ClaimImage.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimImage`](ClaimImage.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_item", + "type": "[`ClaimItem`](ClaimItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ClaimReason`](../enums/ClaimReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "MISSING_ITEM", + "type": "``\"missing_item\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "OTHER", + "type": "``\"other\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCTION_FAILURE", + "type": "``\"production_failure\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "WRONG_ITEM", + "type": "``\"wrong_item\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tags", + "type": "[`ClaimTag`](ClaimTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimTag`](ClaimTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ClaimItem.md b/www/apps/docs/content/references/entities/classes/ClaimItem.md deleted file mode 100644 index db68e551ef..0000000000 --- a/www/apps/docs/content/references/entities/classes/ClaimItem.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ClaimItem - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ClaimItem`** - -## Constructors - -### constructor - -• **new ClaimItem**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### claim\_order - -• **claim\_order**: [`ClaimOrder`](ClaimOrder.md) - -#### Defined in - -[models/claim-item.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L42) - -___ - -### claim\_order\_id - -• **claim\_order\_id**: `string` - -#### Defined in - -[models/claim-item.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L38) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### images - -• **images**: [`ClaimImage`](ClaimImage.md)[] - -#### Defined in - -[models/claim-item.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L34) - -___ - -### item - -• **item**: [`LineItem`](LineItem.md) - -#### Defined in - -[models/claim-item.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L50) - -___ - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -[models/claim-item.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L46) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/claim-item.ts:84](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L84) - -___ - -### note - -• **note**: `string` - -#### Defined in - -[models/claim-item.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L64) - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -[models/claim-item.ts:67](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L67) - -___ - -### reason - -• **reason**: [`ClaimReason`](../enums/ClaimReason.md) - -#### Defined in - -[models/claim-item.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L61) - -___ - -### tags - -• **tags**: [`ClaimTag`](ClaimTag.md)[] - -#### Defined in - -[models/claim-item.ts:81](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L81) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### variant - -• **variant**: [`ProductVariant`](ProductVariant.md) - -#### Defined in - -[models/claim-item.ts:58](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L58) - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -[models/claim-item.ts:54](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L54) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/claim-item.ts:87](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L87) diff --git a/www/apps/docs/content/references/entities/classes/ClaimItem.mdx b/www/apps/docs/content/references/entities/classes/ClaimItem.mdx new file mode 100644 index 0000000000..dcfdc50f25 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ClaimItem.mdx @@ -0,0 +1,5360 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimItem + +## Properties + + [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimItem`](ClaimItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`ClaimImage`](ClaimImage.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ClaimReason`](../enums/ClaimReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ClaimTag`](ClaimTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "NA", + "type": "``\"na\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_REFUNDED", + "type": "``\"not_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "REFUND", + "type": "``\"refund\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REPLACE", + "type": "``\"replace\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`ClaimImage`](ClaimImage.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimImage`](ClaimImage.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_item", + "type": "[`ClaimItem`](ClaimItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimItem`](ClaimItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`ClaimImage`](ClaimImage.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ClaimReason`](../enums/ClaimReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ClaimTag`](ClaimTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemAdjustment`](LineItemAdjustment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemTaxLine`](LineItemTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ClaimReason`](../enums/ClaimReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "MISSING_ITEM", + "type": "``\"missing_item\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "OTHER", + "type": "``\"other\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCTION_FAILURE", + "type": "``\"production_failure\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "WRONG_ITEM", + "type": "``\"wrong_item\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tags", + "type": "[`ClaimTag`](ClaimTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimTag`](ClaimTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "required_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOptionValue`](ProductOptionValue.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option", + "type": "[`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`MoneyAmount`](MoneyAmount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list", + "type": "``null`` \\| [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ClaimOrder.md b/www/apps/docs/content/references/entities/classes/ClaimOrder.md deleted file mode 100644 index 4a99420049..0000000000 --- a/www/apps/docs/content/references/entities/classes/ClaimOrder.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ClaimOrder - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ClaimOrder`** - -## Constructors - -### constructor - -• **new ClaimOrder**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### additional\_items - -• **additional\_items**: [`LineItem`](LineItem.md)[] - -#### Defined in - -[models/claim-order.ts:69](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L69) - -___ - -### canceled\_at - -• **canceled\_at**: `Date` - -#### Defined in - -[models/claim-order.ts:107](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L107) - -___ - -### claim\_items - -• **claim\_items**: [`ClaimItem`](ClaimItem.md)[] - -#### Defined in - -[models/claim-order.ts:66](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L66) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Overrides - -SoftDeletableEntity.created\_at - -#### Defined in - -[models/claim-order.ts:110](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L110) - -___ - -### deleted\_at - -• **deleted\_at**: `Date` - -#### Overrides - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[models/claim-order.ts:116](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L116) - -___ - -### fulfillment\_status - -• **fulfillment\_status**: [`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.md) - -#### Defined in - -[models/claim-order.ts:63](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L63) - -___ - -### fulfillments - -• **fulfillments**: [`Fulfillment`](Fulfillment.md)[] - -#### Defined in - -[models/claim-order.ts:101](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L101) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -[models/claim-order.ts:125](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L125) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/claim-order.ts:122](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L122) - -___ - -### no\_notification - -• **no\_notification**: `boolean` - -#### Defined in - -[models/claim-order.ts:119](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L119) - -___ - -### order - -• **order**: [`Order`](Order.md) - -#### Defined in - -[models/claim-order.ts:80](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L80) - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -[models/claim-order.ts:76](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L76) - -___ - -### payment\_status - -• **payment\_status**: [`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.md) - -#### Defined in - -[models/claim-order.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L56) - -___ - -### refund\_amount - -• **refund\_amount**: `number` - -#### Defined in - -[models/claim-order.ts:104](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L104) - -___ - -### return\_order - -• **return\_order**: [`Return`](Return.md) - -#### Defined in - -[models/claim-order.ts:83](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L83) - -___ - -### shipping\_address - -• **shipping\_address**: [`Address`](Address.md) - -#### Defined in - -[models/claim-order.ts:91](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L91) - -___ - -### shipping\_address\_id - -• **shipping\_address\_id**: `string` - -#### Defined in - -[models/claim-order.ts:87](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L87) - -___ - -### shipping\_methods - -• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[] - -#### Defined in - -[models/claim-order.ts:96](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L96) - -___ - -### type - -• **type**: [`ClaimType`](../enums/ClaimType.md) - -#### Defined in - -[models/claim-order.ts:72](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L72) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Overrides - -SoftDeletableEntity.updated\_at - -#### Defined in - -[models/claim-order.ts:113](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L113) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/claim-order.ts:128](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L128) diff --git a/www/apps/docs/content/references/entities/classes/ClaimOrder.mdx b/www/apps/docs/content/references/entities/classes/ClaimOrder.mdx new file mode 100644 index 0000000000..e52a206e9c --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ClaimOrder.mdx @@ -0,0 +1,12518 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimOrder + +## Properties + + [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemAdjustment`](LineItemAdjustment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemTaxLine`](LineItemTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimItem`](ClaimItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`ClaimImage`](ClaimImage.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimImage`](ClaimImage.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_item", + "type": "[`ClaimItem`](ClaimItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ClaimReason`](../enums/ClaimReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "MISSING_ITEM", + "type": "``\"missing_item\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "OTHER", + "type": "``\"other\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCTION_FAILURE", + "type": "``\"production_failure\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "WRONG_ITEM", + "type": "``\"wrong_item\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tags", + "type": "[`ClaimTag`](ClaimTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimTag`](ClaimTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentItem`](FulfillmentItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment", + "type": "[`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TrackingLink`](TrackingLink.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment", + "type": "[`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_number", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card", + "type": "[`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Refund`](Refund.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ARCHIVED", + "type": "``\"archived\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "NA", + "type": "``\"na\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_REFUNDED", + "type": "``\"not_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ReturnItem`](ReturnItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_requested", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RECEIVED", + "type": "``\"received\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUESTED", + "type": "``\"requested\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "REFUND", + "type": "``\"refund\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REPLACE", + "type": "``\"replace\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ClaimTag.md b/www/apps/docs/content/references/entities/classes/ClaimTag.md deleted file mode 100644 index fcaa51af40..0000000000 --- a/www/apps/docs/content/references/entities/classes/ClaimTag.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ClaimTag - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ClaimTag`** - -## Constructors - -### constructor - -• **new ClaimTag**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/claim-tag.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-tag.ts#L14) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### value - -• **value**: `string` - -#### Defined in - -[models/claim-tag.ts:11](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-tag.ts#L11) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/claim-tag.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-tag.ts#L17) diff --git a/www/apps/docs/content/references/entities/classes/ClaimTag.mdx b/www/apps/docs/content/references/entities/classes/ClaimTag.mdx new file mode 100644 index 0000000000..64d840111a --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ClaimTag.mdx @@ -0,0 +1,60 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimTag + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Country.md b/www/apps/docs/content/references/entities/classes/Country.md deleted file mode 100644 index fefc12818d..0000000000 --- a/www/apps/docs/content/references/entities/classes/Country.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Country - -## Constructors - -### constructor - -• **new Country**() - -## Properties - -### display\_name - -• **display\_name**: `string` - -#### Defined in - -[models/country.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L31) - -___ - -### id - -• **id**: `number` - -#### Defined in - -[models/country.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L15) - -___ - -### iso\_2 - -• **iso\_2**: `string` - -#### Defined in - -[models/country.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L19) - -___ - -### iso\_3 - -• **iso\_3**: `string` - -#### Defined in - -[models/country.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L22) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[models/country.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L28) - -___ - -### num\_code - -• **num\_code**: `number` - -#### Defined in - -[models/country.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L25) - -___ - -### region - -• **region**: [`Region`](Region.md) - -#### Defined in - -[models/country.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L39) - -___ - -### region\_id - -• **region\_id**: ``null`` \| `string` - -#### Defined in - -[models/country.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/country.ts#L35) diff --git a/www/apps/docs/content/references/entities/classes/Country.mdx b/www/apps/docs/content/references/entities/classes/Country.mdx new file mode 100644 index 0000000000..cdce79b55d --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Country.mdx @@ -0,0 +1,442 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Country + +## Properties + + [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_2", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_3", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "num_code", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentProvider`](PaymentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Currency.md b/www/apps/docs/content/references/entities/classes/Currency.md deleted file mode 100644 index 21ff2f7b9b..0000000000 --- a/www/apps/docs/content/references/entities/classes/Currency.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Currency - -## Constructors - -### constructor - -• **new Currency**() - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -[models/currency.ts:8](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/currency.ts#L8) - -___ - -### includes\_tax - -• `Optional` **includes\_tax**: `boolean` - -#### Defined in - -[models/currency.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/currency.ts#L20) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[models/currency.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/currency.ts#L17) - -___ - -### symbol - -• **symbol**: `string` - -#### Defined in - -[models/currency.ts:11](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/currency.ts#L11) - -___ - -### symbol\_native - -• **symbol\_native**: `string` - -#### Defined in - -[models/currency.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/currency.ts#L14) diff --git a/www/apps/docs/content/references/entities/classes/Currency.mdx b/www/apps/docs/content/references/entities/classes/Currency.mdx new file mode 100644 index 0000000000..a4c9fbbaaf --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Currency.mdx @@ -0,0 +1,52 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Currency + +## Properties + + diff --git a/www/apps/docs/content/references/entities/classes/CustomShippingOption.md b/www/apps/docs/content/references/entities/classes/CustomShippingOption.md deleted file mode 100644 index 23ceebcd31..0000000000 --- a/www/apps/docs/content/references/entities/classes/CustomShippingOption.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: CustomShippingOption - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`CustomShippingOption`** - -## Constructors - -### constructor - -• **new CustomShippingOption**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### cart - -• **cart**: [`Cart`](Cart.md) - -#### Defined in - -[models/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/custom-shipping-option.ts#L37) - -___ - -### cart\_id - -• **cart\_id**: `string` - -#### Defined in - -[models/custom-shipping-option.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/custom-shipping-option.ts#L33) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/custom-shipping-option.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/custom-shipping-option.ts#L40) - -___ - -### price - -• **price**: `number` - -#### Defined in - -[models/custom-shipping-option.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/custom-shipping-option.ts#L21) - -___ - -### shipping\_option - -• **shipping\_option**: [`ShippingOption`](ShippingOption.md) - -#### Defined in - -[models/custom-shipping-option.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/custom-shipping-option.ts#L29) - -___ - -### shipping\_option\_id - -• **shipping\_option\_id**: `string` - -#### Defined in - -[models/custom-shipping-option.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/custom-shipping-option.ts#L25) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/custom-shipping-option.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/custom-shipping-option.ts#L43) diff --git a/www/apps/docs/content/references/entities/classes/CustomShippingOption.mdx b/www/apps/docs/content/references/entities/classes/CustomShippingOption.mdx new file mode 100644 index 0000000000..161a0d6f28 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/CustomShippingOption.mdx @@ -0,0 +1,2734 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CustomShippingOption + +## Properties + + [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_initiated", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_selected", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CLAIM", + "type": "``\"claim\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEFAULT", + "type": "``\"default\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DRAFT_ORDER", + "type": "``\"draft_order\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PAYMENT_LINK", + "type": "``\"payment_link\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SWAP", + "type": "``\"swap\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CALCULATED", + "type": "``\"calculated\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FLAT_RATE", + "type": "``\"flat_rate\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`RequirementType`](../enums/RequirementType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Customer.md b/www/apps/docs/content/references/entities/classes/Customer.md deleted file mode 100644 index e1b0e30c59..0000000000 --- a/www/apps/docs/content/references/entities/classes/Customer.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Customer - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`Customer`** - -## Constructors - -### constructor - -• **new Customer**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### billing\_address - -• **billing\_address**: [`Address`](Address.md) - -#### Defined in - -[models/customer.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L40) - -___ - -### billing\_address\_id - -• **billing\_address\_id**: ``null`` \| `string` - -#### Defined in - -[models/customer.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L36) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### email - -• **email**: `string` - -#### Defined in - -[models/customer.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L26) - -___ - -### first\_name - -• **first\_name**: `string` - -#### Defined in - -[models/customer.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L29) - -___ - -### groups - -• **groups**: [`CustomerGroup`](CustomerGroup.md)[] - -#### Defined in - -[models/customer.ts:71](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L71) - -___ - -### has\_account - -• **has\_account**: `boolean` - -#### Defined in - -[models/customer.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L52) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### last\_name - -• **last\_name**: `string` - -#### Defined in - -[models/customer.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L32) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/customer.ts:74](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L74) - -___ - -### orders - -• **orders**: [`Order`](Order.md)[] - -#### Defined in - -[models/customer.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L55) - -___ - -### password\_hash - -• **password\_hash**: `string` - -#### Defined in - -[models/customer.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L46) - -___ - -### phone - -• **phone**: `string` - -#### Defined in - -[models/customer.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L49) - -___ - -### shipping\_addresses - -• **shipping\_addresses**: [`Address`](Address.md)[] - -#### Defined in - -[models/customer.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L43) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/customer.ts:77](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer.ts#L77) diff --git a/www/apps/docs/content/references/entities/classes/Customer.mdx b/www/apps/docs/content/references/entities/classes/Customer.mdx new file mode 100644 index 0000000000..32f1bad98f --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Customer.mdx @@ -0,0 +1,5322 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Customer + +## Properties + + [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`PriceListStatus`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "`PriceListType`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card", + "type": "[`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Refund`](Refund.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ARCHIVED", + "type": "``\"archived\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/CustomerGroup.md b/www/apps/docs/content/references/entities/classes/CustomerGroup.md deleted file mode 100644 index f85f632a39..0000000000 --- a/www/apps/docs/content/references/entities/classes/CustomerGroup.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: CustomerGroup - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`CustomerGroup`** - -## Constructors - -### constructor - -• **new CustomerGroup**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### customers - -• **customers**: [`Customer`](Customer.md)[] - -#### Defined in - -[models/customer-group.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer-group.ts#L18) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/customer-group.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer-group.ts#L26) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[models/customer-group.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer-group.ts#L13) - -___ - -### price\_lists - -• **price\_lists**: [`PriceList`](PriceList.md)[] - -#### Defined in - -[models/customer-group.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer-group.ts#L23) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/customer-group.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/customer-group.ts#L29) diff --git a/www/apps/docs/content/references/entities/classes/CustomerGroup.mdx b/www/apps/docs/content/references/entities/classes/CustomerGroup.mdx new file mode 100644 index 0000000000..9c8f039815 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/CustomerGroup.mdx @@ -0,0 +1,1460 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CustomerGroup + +## Properties + + [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`MoneyAmount`](MoneyAmount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list", + "type": "``null`` \\| [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "starts_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`PriceListStatus`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "`PriceListType`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Discount.md b/www/apps/docs/content/references/entities/classes/Discount.md deleted file mode 100644 index 9d9dc94b17..0000000000 --- a/www/apps/docs/content/references/entities/classes/Discount.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Discount - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`Discount`** - -## Constructors - -### constructor - -• **new Discount**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### code - -• **code**: `string` - -#### Defined in - -[models/discount.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L22) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### ends\_at - -• **ends\_at**: ``null`` \| `Date` - -#### Defined in - -[models/discount.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L52) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### is\_disabled - -• **is\_disabled**: `boolean` - -#### Defined in - -[models/discount.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L36) - -___ - -### is\_dynamic - -• **is\_dynamic**: `boolean` - -#### Defined in - -[models/discount.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L25) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/discount.ts:78](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L78) - -___ - -### parent\_discount - -• **parent\_discount**: [`Discount`](Discount.md) - -#### Defined in - -[models/discount.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L43) - -___ - -### parent\_discount\_id - -• **parent\_discount\_id**: `string` - -#### Defined in - -[models/discount.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L39) - -___ - -### regions - -• **regions**: [`Region`](Region.md)[] - -#### Defined in - -[models/discount.ts:69](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L69) - -___ - -### rule - -• **rule**: [`DiscountRule`](DiscountRule.md) - -#### Defined in - -[models/discount.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L33) - -___ - -### rule\_id - -• **rule\_id**: `string` - -#### Defined in - -[models/discount.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L29) - -___ - -### starts\_at - -• **starts\_at**: `Date` - -#### Defined in - -[models/discount.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L49) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### usage\_count - -• **usage\_count**: `number` - -#### Defined in - -[models/discount.ts:75](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L75) - -___ - -### usage\_limit - -• **usage\_limit**: ``null`` \| `number` - -#### Defined in - -[models/discount.ts:72](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L72) - -___ - -### valid\_duration - -• **valid\_duration**: ``null`` \| `string` - -#### Defined in - -[models/discount.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L55) - -## Methods - -### upperCaseCodeAndTrim - -▸ `Private` **upperCaseCodeAndTrim**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/discount.ts:81](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount.ts#L81) diff --git a/www/apps/docs/content/references/entities/classes/Discount.mdx b/www/apps/docs/content/references/entities/classes/Discount.mdx new file mode 100644 index 0000000000..7d0aafa360 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Discount.mdx @@ -0,0 +1,1378 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Discount + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allocation", + "type": "[`AllocationType`](../enums/AllocationType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "conditions", + "type": "[`DiscountCondition`](DiscountCondition.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_2", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_3", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "num_code", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentProvider`](PaymentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allocation", + "type": "[`AllocationType`](../enums/AllocationType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ITEM", + "type": "``\"item\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "TOTAL", + "type": "``\"total\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "conditions", + "type": "[`DiscountCondition`](DiscountCondition.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountCondition`](DiscountCondition.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "operator", + "type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_collections", + "type": "[`ProductCollection`](ProductCollection.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_types", + "type": "[`ProductType`](ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "FIXED", + "type": "``\"fixed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FREE_SHIPPING", + "type": "``\"free_shipping\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PERCENTAGE", + "type": "``\"percentage\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/DiscountCondition.md b/www/apps/docs/content/references/entities/classes/DiscountCondition.md deleted file mode 100644 index b8b144091d..0000000000 --- a/www/apps/docs/content/references/entities/classes/DiscountCondition.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: DiscountCondition - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`DiscountCondition`** - -## Constructors - -### constructor - -• **new DiscountCondition**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### customer\_groups - -• **customer\_groups**: [`CustomerGroup`](CustomerGroup.md)[] - -#### Defined in - -[models/discount-condition.ts:129](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L129) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### discount\_rule - -• **discount\_rule**: [`DiscountRule`](DiscountRule.md) - -#### Defined in - -[models/discount-condition.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L59) - -___ - -### discount\_rule\_id - -• **discount\_rule\_id**: `string` - -#### Defined in - -[models/discount-condition.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L55) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/discount-condition.ts:132](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L132) - -___ - -### operator - -• **operator**: [`DiscountConditionOperator`](../enums/DiscountConditionOperator.md) - -#### Defined in - -[models/discount-condition.ts:51](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L51) - -___ - -### product\_collections - -• **product\_collections**: [`ProductCollection`](ProductCollection.md)[] - -#### Defined in - -[models/discount-condition.ts:115](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L115) - -___ - -### product\_tags - -• **product\_tags**: [`ProductTag`](ProductTag.md)[] - -#### Defined in - -[models/discount-condition.ts:101](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L101) - -___ - -### product\_types - -• **product\_types**: [`ProductType`](ProductType.md)[] - -#### Defined in - -[models/discount-condition.ts:87](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L87) - -___ - -### products - -• **products**: [`Product`](Product.md)[] - -#### Defined in - -[models/discount-condition.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L73) - -___ - -### type - -• **type**: [`DiscountConditionType`](../enums/DiscountConditionType.md) - -#### Defined in - -[models/discount-condition.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L45) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/discount-condition.ts:135](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L135) diff --git a/www/apps/docs/content/references/entities/classes/DiscountCondition.mdx b/www/apps/docs/content/references/entities/classes/DiscountCondition.mdx new file mode 100644 index 0000000000..63d68dd6cf --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/DiscountCondition.mdx @@ -0,0 +1,2677 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountCondition + +## Properties + + [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`PriceListStatus`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "`PriceListType`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allocation", + "type": "[`AllocationType`](../enums/AllocationType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ITEM", + "type": "``\"item\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "TOTAL", + "type": "``\"total\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "conditions", + "type": "[`DiscountCondition`](DiscountCondition.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountCondition`](DiscountCondition.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "operator", + "type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_collections", + "type": "[`ProductCollection`](ProductCollection.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_types", + "type": "[`ProductType`](ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "FIXED", + "type": "``\"fixed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FREE_SHIPPING", + "type": "``\"free_shipping\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PERCENTAGE", + "type": "``\"percentage\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "discount_rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "operator", + "type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "IN", + "type": "``\"in\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_IN", + "type": "``\"not_in\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_collections", + "type": "[`ProductCollection`](ProductCollection.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_types", + "type": "[`ProductType`](ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "category_children", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_active", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_internal", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category", + "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rank", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryProductJoinTable", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "`\"product_category_product\"`", + "children": [] + }, + { + "name": "treeRelations", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Image`](Image.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "DRAFT", + "type": "``\"draft\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PROPOSED", + "type": "``\"proposed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PUBLISHED", + "type": "``\"published\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REJECTED", + "type": "``\"rejected\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CUSTOMER_GROUPS", + "type": "``\"customer_groups\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCTS", + "type": "``\"products\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_COLLECTIONS", + "type": "``\"product_collections\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_TAGS", + "type": "``\"product_tags\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_TYPES", + "type": "``\"product_types\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionCustomerGroup.md b/www/apps/docs/content/references/entities/classes/DiscountConditionCustomerGroup.md deleted file mode 100644 index 55577e662e..0000000000 --- a/www/apps/docs/content/references/entities/classes/DiscountConditionCustomerGroup.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: DiscountConditionCustomerGroup - -## Constructors - -### constructor - -• **new DiscountConditionCustomerGroup**() - -## Properties - -### condition\_id - -• **condition\_id**: `string` - -#### Defined in - -[models/discount-condition-customer-group.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-customer-group.ts#L20) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Defined in - -[models/discount-condition-customer-group.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-customer-group.ts#L31) - -___ - -### customer\_group - -• `Optional` **customer\_group**: [`CustomerGroup`](CustomerGroup.md) - -#### Defined in - -[models/discount-condition-customer-group.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-customer-group.ts#L24) - -___ - -### customer\_group\_id - -• **customer\_group\_id**: `string` - -#### Defined in - -[models/discount-condition-customer-group.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-customer-group.ts#L17) - -___ - -### discount\_condition - -• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md) - -#### Defined in - -[models/discount-condition-customer-group.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-customer-group.ts#L28) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/discount-condition-customer-group.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-customer-group.ts#L37) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Defined in - -[models/discount-condition-customer-group.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-customer-group.ts#L34) diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionCustomerGroup.mdx b/www/apps/docs/content/references/entities/classes/DiscountConditionCustomerGroup.mdx new file mode 100644 index 0000000000..38ee16c956 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/DiscountConditionCustomerGroup.mdx @@ -0,0 +1,1304 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionCustomerGroup + +## Properties + + [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`PriceListStatus`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "`PriceListType`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_group_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_condition", + "type": "[`DiscountCondition`](DiscountCondition.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountCondition`](DiscountCondition.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allocation", + "type": "[`AllocationType`](../enums/AllocationType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "conditions", + "type": "[`DiscountCondition`](DiscountCondition.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "discount_rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "operator", + "type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "IN", + "type": "``\"in\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_IN", + "type": "``\"not_in\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_collections", + "type": "[`ProductCollection`](ProductCollection.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_types", + "type": "[`ProductType`](ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CUSTOMER_GROUPS", + "type": "``\"customer_groups\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCTS", + "type": "``\"products\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_COLLECTIONS", + "type": "``\"product_collections\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_TAGS", + "type": "``\"product_tags\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_TYPES", + "type": "``\"product_types\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionProduct.md b/www/apps/docs/content/references/entities/classes/DiscountConditionProduct.md deleted file mode 100644 index 550ce0a3e6..0000000000 --- a/www/apps/docs/content/references/entities/classes/DiscountConditionProduct.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: DiscountConditionProduct - -## Constructors - -### constructor - -• **new DiscountConditionProduct**() - -## Properties - -### condition\_id - -• **condition\_id**: `string` - -#### Defined in - -[models/discount-condition-product.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product.ts#L20) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Defined in - -[models/discount-condition-product.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product.ts#L31) - -___ - -### discount\_condition - -• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md) - -#### Defined in - -[models/discount-condition-product.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product.ts#L28) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/discount-condition-product.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product.ts#L37) - -___ - -### product - -• `Optional` **product**: [`Product`](Product.md) - -#### Defined in - -[models/discount-condition-product.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product.ts#L24) - -___ - -### product\_id - -• **product\_id**: `string` - -#### Defined in - -[models/discount-condition-product.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product.ts#L17) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Defined in - -[models/discount-condition-product.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product.ts#L34) diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionProduct.mdx b/www/apps/docs/content/references/entities/classes/DiscountConditionProduct.mdx new file mode 100644 index 0000000000..38ff8da461 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/DiscountConditionProduct.mdx @@ -0,0 +1,2313 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionProduct + +## Properties + + [`DiscountCondition`](DiscountCondition.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allocation", + "type": "[`AllocationType`](../enums/AllocationType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "conditions", + "type": "[`DiscountCondition`](DiscountCondition.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "discount_rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "operator", + "type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "IN", + "type": "``\"in\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_IN", + "type": "``\"not_in\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_collections", + "type": "[`ProductCollection`](ProductCollection.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_types", + "type": "[`ProductType`](ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CUSTOMER_GROUPS", + "type": "``\"customer_groups\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCTS", + "type": "``\"products\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_COLLECTIONS", + "type": "``\"product_collections\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_TAGS", + "type": "``\"product_tags\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_TYPES", + "type": "``\"product_types\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "category_children", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_active", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_internal", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category", + "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rank", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryProductJoinTable", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "`\"product_category_product\"`", + "children": [] + }, + { + "name": "treeRelations", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Image`](Image.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "DRAFT", + "type": "``\"draft\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PROPOSED", + "type": "``\"proposed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PUBLISHED", + "type": "``\"published\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REJECTED", + "type": "``\"rejected\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionProductCollection.md b/www/apps/docs/content/references/entities/classes/DiscountConditionProductCollection.md deleted file mode 100644 index 8a1f1fbd31..0000000000 --- a/www/apps/docs/content/references/entities/classes/DiscountConditionProductCollection.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: DiscountConditionProductCollection - -## Constructors - -### constructor - -• **new DiscountConditionProductCollection**() - -## Properties - -### condition\_id - -• **condition\_id**: `string` - -#### Defined in - -[models/discount-condition-product-collection.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-collection.ts#L20) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Defined in - -[models/discount-condition-product-collection.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-collection.ts#L31) - -___ - -### discount\_condition - -• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md) - -#### Defined in - -[models/discount-condition-product-collection.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-collection.ts#L28) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/discount-condition-product-collection.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-collection.ts#L37) - -___ - -### product\_collection - -• `Optional` **product\_collection**: [`ProductCollection`](ProductCollection.md) - -#### Defined in - -[models/discount-condition-product-collection.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-collection.ts#L24) - -___ - -### product\_collection\_id - -• **product\_collection\_id**: `string` - -#### Defined in - -[models/discount-condition-product-collection.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-collection.ts#L17) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Defined in - -[models/discount-condition-product-collection.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-collection.ts#L34) diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionProductCollection.mdx b/www/apps/docs/content/references/entities/classes/DiscountConditionProductCollection.mdx new file mode 100644 index 0000000000..d99246931e --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/DiscountConditionProductCollection.mdx @@ -0,0 +1,1351 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionProductCollection + +## Properties + + [`DiscountCondition`](DiscountCondition.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allocation", + "type": "[`AllocationType`](../enums/AllocationType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "conditions", + "type": "[`DiscountCondition`](DiscountCondition.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "discount_rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "operator", + "type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "IN", + "type": "``\"in\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_IN", + "type": "``\"not_in\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_collections", + "type": "[`ProductCollection`](ProductCollection.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_types", + "type": "[`ProductType`](ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CUSTOMER_GROUPS", + "type": "``\"customer_groups\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCTS", + "type": "``\"products\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_COLLECTIONS", + "type": "``\"product_collections\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_TAGS", + "type": "``\"product_tags\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_TYPES", + "type": "``\"product_types\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionProductTag.md b/www/apps/docs/content/references/entities/classes/DiscountConditionProductTag.md deleted file mode 100644 index 0a4d12c314..0000000000 --- a/www/apps/docs/content/references/entities/classes/DiscountConditionProductTag.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: DiscountConditionProductTag - -## Constructors - -### constructor - -• **new DiscountConditionProductTag**() - -## Properties - -### condition\_id - -• **condition\_id**: `string` - -#### Defined in - -[models/discount-condition-product-tag.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-tag.ts#L20) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Defined in - -[models/discount-condition-product-tag.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-tag.ts#L31) - -___ - -### discount\_condition - -• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md) - -#### Defined in - -[models/discount-condition-product-tag.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-tag.ts#L28) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/discount-condition-product-tag.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-tag.ts#L37) - -___ - -### product\_tag - -• `Optional` **product\_tag**: [`ProductTag`](ProductTag.md) - -#### Defined in - -[models/discount-condition-product-tag.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-tag.ts#L24) - -___ - -### product\_tag\_id - -• **product\_tag\_id**: `string` - -#### Defined in - -[models/discount-condition-product-tag.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-tag.ts#L17) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Defined in - -[models/discount-condition-product-tag.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-tag.ts#L34) diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionProductTag.mdx b/www/apps/docs/content/references/entities/classes/DiscountConditionProductTag.mdx new file mode 100644 index 0000000000..0d48b44db3 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/DiscountConditionProductTag.mdx @@ -0,0 +1,1022 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionProductTag + +## Properties + + [`DiscountCondition`](DiscountCondition.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allocation", + "type": "[`AllocationType`](../enums/AllocationType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "conditions", + "type": "[`DiscountCondition`](DiscountCondition.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "discount_rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "operator", + "type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "IN", + "type": "``\"in\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_IN", + "type": "``\"not_in\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_collections", + "type": "[`ProductCollection`](ProductCollection.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_types", + "type": "[`ProductType`](ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CUSTOMER_GROUPS", + "type": "``\"customer_groups\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCTS", + "type": "``\"products\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_COLLECTIONS", + "type": "``\"product_collections\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_TAGS", + "type": "``\"product_tags\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_TYPES", + "type": "``\"product_types\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_tag", + "type": "[`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_tag_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionProductType.md b/www/apps/docs/content/references/entities/classes/DiscountConditionProductType.md deleted file mode 100644 index 4421862183..0000000000 --- a/www/apps/docs/content/references/entities/classes/DiscountConditionProductType.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: DiscountConditionProductType - -## Constructors - -### constructor - -• **new DiscountConditionProductType**() - -## Properties - -### condition\_id - -• **condition\_id**: `string` - -#### Defined in - -[models/discount-condition-product-type.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-type.ts#L20) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Defined in - -[models/discount-condition-product-type.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-type.ts#L31) - -___ - -### discount\_condition - -• `Optional` **discount\_condition**: [`DiscountCondition`](DiscountCondition.md) - -#### Defined in - -[models/discount-condition-product-type.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-type.ts#L28) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/discount-condition-product-type.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-type.ts#L37) - -___ - -### product\_type - -• `Optional` **product\_type**: [`ProductType`](ProductType.md) - -#### Defined in - -[models/discount-condition-product-type.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-type.ts#L24) - -___ - -### product\_type\_id - -• **product\_type\_id**: `string` - -#### Defined in - -[models/discount-condition-product-type.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-type.ts#L17) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Defined in - -[models/discount-condition-product-type.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition-product-type.ts#L34) diff --git a/www/apps/docs/content/references/entities/classes/DiscountConditionProductType.mdx b/www/apps/docs/content/references/entities/classes/DiscountConditionProductType.mdx new file mode 100644 index 0000000000..ef04319ab6 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/DiscountConditionProductType.mdx @@ -0,0 +1,1022 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionProductType + +## Properties + + [`DiscountCondition`](DiscountCondition.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allocation", + "type": "[`AllocationType`](../enums/AllocationType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "conditions", + "type": "[`DiscountCondition`](DiscountCondition.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "discount_rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "operator", + "type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "IN", + "type": "``\"in\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_IN", + "type": "``\"not_in\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_collections", + "type": "[`ProductCollection`](ProductCollection.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_types", + "type": "[`ProductType`](ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CUSTOMER_GROUPS", + "type": "``\"customer_groups\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCTS", + "type": "``\"products\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_COLLECTIONS", + "type": "``\"product_collections\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_TAGS", + "type": "``\"product_tags\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_TYPES", + "type": "``\"product_types\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_type_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/DiscountRule.md b/www/apps/docs/content/references/entities/classes/DiscountRule.md deleted file mode 100644 index 99a11f5d78..0000000000 --- a/www/apps/docs/content/references/entities/classes/DiscountRule.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: DiscountRule - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`DiscountRule`** - -## Constructors - -### constructor - -• **new DiscountRule**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### allocation - -• **allocation**: [`AllocationType`](../enums/AllocationType.md) - -#### Defined in - -[models/discount-rule.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L38) - -___ - -### conditions - -• **conditions**: [`DiscountCondition`](DiscountCondition.md)[] - -#### Defined in - -[models/discount-rule.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L41) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### description - -• **description**: `string` - -#### Defined in - -[models/discount-rule.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L22) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/discount-rule.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L44) - -___ - -### type - -• **type**: [`DiscountRuleType`](../enums/DiscountRuleType.md) - -#### Defined in - -[models/discount-rule.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L28) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### value - -• **value**: `number` - -#### Defined in - -[models/discount-rule.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L31) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/discount-rule.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L47) diff --git a/www/apps/docs/content/references/entities/classes/DiscountRule.mdx b/www/apps/docs/content/references/entities/classes/DiscountRule.mdx new file mode 100644 index 0000000000..23506276c6 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/DiscountRule.mdx @@ -0,0 +1,1023 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountRule + +## Properties + + [`DiscountCondition`](DiscountCondition.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allocation", + "type": "[`AllocationType`](../enums/AllocationType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "conditions", + "type": "[`DiscountCondition`](DiscountCondition.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "discount_rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "operator", + "type": "[`DiscountConditionOperator`](../enums/DiscountConditionOperator.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "IN", + "type": "``\"in\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_IN", + "type": "``\"not_in\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_collections", + "type": "[`ProductCollection`](ProductCollection.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_types", + "type": "[`ProductType`](ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`DiscountConditionType`](../enums/DiscountConditionType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CUSTOMER_GROUPS", + "type": "``\"customer_groups\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCTS", + "type": "``\"products\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_COLLECTIONS", + "type": "``\"product_collections\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_TAGS", + "type": "``\"product_tags\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PRODUCT_TYPES", + "type": "``\"product_types\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "FIXED", + "type": "``\"fixed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FREE_SHIPPING", + "type": "``\"free_shipping\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PERCENTAGE", + "type": "``\"percentage\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/DraftOrder.md b/www/apps/docs/content/references/entities/classes/DraftOrder.md deleted file mode 100644 index 13b9ea9d62..0000000000 --- a/www/apps/docs/content/references/entities/classes/DraftOrder.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: DraftOrder - -## Hierarchy - -- `BaseEntity` - - ↳ **`DraftOrder`** - -## Constructors - -### constructor - -• **new DraftOrder**() - -#### Inherited from - -BaseEntity.constructor - -## Properties - -### canceled\_at - -• **canceled\_at**: `Date` - -#### Defined in - -[models/draft-order.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L53) - -___ - -### cart - -• **cart**: [`Cart`](Cart.md) - -#### Defined in - -[models/draft-order.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L42) - -___ - -### cart\_id - -• **cart\_id**: `string` - -#### Defined in - -[models/draft-order.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L38) - -___ - -### completed\_at - -• **completed\_at**: `Date` - -#### Defined in - -[models/draft-order.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L56) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -BaseEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### display\_id - -• **display\_id**: `number` - -#### Defined in - -[models/draft-order.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L34) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -BaseEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -[models/draft-order.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L65) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/draft-order.ts:62](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L62) - -___ - -### no\_notification\_order - -• **no\_notification\_order**: `boolean` - -#### Defined in - -[models/draft-order.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L59) - -___ - -### order - -• **order**: [`Order`](Order.md) - -#### Defined in - -[models/draft-order.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L50) - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -[models/draft-order.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L46) - -___ - -### status - -• **status**: [`DraftOrderStatus`](../enums/DraftOrderStatus.md) - -#### Defined in - -[models/draft-order.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L29) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -BaseEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[models/draft-order.ts:68](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L68) diff --git a/www/apps/docs/content/references/entities/classes/DraftOrder.mdx b/www/apps/docs/content/references/entities/classes/DraftOrder.mdx new file mode 100644 index 0000000000..b3d77c1b2e --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/DraftOrder.mdx @@ -0,0 +1,6762 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DraftOrder + +## Properties + + [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_initiated", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_selected", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CLAIM", + "type": "``\"claim\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEFAULT", + "type": "``\"default\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DRAFT_ORDER", + "type": "``\"draft_order\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PAYMENT_LINK", + "type": "``\"payment_link\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SWAP", + "type": "``\"swap\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card", + "type": "[`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Refund`](Refund.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ARCHIVED", + "type": "``\"archived\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "OPEN", + "type": "``\"open\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Fulfillment.md b/www/apps/docs/content/references/entities/classes/Fulfillment.md deleted file mode 100644 index fb5161a0cd..0000000000 --- a/www/apps/docs/content/references/entities/classes/Fulfillment.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Fulfillment - -## Hierarchy - -- `BaseEntity` - - ↳ **`Fulfillment`** - -## Constructors - -### constructor - -• **new Fulfillment**() - -#### Inherited from - -BaseEntity.constructor - -## Properties - -### canceled\_at - -• **canceled\_at**: `Date` - -#### Defined in - -[models/fulfillment.ts:82](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L82) - -___ - -### claim\_order - -• **claim\_order**: [`ClaimOrder`](ClaimOrder.md) - -#### Defined in - -[models/fulfillment.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L29) - -___ - -### claim\_order\_id - -• **claim\_order\_id**: `string` - -#### Defined in - -[models/fulfillment.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L25) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -BaseEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/fulfillment.ts:76](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L76) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -BaseEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -[models/fulfillment.ts:88](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L88) - -___ - -### items - -• **items**: [`FulfillmentItem`](FulfillmentItem.md)[] - -#### Defined in - -[models/fulfillment.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L65) - -___ - -### location\_id - -• **location\_id**: ``null`` \| `string` - -#### Defined in - -[models/fulfillment.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L55) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/fulfillment.ts:85](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L85) - -___ - -### no\_notification - -• **no\_notification**: `boolean` - -#### Defined in - -[models/fulfillment.ts:48](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L48) - -___ - -### order - -• **order**: [`Order`](Order.md) - -#### Defined in - -[models/fulfillment.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L45) - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -[models/fulfillment.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L41) - -___ - -### provider - -• **provider**: [`FulfillmentProvider`](FulfillmentProvider.md) - -#### Defined in - -[models/fulfillment.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L59) - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -[models/fulfillment.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L52) - -___ - -### shipped\_at - -• **shipped\_at**: `Date` - -#### Defined in - -[models/fulfillment.ts:79](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L79) - -___ - -### swap - -• **swap**: [`Swap`](Swap.md) - -#### Defined in - -[models/fulfillment.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L37) - -___ - -### swap\_id - -• **swap\_id**: `string` - -#### Defined in - -[models/fulfillment.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L33) - -___ - -### tracking\_links - -• **tracking\_links**: [`TrackingLink`](TrackingLink.md)[] - -#### Defined in - -[models/fulfillment.ts:70](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L70) - -___ - -### tracking\_numbers - -• **tracking\_numbers**: `string`[] - -#### Defined in - -[models/fulfillment.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L73) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -BaseEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/fulfillment.ts:91](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment.ts#L91) diff --git a/www/apps/docs/content/references/entities/classes/Fulfillment.mdx b/www/apps/docs/content/references/entities/classes/Fulfillment.mdx new file mode 100644 index 0000000000..30bf69263e --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Fulfillment.mdx @@ -0,0 +1,10001 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Fulfillment + +## Properties + + [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimItem`](ClaimItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`ClaimImage`](ClaimImage.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ClaimReason`](../enums/ClaimReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ClaimTag`](ClaimTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "NA", + "type": "``\"na\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_REFUNDED", + "type": "``\"not_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "REFUND", + "type": "``\"refund\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REPLACE", + "type": "``\"replace\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentItem`](FulfillmentItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment", + "type": "[`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card", + "type": "[`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Refund`](Refund.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ARCHIVED", + "type": "``\"archived\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CONFIRMED", + "type": "``\"confirmed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DIFFERENCE_REFUNDED", + "type": "``\"difference_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TrackingLink`](TrackingLink.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment", + "type": "[`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_number", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/FulfillmentItem.md b/www/apps/docs/content/references/entities/classes/FulfillmentItem.md deleted file mode 100644 index 1faa7f13ee..0000000000 --- a/www/apps/docs/content/references/entities/classes/FulfillmentItem.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: FulfillmentItem - -## Constructors - -### constructor - -• **new FulfillmentItem**() - -## Properties - -### fulfillment - -• **fulfillment**: [`Fulfillment`](Fulfillment.md) - -#### Defined in - -[models/fulfillment-item.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment-item.ts#L16) - -___ - -### fulfillment\_id - -• **fulfillment\_id**: `string` - -#### Defined in - -[models/fulfillment-item.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment-item.ts#L9) - -___ - -### item - -• **item**: [`LineItem`](LineItem.md) - -#### Defined in - -[models/fulfillment-item.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment-item.ts#L20) - -___ - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -[models/fulfillment-item.ts:12](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment-item.ts#L12) - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -[models/fulfillment-item.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment-item.ts#L23) diff --git a/www/apps/docs/content/references/entities/classes/FulfillmentItem.mdx b/www/apps/docs/content/references/entities/classes/FulfillmentItem.mdx new file mode 100644 index 0000000000..9e722104c6 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/FulfillmentItem.mdx @@ -0,0 +1,3291 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FulfillmentItem + +## Properties + + [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentItem`](FulfillmentItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment", + "type": "[`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TrackingLink`](TrackingLink.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment", + "type": "[`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_number", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemAdjustment`](LineItemAdjustment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemTaxLine`](LineItemTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/FulfillmentProvider.md b/www/apps/docs/content/references/entities/classes/FulfillmentProvider.md deleted file mode 100644 index 77b9448b57..0000000000 --- a/www/apps/docs/content/references/entities/classes/FulfillmentProvider.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: FulfillmentProvider - -## Constructors - -### constructor - -• **new FulfillmentProvider**() - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -[models/fulfillment-provider.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment-provider.ts#L6) - -___ - -### is\_installed - -• **is\_installed**: `boolean` - -#### Defined in - -[models/fulfillment-provider.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/fulfillment-provider.ts#L9) diff --git a/www/apps/docs/content/references/entities/classes/FulfillmentProvider.mdx b/www/apps/docs/content/references/entities/classes/FulfillmentProvider.mdx new file mode 100644 index 0000000000..80f6421830 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/FulfillmentProvider.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FulfillmentProvider + +## Properties + + diff --git a/www/apps/docs/content/references/entities/classes/GiftCard.md b/www/apps/docs/content/references/entities/classes/GiftCard.md deleted file mode 100644 index 590dd65325..0000000000 --- a/www/apps/docs/content/references/entities/classes/GiftCard.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: GiftCard - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`GiftCard`** - -## Constructors - -### constructor - -• **new GiftCard**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### balance - -• **balance**: `number` - -#### Defined in - -[models/gift-card.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L26) - -___ - -### code - -• **code**: `string` - -#### Defined in - -[models/gift-card.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L20) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### ends\_at - -• **ends\_at**: `Date` - -#### Defined in - -[models/gift-card.ts:51](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L51) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### is\_disabled - -• **is\_disabled**: `boolean` - -#### Defined in - -[models/gift-card.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L45) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/gift-card.ts:57](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L57) - -___ - -### order - -• **order**: [`Order`](Order.md) - -#### Defined in - -[models/gift-card.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L42) - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -[models/gift-card.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L38) - -___ - -### region - -• **region**: [`Region`](Region.md) - -#### Defined in - -[models/gift-card.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L34) - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -[models/gift-card.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L30) - -___ - -### tax\_rate - -• **tax\_rate**: ``null`` \| `number` - -#### Defined in - -[models/gift-card.ts:54](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L54) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### value - -• **value**: `number` - -#### Defined in - -[models/gift-card.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L23) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/gift-card.ts:60](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card.ts#L60) diff --git a/www/apps/docs/content/references/entities/classes/GiftCard.mdx b/www/apps/docs/content/references/entities/classes/GiftCard.mdx new file mode 100644 index 0000000000..368b4af46c --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/GiftCard.mdx @@ -0,0 +1,5011 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# GiftCard + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card", + "type": "[`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Refund`](Refund.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ARCHIVED", + "type": "``\"archived\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_2", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_3", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "num_code", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentProvider`](PaymentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/GiftCardTransaction.md b/www/apps/docs/content/references/entities/classes/GiftCardTransaction.md deleted file mode 100644 index 4e2741edd4..0000000000 --- a/www/apps/docs/content/references/entities/classes/GiftCardTransaction.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: GiftCardTransaction - -## Constructors - -### constructor - -• **new GiftCardTransaction**() - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -[models/gift-card-transaction.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L40) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Defined in - -[models/gift-card-transaction.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L43) - -___ - -### gift\_card - -• **gift\_card**: [`GiftCard`](GiftCard.md) - -#### Defined in - -[models/gift-card-transaction.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L29) - -___ - -### gift\_card\_id - -• **gift\_card\_id**: `string` - -#### Defined in - -[models/gift-card-transaction.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L25) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[models/gift-card-transaction.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L22) - -___ - -### is\_taxable - -• **is\_taxable**: `boolean` - -#### Defined in - -[models/gift-card-transaction.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L46) - -___ - -### order - -• **order**: [`Order`](Order.md) - -#### Defined in - -[models/gift-card-transaction.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L37) - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -[models/gift-card-transaction.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L33) - -___ - -### tax\_rate - -• **tax\_rate**: ``null`` \| `number` - -#### Defined in - -[models/gift-card-transaction.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L49) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/gift-card-transaction.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/gift-card-transaction.ts#L52) diff --git a/www/apps/docs/content/references/entities/classes/GiftCardTransaction.mdx b/www/apps/docs/content/references/entities/classes/GiftCardTransaction.mdx new file mode 100644 index 0000000000..83d98ab25a --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/GiftCardTransaction.mdx @@ -0,0 +1,5376 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# GiftCardTransaction + +## Properties + + [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card", + "type": "[`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Refund`](Refund.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ARCHIVED", + "type": "``\"archived\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/IdempotencyKey.md b/www/apps/docs/content/references/entities/classes/IdempotencyKey.md deleted file mode 100644 index 9443f7db15..0000000000 --- a/www/apps/docs/content/references/entities/classes/IdempotencyKey.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: IdempotencyKey - -## Constructors - -### constructor - -• **new IdempotencyKey**() - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Defined in - -[models/idempotency-key.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L23) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[models/idempotency-key.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L16) - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -[models/idempotency-key.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L20) - -___ - -### locked\_at - -• **locked\_at**: `Date` - -#### Defined in - -[models/idempotency-key.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L26) - -___ - -### recovery\_point - -• **recovery\_point**: `string` - -#### Defined in - -[models/idempotency-key.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L44) - -___ - -### request\_method - -• **request\_method**: `string` - -#### Defined in - -[models/idempotency-key.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L29) - -___ - -### request\_params - -• **request\_params**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/idempotency-key.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L32) - -___ - -### request\_path - -• **request\_path**: `string` - -#### Defined in - -[models/idempotency-key.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L35) - -___ - -### response\_body - -• **response\_body**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/idempotency-key.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L41) - -___ - -### response\_code - -• **response\_code**: `number` - -#### Defined in - -[models/idempotency-key.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L38) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/idempotency-key.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/idempotency-key.ts#L47) diff --git a/www/apps/docs/content/references/entities/classes/IdempotencyKey.mdx b/www/apps/docs/content/references/entities/classes/IdempotencyKey.mdx new file mode 100644 index 0000000000..18e5f459a7 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/IdempotencyKey.mdx @@ -0,0 +1,92 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IdempotencyKey + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "request_path", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "response_body", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "response_code", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Image.md b/www/apps/docs/content/references/entities/classes/Image.md deleted file mode 100644 index 715b3ace7e..0000000000 --- a/www/apps/docs/content/references/entities/classes/Image.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Image - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`Image`** - -## Constructors - -### constructor - -• **new Image**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/image.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/image.ts#L13) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### url - -• **url**: `string` - -#### Defined in - -[models/image.ts:10](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/image.ts#L10) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/image.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/image.ts#L16) diff --git a/www/apps/docs/content/references/entities/classes/Image.mdx b/www/apps/docs/content/references/entities/classes/Image.mdx new file mode 100644 index 0000000000..47950dd9af --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Image.mdx @@ -0,0 +1,60 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Image + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Invite.md b/www/apps/docs/content/references/entities/classes/Invite.md deleted file mode 100644 index 0a426665ba..0000000000 --- a/www/apps/docs/content/references/entities/classes/Invite.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Invite - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`Invite`** - -## Constructors - -### constructor - -• **new Invite**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### accepted - -• **accepted**: `boolean` - -#### Defined in - -[models/invite.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/invite.ts#L23) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### expires\_at - -• **expires\_at**: `Date` - -#### Defined in - -[models/invite.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/invite.ts#L29) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/invite.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/invite.ts#L32) - -___ - -### role - -• **role**: [`UserRoles`](../enums/UserRoles.md) - -#### Defined in - -[models/invite.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/invite.ts#L20) - -___ - -### token - -• **token**: `string` - -#### Defined in - -[models/invite.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/invite.ts#L26) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### user\_email - -• **user\_email**: `string` - -#### Defined in - -[models/invite.ts:12](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/invite.ts#L12) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/invite.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/invite.ts#L35) diff --git a/www/apps/docs/content/references/entities/classes/Invite.mdx b/www/apps/docs/content/references/entities/classes/Invite.mdx new file mode 100644 index 0000000000..b87cf0c51b --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Invite.mdx @@ -0,0 +1,117 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Invite + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "role", + "type": "[`UserRoles`](../enums/UserRoles.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ADMIN", + "type": "``\"admin\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEVELOPER", + "type": "``\"developer\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "MEMBER", + "type": "``\"member\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "token", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "user_email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/LineItem.md b/www/apps/docs/content/references/entities/classes/LineItem.md deleted file mode 100644 index 8ebe997e67..0000000000 --- a/www/apps/docs/content/references/entities/classes/LineItem.md +++ /dev/null @@ -1,505 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: LineItem - -## Hierarchy - -- `BaseEntity` - - ↳ **`LineItem`** - -## Constructors - -### constructor - -• **new LineItem**() - -#### Inherited from - -BaseEntity.constructor - -## Properties - -### adjustments - -• **adjustments**: [`LineItemAdjustment`](LineItemAdjustment.md)[] - -#### Defined in - -[models/line-item.ts:87](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L87) - -___ - -### allow\_discounts - -• **allow\_discounts**: `boolean` - -#### Defined in - -[models/line-item.ts:118](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L118) - -___ - -### cart - -• **cart**: [`Cart`](Cart.md) - -#### Defined in - -[models/line-item.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L53) - -___ - -### cart\_id - -• **cart\_id**: `string` - -#### Defined in - -[models/line-item.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L49) - -___ - -### claim\_order - -• **claim\_order**: [`ClaimOrder`](ClaimOrder.md) - -#### Defined in - -[models/line-item.ts:77](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L77) - -___ - -### claim\_order\_id - -• **claim\_order\_id**: `string` - -#### Defined in - -[models/line-item.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L73) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -BaseEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### description - -• **description**: ``null`` \| `string` - -#### Defined in - -[models/line-item.ts:103](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L103) - -___ - -### discount\_total - -• `Optional` **discount\_total**: ``null`` \| `number` - -#### Defined in - -[models/line-item.ts:161](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L161) - -___ - -### fulfilled\_quantity - -• **fulfilled\_quantity**: ``null`` \| `number` - -#### Defined in - -[models/line-item.ts:141](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L141) - -___ - -### gift\_card\_total - -• `Optional` **gift\_card\_total**: ``null`` \| `number` - -#### Defined in - -[models/line-item.ts:163](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L163) - -___ - -### has\_shipping - -• **has\_shipping**: ``null`` \| `boolean` - -#### Defined in - -[models/line-item.ts:121](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L121) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -BaseEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### includes\_tax - -• **includes\_tax**: `boolean` - -#### Defined in - -[models/line-item.ts:153](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L153) - -___ - -### is\_giftcard - -• **is\_giftcard**: `boolean` - -#### Defined in - -[models/line-item.ts:112](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L112) - -___ - -### is\_return - -• **is\_return**: `boolean` - -#### Defined in - -[models/line-item.ts:109](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L109) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/line-item.ts:150](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L150) - -___ - -### order - -• **order**: [`Order`](Order.md) - -#### Defined in - -[models/line-item.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L61) - -___ - -### order\_edit - -• `Optional` **order\_edit**: ``null`` \| [`OrderEdit`](OrderEdit.md) - -#### Defined in - -[models/line-item.ts:97](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L97) - -___ - -### order\_edit\_id - -• `Optional` **order\_edit\_id**: ``null`` \| `string` - -#### Defined in - -[models/line-item.ts:93](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L93) - -___ - -### order\_id - -• **order\_id**: ``null`` \| `string` - -#### Defined in - -[models/line-item.ts:57](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L57) - -___ - -### original\_item\_id - -• `Optional` **original\_item\_id**: ``null`` \| `string` - -#### Defined in - -[models/line-item.ts:90](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L90) - -___ - -### original\_tax\_total - -• `Optional` **original\_tax\_total**: ``null`` \| `number` - -#### Defined in - -[models/line-item.ts:160](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L160) - -___ - -### original\_total - -• `Optional` **original\_total**: ``null`` \| `number` - -#### Defined in - -[models/line-item.ts:159](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L159) - -___ - -### product\_id - -• **product\_id**: ``null`` \| `string` - -#### Defined in - -[models/line-item.ts:135](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L135) - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -[models/line-item.ts:138](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L138) - -___ - -### raw\_discount\_total - -• `Optional` **raw\_discount\_total**: ``null`` \| `number` - -#### Defined in - -[models/line-item.ts:162](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L162) - -___ - -### refundable - -• `Optional` **refundable**: ``null`` \| `number` - -#### Defined in - -[models/line-item.ts:155](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L155) - -___ - -### returned\_quantity - -• **returned\_quantity**: ``null`` \| `number` - -#### Defined in - -[models/line-item.ts:144](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L144) - -___ - -### shipped\_quantity - -• **shipped\_quantity**: ``null`` \| `number` - -#### Defined in - -[models/line-item.ts:147](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L147) - -___ - -### should\_merge - -• **should\_merge**: `boolean` - -#### Defined in - -[models/line-item.ts:115](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L115) - -___ - -### subtotal - -• `Optional` **subtotal**: ``null`` \| `number` - -#### Defined in - -[models/line-item.ts:156](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L156) - -___ - -### swap - -• **swap**: [`Swap`](Swap.md) - -#### Defined in - -[models/line-item.ts:69](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L69) - -___ - -### swap\_id - -• **swap\_id**: `string` - -#### Defined in - -[models/line-item.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L65) - -___ - -### tax\_lines - -• **tax\_lines**: [`LineItemTaxLine`](LineItemTaxLine.md)[] - -#### Defined in - -[models/line-item.ts:82](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L82) - -___ - -### tax\_total - -• `Optional` **tax\_total**: ``null`` \| `number` - -#### Defined in - -[models/line-item.ts:157](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L157) - -___ - -### thumbnail - -• **thumbnail**: ``null`` \| `string` - -#### Defined in - -[models/line-item.ts:106](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L106) - -___ - -### title - -• **title**: `string` - -#### Defined in - -[models/line-item.ts:100](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L100) - -___ - -### total - -• `Optional` **total**: ``null`` \| `number` - -#### Defined in - -[models/line-item.ts:158](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L158) - -___ - -### unit\_price - -• **unit\_price**: `number` - -#### Defined in - -[models/line-item.ts:124](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L124) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -BaseEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### variant - -• **variant**: [`ProductVariant`](ProductVariant.md) - -#### Defined in - -[models/line-item.ts:132](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L132) - -___ - -### variant\_id - -• **variant\_id**: ``null`` \| `string` - -#### Defined in - -[models/line-item.ts:128](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L128) - -## Methods - -### afterUpdateOrLoad - -▸ **afterUpdateOrLoad**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/line-item.ts:193](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L193) - -___ - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/line-item.ts:166](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L166) - -___ - -### beforeUpdate - -▸ **beforeUpdate**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/line-item.ts:182](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item.ts#L182) diff --git a/www/apps/docs/content/references/entities/classes/LineItem.mdx b/www/apps/docs/content/references/entities/classes/LineItem.mdx new file mode 100644 index 0000000000..ebacb12f4a --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/LineItem.mdx @@ -0,0 +1,13345 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# LineItem + +## Properties + + [`LineItemAdjustment`](LineItemAdjustment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_initiated", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_selected", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CLAIM", + "type": "``\"claim\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEFAULT", + "type": "``\"default\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DRAFT_ORDER", + "type": "``\"draft_order\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PAYMENT_LINK", + "type": "``\"payment_link\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SWAP", + "type": "``\"swap\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimItem`](ClaimItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`ClaimImage`](ClaimImage.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ClaimReason`](../enums/ClaimReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ClaimTag`](ClaimTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "NA", + "type": "``\"na\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_REFUNDED", + "type": "``\"not_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "REFUND", + "type": "``\"refund\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REPLACE", + "type": "``\"replace\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card", + "type": "[`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Refund`](Refund.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ARCHIVED", + "type": "``\"archived\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CONFIRMED", + "type": "``\"confirmed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DIFFERENCE_REFUNDED", + "type": "``\"difference_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemTaxLine`](LineItemTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "required_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOptionValue`](ProductOptionValue.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option", + "type": "[`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`MoneyAmount`](MoneyAmount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list", + "type": "``null`` \\| [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/LineItemAdjustment.md b/www/apps/docs/content/references/entities/classes/LineItemAdjustment.md deleted file mode 100644 index 6d4a573967..0000000000 --- a/www/apps/docs/content/references/entities/classes/LineItemAdjustment.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: LineItemAdjustment - -## Constructors - -### constructor - -• **new LineItemAdjustment**() - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -[models/line-item-adjustment.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L44) - -___ - -### description - -• **description**: `string` - -#### Defined in - -[models/line-item-adjustment.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L33) - -___ - -### discount - -• **discount**: [`Discount`](Discount.md) - -#### Defined in - -[models/line-item-adjustment.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L37) - -___ - -### discount\_id - -• **discount\_id**: `string` - -#### Defined in - -[models/line-item-adjustment.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L41) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[models/line-item-adjustment.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L22) - -___ - -### item - -• **item**: [`LineItem`](LineItem.md) - -#### Defined in - -[models/line-item-adjustment.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L30) - -___ - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -[models/line-item-adjustment.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L26) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/line-item-adjustment.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L47) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/line-item-adjustment.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-adjustment.ts#L50) diff --git a/www/apps/docs/content/references/entities/classes/LineItemAdjustment.mdx b/www/apps/docs/content/references/entities/classes/LineItemAdjustment.mdx new file mode 100644 index 0000000000..cfff0649e5 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/LineItemAdjustment.mdx @@ -0,0 +1,2680 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# LineItemAdjustment + +## Properties + + [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allocation", + "type": "[`AllocationType`](../enums/AllocationType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "conditions", + "type": "[`DiscountCondition`](DiscountCondition.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemAdjustment`](LineItemAdjustment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemTaxLine`](LineItemTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/LineItemTaxLine.md b/www/apps/docs/content/references/entities/classes/LineItemTaxLine.md deleted file mode 100644 index bfa9551adb..0000000000 --- a/www/apps/docs/content/references/entities/classes/LineItemTaxLine.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: LineItemTaxLine - -## Hierarchy - -- `TaxLine` - - ↳ **`LineItemTaxLine`** - -## Constructors - -### constructor - -• **new LineItemTaxLine**() - -#### Inherited from - -TaxLine.constructor - -## Properties - -### code - -• **code**: ``null`` \| `string` - -#### Inherited from - -TaxLine.code - -#### Defined in - -[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-line.ts#L13) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -TaxLine.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -TaxLine.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### item - -• **item**: [`LineItem`](LineItem.md) - -#### Defined in - -[models/line-item-tax-line.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-tax-line.ts#L24) - -___ - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -[models/line-item-tax-line.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-tax-line.ts#L20) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Inherited from - -TaxLine.metadata - -#### Defined in - -[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-line.ts#L16) - -___ - -### name - -• **name**: `string` - -#### Inherited from - -TaxLine.name - -#### Defined in - -[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-line.ts#L10) - -___ - -### rate - -• **rate**: `number` - -#### Inherited from - -TaxLine.rate - -#### Defined in - -[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-line.ts#L7) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -TaxLine.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/line-item-tax-line.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/line-item-tax-line.ts#L27) diff --git a/www/apps/docs/content/references/entities/classes/LineItemTaxLine.mdx b/www/apps/docs/content/references/entities/classes/LineItemTaxLine.mdx new file mode 100644 index 0000000000..7fcf3e9f59 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/LineItemTaxLine.mdx @@ -0,0 +1,2100 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# LineItemTaxLine + +## Properties + + [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemAdjustment`](LineItemAdjustment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemTaxLine`](LineItemTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/MoneyAmount.md b/www/apps/docs/content/references/entities/classes/MoneyAmount.md deleted file mode 100644 index 26cbe3853d..0000000000 --- a/www/apps/docs/content/references/entities/classes/MoneyAmount.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: MoneyAmount - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`MoneyAmount`** - -## Constructors - -### constructor - -• **new MoneyAmount**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -[models/money-amount.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L32) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### currency - -• `Optional` **currency**: [`Currency`](Currency.md) - -#### Defined in - -[models/money-amount.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L29) - -___ - -### currency\_code - -• **currency\_code**: `string` - -#### Defined in - -[models/money-amount.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L25) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### max\_quantity - -• **max\_quantity**: ``null`` \| `number` - -#### Defined in - -[models/money-amount.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L38) - -___ - -### min\_quantity - -• **min\_quantity**: ``null`` \| `number` - -#### Defined in - -[models/money-amount.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L35) - -___ - -### price\_list - -• **price\_list**: ``null`` \| [`PriceList`](PriceList.md) - -#### Defined in - -[models/money-amount.ts:48](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L48) - -___ - -### price\_list\_id - -• **price\_list\_id**: ``null`` \| `string` - -#### Defined in - -[models/money-amount.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L41) - -___ - -### region - -• `Optional` **region**: [`Region`](Region.md) - -#### Defined in - -[models/money-amount.ts:76](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L76) - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -[models/money-amount.ts:72](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L72) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### variant - -• **variant**: [`ProductVariant`](ProductVariant.md) - -#### Defined in - -[models/money-amount.ts:66](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L66) - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -[models/money-amount.ts:68](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L68) - -___ - -### variants - -• **variants**: [`ProductVariant`](ProductVariant.md)[] - -#### Defined in - -[models/money-amount.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L64) - -## Methods - -### afterLoad - -▸ `Private` **afterLoad**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/money-amount.ts:99](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L99) - -___ - -### beforeInsert - -▸ `Private` **beforeInsert**(): `undefined` \| `void` - -#### Returns - -`undefined` \| `void` - -#### Defined in - -[models/money-amount.ts:79](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L79) - -___ - -### beforeUpdate - -▸ `Private` **beforeUpdate**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/money-amount.ts:90](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/money-amount.ts#L90) diff --git a/www/apps/docs/content/references/entities/classes/MoneyAmount.mdx b/www/apps/docs/content/references/entities/classes/MoneyAmount.mdx new file mode 100644 index 0000000000..a156dc269f --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/MoneyAmount.mdx @@ -0,0 +1,2341 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# MoneyAmount + +## Properties + + [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list", + "type": "``null`` \\| [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_2", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_3", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "num_code", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentProvider`](PaymentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "required_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOptionValue`](ProductOptionValue.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option", + "type": "[`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`MoneyAmount`](MoneyAmount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list", + "type": "``null`` \\| [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "required_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOptionValue`](ProductOptionValue.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option", + "type": "[`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`MoneyAmount`](MoneyAmount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list", + "type": "``null`` \\| [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Note.md b/www/apps/docs/content/references/entities/classes/Note.md deleted file mode 100644 index 1049ee0fa6..0000000000 --- a/www/apps/docs/content/references/entities/classes/Note.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Note - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`Note`** - -## Constructors - -### constructor - -• **new Note**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### author - -• **author**: [`User`](User.md) - -#### Defined in - -[models/note.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/note.ts#L33) - -___ - -### author\_id - -• **author\_id**: `string` - -#### Defined in - -[models/note.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/note.ts#L29) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/note.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/note.ts#L36) - -___ - -### resource\_id - -• **resource\_id**: `string` - -#### Defined in - -[models/note.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/note.ts#L26) - -___ - -### resource\_type - -• **resource\_type**: `string` - -#### Defined in - -[models/note.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/note.ts#L22) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### value - -• **value**: `string` - -#### Defined in - -[models/note.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/note.ts#L18) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/note.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/note.ts#L39) diff --git a/www/apps/docs/content/references/entities/classes/Note.mdx b/www/apps/docs/content/references/entities/classes/Note.mdx new file mode 100644 index 0000000000..64d3d21cfa --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Note.mdx @@ -0,0 +1,222 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Note + +## Properties + + [`User`](User.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "api_token", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "role", + "type": "[`UserRoles`](../enums/UserRoles.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ADMIN", + "type": "``\"admin\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEVELOPER", + "type": "``\"developer\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "MEMBER", + "type": "``\"member\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "author_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Notification.md b/www/apps/docs/content/references/entities/classes/Notification.md deleted file mode 100644 index cad083e602..0000000000 --- a/www/apps/docs/content/references/entities/classes/Notification.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Notification - -## Hierarchy - -- `BaseEntity` - - ↳ **`Notification`** - -## Constructors - -### constructor - -• **new Notification**() - -#### Inherited from - -BaseEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -BaseEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### customer - -• **customer**: [`Customer`](Customer.md) - -#### Defined in - -[models/notification.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L36) - -___ - -### customer\_id - -• **customer\_id**: ``null`` \| `string` - -#### Defined in - -[models/notification.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L32) - -___ - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/notification.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L42) - -___ - -### event\_name - -• **event\_name**: `string` - -#### Defined in - -[models/notification.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L20) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -BaseEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### parent\_id - -• **parent\_id**: `string` - -#### Defined in - -[models/notification.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L45) - -___ - -### parent\_notification - -• **parent\_notification**: [`Notification`](Notification.md) - -#### Defined in - -[models/notification.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L49) - -___ - -### provider - -• **provider**: `NotificationProvider` - -#### Defined in - -[models/notification.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L59) - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -[models/notification.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L55) - -___ - -### resends - -• **resends**: [`Notification`](Notification.md)[] - -#### Defined in - -[models/notification.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L52) - -___ - -### resource\_id - -• **resource\_id**: `string` - -#### Defined in - -[models/notification.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L28) - -___ - -### resource\_type - -• **resource\_type**: `string` - -#### Defined in - -[models/notification.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L24) - -___ - -### to - -• **to**: `string` - -#### Defined in - -[models/notification.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L39) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -BaseEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/notification.ts:62](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/notification.ts#L62) diff --git a/www/apps/docs/content/references/entities/classes/Notification.mdx b/www/apps/docs/content/references/entities/classes/Notification.mdx new file mode 100644 index 0000000000..3847d087dd --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Notification.mdx @@ -0,0 +1,2265 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Notification + +## Properties + + [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "event_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_notification", + "type": "[`Notification`](Notification.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Notification`](Notification.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "event_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_notification", + "type": "[`Notification`](Notification.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Notification`](Notification.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "event_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_notification", + "type": "[`Notification`](Notification.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "`NotificationProvider`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resends", + "type": "[`Notification`](Notification.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "to", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider", + "type": "`NotificationProvider`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resends", + "type": "[`Notification`](Notification.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Notification`](Notification.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "event_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_notification", + "type": "[`Notification`](Notification.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "`NotificationProvider`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resends", + "type": "[`Notification`](Notification.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "to", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "resource_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "to", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider", + "type": "`NotificationProvider`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resends", + "type": "[`Notification`](Notification.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Notification`](Notification.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "event_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_notification", + "type": "[`Notification`](Notification.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Notification`](Notification.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "event_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_notification", + "type": "[`Notification`](Notification.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "`NotificationProvider`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resends", + "type": "[`Notification`](Notification.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "to", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider", + "type": "`NotificationProvider`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resends", + "type": "[`Notification`](Notification.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Notification`](Notification.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "event_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_notification", + "type": "[`Notification`](Notification.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "`NotificationProvider`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resends", + "type": "[`Notification`](Notification.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "to", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "resource_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "to", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "resource_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "resource_type", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "to", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Oauth.md b/www/apps/docs/content/references/entities/classes/Oauth.md deleted file mode 100644 index 920a7342ea..0000000000 --- a/www/apps/docs/content/references/entities/classes/Oauth.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Oauth - -## Constructors - -### constructor - -• **new Oauth**() - -## Properties - -### application\_name - -• **application\_name**: `string` - -#### Defined in - -[models/oauth.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/oauth.ts#L16) - -___ - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/oauth.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/oauth.ts#L25) - -___ - -### display\_name - -• **display\_name**: `string` - -#### Defined in - -[models/oauth.ts:12](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/oauth.ts#L12) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[models/oauth.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/oauth.ts#L9) - -___ - -### install\_url - -• **install\_url**: `string` - -#### Defined in - -[models/oauth.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/oauth.ts#L19) - -___ - -### uninstall\_url - -• **uninstall\_url**: `string` - -#### Defined in - -[models/oauth.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/oauth.ts#L22) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/oauth.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/oauth.ts#L28) diff --git a/www/apps/docs/content/references/entities/classes/Oauth.mdx b/www/apps/docs/content/references/entities/classes/Oauth.mdx new file mode 100644 index 0000000000..4960cbfe7a --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Oauth.mdx @@ -0,0 +1,60 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Oauth + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "install_url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "uninstall_url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Order.md b/www/apps/docs/content/references/entities/classes/Order.md deleted file mode 100644 index 74e6b26a22..0000000000 --- a/www/apps/docs/content/references/entities/classes/Order.md +++ /dev/null @@ -1,617 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Order - -## Hierarchy - -- `BaseEntity` - - ↳ **`Order`** - -## Constructors - -### constructor - -• **new Order**() - -#### Inherited from - -BaseEntity.constructor - -## Properties - -### billing\_address - -• **billing\_address**: [`Address`](Address.md) - -#### Defined in - -[models/order.ts:117](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L117) - -___ - -### billing\_address\_id - -• **billing\_address\_id**: `string` - -#### Defined in - -[models/order.ts:113](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L113) - -___ - -### canceled\_at - -• **canceled\_at**: `Date` - -#### Defined in - -[models/order.ts:218](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L218) - -___ - -### cart - -• **cart**: [`Cart`](Cart.md) - -#### Defined in - -[models/order.ts:98](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L98) - -___ - -### cart\_id - -• **cart\_id**: `string` - -#### Defined in - -[models/order.ts:94](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L94) - -___ - -### claims - -• **claims**: [`ClaimOrder`](ClaimOrder.md)[] - -#### Defined in - -[models/order.ts:191](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L191) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -BaseEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### currency - -• **currency**: [`Currency`](Currency.md) - -#### Defined in - -[models/order.ts:141](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L141) - -___ - -### currency\_code - -• **currency\_code**: `string` - -#### Defined in - -[models/order.ts:137](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L137) - -___ - -### customer - -• **customer**: [`Customer`](Customer.md) - -#### Defined in - -[models/order.ts:106](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L106) - -___ - -### customer\_id - -• **customer\_id**: `string` - -#### Defined in - -[models/order.ts:102](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L102) - -___ - -### discount\_total - -• **discount\_total**: `number` - -#### Defined in - -[models/order.ts:244](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L244) - -___ - -### discounts - -• **discounts**: [`Discount`](Discount.md)[] - -#### Defined in - -[models/order.ts:158](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L158) - -___ - -### display\_id - -• **display\_id**: `number` - -#### Defined in - -[models/order.ts:90](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L90) - -___ - -### draft\_order - -• **draft\_order**: [`DraftOrder`](DraftOrder.md) - -#### Defined in - -[models/order.ts:204](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L204) - -___ - -### draft\_order\_id - -• **draft\_order\_id**: `string` - -#### Defined in - -[models/order.ts:200](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L200) - -___ - -### edits - -• **edits**: [`OrderEdit`](OrderEdit.md)[] - -#### Defined in - -[models/order.ts:207](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L207) - -___ - -### email - -• **email**: `string` - -#### Defined in - -[models/order.ts:109](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L109) - -___ - -### external\_id - -• **external\_id**: ``null`` \| `string` - -#### Defined in - -[models/order.ts:230](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L230) - -___ - -### fulfillment\_status - -• **fulfillment\_status**: [`FulfillmentStatus`](../enums/FulfillmentStatus.md) - -#### Defined in - -[models/order.ts:82](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L82) - -___ - -### fulfillments - -• **fulfillments**: [`Fulfillment`](Fulfillment.md)[] - -#### Defined in - -[models/order.ts:185](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L185) - -___ - -### gift\_card\_tax\_total - -• **gift\_card\_tax\_total**: `number` - -#### Defined in - -[models/order.ts:254](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L254) - -___ - -### gift\_card\_total - -• **gift\_card\_total**: `number` - -#### Defined in - -[models/order.ts:253](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L253) - -___ - -### gift\_card\_transactions - -• **gift\_card\_transactions**: [`GiftCardTransaction`](GiftCardTransaction.md)[] - -#### Defined in - -[models/order.ts:215](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L215) - -___ - -### gift\_cards - -• **gift\_cards**: [`GiftCard`](GiftCard.md)[] - -#### Defined in - -[models/order.ts:172](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L172) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -BaseEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -[models/order.ts:227](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L227) - -___ - -### item\_tax\_total - -• **item\_tax\_total**: ``null`` \| `number` - -#### Defined in - -[models/order.ts:246](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L246) - -___ - -### items - -• **items**: [`LineItem`](LineItem.md)[] - -#### Defined in - -[models/order.ts:212](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L212) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/order.ts:221](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L221) - -___ - -### no\_notification - -• **no\_notification**: `boolean` - -#### Defined in - -[models/order.ts:224](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L224) - -___ - -### object - -• `Readonly` **object**: ``"order"`` - -#### Defined in - -[models/order.ts:72](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L72) - -___ - -### paid\_total - -• **paid\_total**: `number` - -#### Defined in - -[models/order.ts:251](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L251) - -___ - -### payment\_status - -• **payment\_status**: [`PaymentStatus`](../enums/PaymentStatus.md) - -#### Defined in - -[models/order.ts:85](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L85) - -___ - -### payments - -• **payments**: [`Payment`](Payment.md)[] - -#### Defined in - -[models/order.ts:180](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L180) - -___ - -### raw\_discount\_total - -• **raw\_discount\_total**: `number` - -#### Defined in - -[models/order.ts:245](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L245) - -___ - -### refundable\_amount - -• **refundable\_amount**: `number` - -#### Defined in - -[models/order.ts:252](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L252) - -___ - -### refunded\_total - -• **refunded\_total**: `number` - -#### Defined in - -[models/order.ts:248](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L248) - -___ - -### refunds - -• **refunds**: [`Refund`](Refund.md)[] - -#### Defined in - -[models/order.ts:194](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L194) - -___ - -### region - -• **region**: [`Region`](Region.md) - -#### Defined in - -[models/order.ts:133](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L133) - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -[models/order.ts:129](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L129) - -___ - -### returnable\_items - -• `Optional` **returnable\_items**: [`LineItem`](LineItem.md)[] - -#### Defined in - -[models/order.ts:256](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L256) - -___ - -### returns - -• **returns**: [`Return`](Return.md)[] - -#### Defined in - -[models/order.ts:188](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L188) - -___ - -### sales\_channel - -• **sales\_channel**: [`SalesChannel`](SalesChannel.md) - -#### Defined in - -[models/order.ts:239](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L239) - -___ - -### sales\_channel\_id - -• **sales\_channel\_id**: ``null`` \| `string` - -#### Defined in - -[models/order.ts:233](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L233) - -___ - -### shipping\_address - -• **shipping\_address**: [`Address`](Address.md) - -#### Defined in - -[models/order.ts:125](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L125) - -___ - -### shipping\_address\_id - -• **shipping\_address\_id**: `string` - -#### Defined in - -[models/order.ts:121](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L121) - -___ - -### shipping\_methods - -• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[] - -#### Defined in - -[models/order.ts:177](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L177) - -___ - -### shipping\_tax\_total - -• **shipping\_tax\_total**: ``null`` \| `number` - -#### Defined in - -[models/order.ts:243](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L243) - -___ - -### shipping\_total - -• **shipping\_total**: `number` - -#### Defined in - -[models/order.ts:242](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L242) - -___ - -### status - -• **status**: [`OrderStatus`](../enums/OrderStatus.md) - -#### Defined in - -[models/order.ts:75](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L75) - -___ - -### subtotal - -• **subtotal**: `number` - -#### Defined in - -[models/order.ts:250](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L250) - -___ - -### swaps - -• **swaps**: [`Swap`](Swap.md)[] - -#### Defined in - -[models/order.ts:197](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L197) - -___ - -### tax\_rate - -• **tax\_rate**: ``null`` \| `number` - -#### Defined in - -[models/order.ts:144](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L144) - -___ - -### tax\_total - -• **tax\_total**: ``null`` \| `number` - -#### Defined in - -[models/order.ts:247](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L247) - -___ - -### total - -• **total**: `number` - -#### Defined in - -[models/order.ts:249](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L249) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -BaseEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `Promise`<`void`\> - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[models/order.ts:259](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L259) diff --git a/www/apps/docs/content/references/entities/classes/Order.mdx b/www/apps/docs/content/references/entities/classes/Order.mdx new file mode 100644 index 0000000000..90ea9f4dd7 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Order.mdx @@ -0,0 +1,23963 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Order + +## Properties + + [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_initiated", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_selected", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CLAIM", + "type": "``\"claim\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEFAULT", + "type": "``\"default\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DRAFT_ORDER", + "type": "``\"draft_order\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PAYMENT_LINK", + "type": "``\"payment_link\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SWAP", + "type": "``\"swap\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimItem`](ClaimItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`ClaimImage`](ClaimImage.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ClaimReason`](../enums/ClaimReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ClaimTag`](ClaimTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "NA", + "type": "``\"na\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_REFUNDED", + "type": "``\"not_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "REFUND", + "type": "``\"refund\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REPLACE", + "type": "``\"replace\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allocation", + "type": "[`AllocationType`](../enums/AllocationType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "conditions", + "type": "[`DiscountCondition`](DiscountCondition.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`DiscountRuleType`](../enums/DiscountRuleType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "OPEN", + "type": "``\"open\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderItemChange`](OrderItemChange.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "line_item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "line_item_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "[`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_line_item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_line_item_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`OrderEditItemChangeType`](../enums/OrderEditItemChangeType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "authorized_amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`PaymentCollectionStatus`](../enums/PaymentCollectionStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ORDER_EDIT`](../enums/PaymentCollectionType.mdx#order_edit)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CONFIRMED", + "type": "``\"confirmed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CREATED", + "type": "``\"created\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DECLINED", + "type": "``\"declined\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUESTED", + "type": "``\"requested\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentItem`](FulfillmentItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment", + "type": "[`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TrackingLink`](TrackingLink.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment", + "type": "[`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_number", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card", + "type": "[`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemAdjustment`](LineItemAdjustment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemTaxLine`](LineItemTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Refund`](Refund.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_2", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_3", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "num_code", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentProvider`](PaymentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemAdjustment`](LineItemAdjustment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemTaxLine`](LineItemTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ReturnItem`](ReturnItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_requested", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RECEIVED", + "type": "``\"received\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUESTED", + "type": "``\"requested\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannelLocation`](SalesChannelLocation.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ARCHIVED", + "type": "``\"archived\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CONFIRMED", + "type": "``\"confirmed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DIFFERENCE_REFUNDED", + "type": "``\"difference_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/OrderEdit.md b/www/apps/docs/content/references/entities/classes/OrderEdit.md deleted file mode 100644 index afb33df3ae..0000000000 --- a/www/apps/docs/content/references/entities/classes/OrderEdit.md +++ /dev/null @@ -1,351 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: OrderEdit - -## Hierarchy - -- `BaseEntity` - - ↳ **`OrderEdit`** - -## Constructors - -### constructor - -• **new OrderEdit**() - -#### Inherited from - -BaseEntity.constructor - -## Properties - -### canceled\_at - -• `Optional` **canceled\_at**: `Date` - -#### Defined in - -[models/order-edit.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L73) - -___ - -### canceled\_by - -• `Optional` **canceled\_by**: `string` - -#### Defined in - -[models/order-edit.ts:70](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L70) - -___ - -### changes - -• **changes**: [`OrderItemChange`](OrderItemChange.md)[] - -#### Defined in - -[models/order-edit.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L40) - -___ - -### confirmed\_at - -• `Optional` **confirmed\_at**: `Date` - -#### Defined in - -[models/order-edit.ts:58](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L58) - -___ - -### confirmed\_by - -• `Optional` **confirmed\_by**: `string` - -#### Defined in - -[models/order-edit.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L55) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -BaseEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### created\_by - -• **created\_by**: `string` - -#### Defined in - -[models/order-edit.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L46) - -___ - -### declined\_at - -• `Optional` **declined\_at**: `Date` - -#### Defined in - -[models/order-edit.ts:67](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L67) - -___ - -### declined\_by - -• `Optional` **declined\_by**: `string` - -#### Defined in - -[models/order-edit.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L61) - -___ - -### declined\_reason - -• `Optional` **declined\_reason**: `string` - -#### Defined in - -[models/order-edit.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L64) - -___ - -### difference\_due - -• **difference\_due**: `number` - -#### Defined in - -[models/order-edit.ts:95](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L95) - -___ - -### discount\_total - -• **discount\_total**: `number` - -#### Defined in - -[models/order-edit.ts:88](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L88) - -___ - -### gift\_card\_tax\_total - -• **gift\_card\_tax\_total**: `number` - -#### Defined in - -[models/order-edit.ts:93](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L93) - -___ - -### gift\_card\_total - -• **gift\_card\_total**: `number` - -#### Defined in - -[models/order-edit.ts:92](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L92) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -BaseEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### internal\_note - -• `Optional` **internal\_note**: `string` - -#### Defined in - -[models/order-edit.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L43) - -___ - -### items - -• **items**: [`LineItem`](LineItem.md)[] - -#### Defined in - -[models/order-edit.ts:76](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L76) - -___ - -### order - -• **order**: [`Order`](Order.md) - -#### Defined in - -[models/order-edit.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L35) - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -[models/order-edit.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L31) - -___ - -### payment\_collection - -• **payment\_collection**: [`PaymentCollection`](PaymentCollection.md) - -#### Defined in - -[models/order-edit.ts:84](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L84) - -___ - -### payment\_collection\_id - -• **payment\_collection\_id**: `string` - -#### Defined in - -[models/order-edit.ts:80](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L80) - -___ - -### requested\_at - -• `Optional` **requested\_at**: `Date` - -#### Defined in - -[models/order-edit.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L52) - -___ - -### requested\_by - -• `Optional` **requested\_by**: `string` - -#### Defined in - -[models/order-edit.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L49) - -___ - -### shipping\_total - -• **shipping\_total**: `number` - -#### Defined in - -[models/order-edit.ts:87](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L87) - -___ - -### status - -• **status**: [`OrderEditStatus`](../enums/OrderEditStatus.md) - -#### Defined in - -[models/order-edit.ts:97](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L97) - -___ - -### subtotal - -• **subtotal**: `number` - -#### Defined in - -[models/order-edit.ts:91](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L91) - -___ - -### tax\_total - -• **tax\_total**: ``null`` \| `number` - -#### Defined in - -[models/order-edit.ts:89](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L89) - -___ - -### total - -• **total**: `number` - -#### Defined in - -[models/order-edit.ts:90](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L90) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -BaseEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/order-edit.ts:100](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L100) - -___ - -### loadStatus - -▸ **loadStatus**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/order-edit.ts:105](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L105) diff --git a/www/apps/docs/content/references/entities/classes/OrderEdit.mdx b/www/apps/docs/content/references/entities/classes/OrderEdit.mdx new file mode 100644 index 0000000000..da057d79b5 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/OrderEdit.mdx @@ -0,0 +1,8657 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderEdit + +## Properties + + [`OrderItemChange`](OrderItemChange.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "line_item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "line_item_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "[`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_line_item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "original_line_item_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`OrderEditItemChangeType`](../enums/OrderEditItemChangeType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ITEM_ADD", + "type": "``\"item_add\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "ITEM_REMOVE", + "type": "``\"item_remove\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "ITEM_UPDATE", + "type": "``\"item_update\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemAdjustment`](LineItemAdjustment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemTaxLine`](LineItemTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card", + "type": "[`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Refund`](Refund.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ARCHIVED", + "type": "``\"archived\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "authorized_amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_initiated", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_selected", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`PaymentCollectionStatus`](../enums/PaymentCollectionStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AUTHORIZED", + "type": "``\"authorized\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_AUTHORIZED", + "type": "``\"partially_authorized\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`ORDER_EDIT`](../enums/PaymentCollectionType.mdx#order_edit)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CONFIRMED", + "type": "``\"confirmed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CREATED", + "type": "``\"created\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DECLINED", + "type": "``\"declined\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUESTED", + "type": "``\"requested\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/OrderItemChange.md b/www/apps/docs/content/references/entities/classes/OrderItemChange.md deleted file mode 100644 index fa685cc573..0000000000 --- a/www/apps/docs/content/references/entities/classes/OrderItemChange.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: OrderItemChange - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`OrderItemChange`** - -## Constructors - -### constructor - -• **new OrderItemChange**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### line\_item - -• `Optional` **line\_item**: [`LineItem`](LineItem.md) - -#### Defined in - -[models/order-item-change.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L52) - -___ - -### line\_item\_id - -• `Optional` **line\_item\_id**: `string` - -#### Defined in - -[models/order-item-change.ts:48](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L48) - -___ - -### order\_edit - -• **order\_edit**: [`OrderEdit`](OrderEdit.md) - -#### Defined in - -[models/order-item-change.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L38) - -___ - -### order\_edit\_id - -• **order\_edit\_id**: `string` - -#### Defined in - -[models/order-item-change.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L34) - -___ - -### original\_line\_item - -• `Optional` **original\_line\_item**: [`LineItem`](LineItem.md) - -#### Defined in - -[models/order-item-change.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L45) - -___ - -### original\_line\_item\_id - -• `Optional` **original\_line\_item\_id**: `string` - -#### Defined in - -[models/order-item-change.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L41) - -___ - -### type - -• **type**: [`OrderEditItemChangeType`](../enums/OrderEditItemChangeType.md) - -#### Defined in - -[models/order-item-change.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L31) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/order-item-change.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L55) diff --git a/www/apps/docs/content/references/entities/classes/OrderItemChange.mdx b/www/apps/docs/content/references/entities/classes/OrderItemChange.mdx new file mode 100644 index 0000000000..4699427c9e --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/OrderItemChange.mdx @@ -0,0 +1,5563 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderItemChange + +## Properties + + [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemAdjustment`](LineItemAdjustment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemTaxLine`](LineItemTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "line_item_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "[`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderItemChange`](OrderItemChange.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "line_item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "line_item_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "[`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_line_item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_line_item_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`OrderEditItemChangeType`](../enums/OrderEditItemChangeType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "authorized_amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`PaymentCollectionStatus`](../enums/PaymentCollectionStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ORDER_EDIT`](../enums/PaymentCollectionType.mdx#order_edit)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CONFIRMED", + "type": "``\"confirmed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CREATED", + "type": "``\"created\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DECLINED", + "type": "``\"declined\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUESTED", + "type": "``\"requested\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_line_item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemAdjustment`](LineItemAdjustment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemTaxLine`](LineItemTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "original_line_item_id", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`OrderEditItemChangeType`](../enums/OrderEditItemChangeType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ITEM_ADD", + "type": "``\"item_add\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "ITEM_REMOVE", + "type": "``\"item_remove\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "ITEM_UPDATE", + "type": "``\"item_update\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Payment.md b/www/apps/docs/content/references/entities/classes/Payment.md deleted file mode 100644 index f83e50dbe8..0000000000 --- a/www/apps/docs/content/references/entities/classes/Payment.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Payment - -## Hierarchy - -- `BaseEntity` - - ↳ **`Payment`** - -## Constructors - -### constructor - -• **new Payment**() - -#### Inherited from - -BaseEntity.constructor - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -[models/payment.ts:51](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L51) - -___ - -### amount\_refunded - -• **amount\_refunded**: `number` - -#### Defined in - -[models/payment.ts:62](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L62) - -___ - -### canceled\_at - -• **canceled\_at**: `string` \| `Date` - -#### Defined in - -[models/payment.ts:75](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L75) - -___ - -### captured\_at - -• **captured\_at**: `string` \| `Date` - -#### Defined in - -[models/payment.ts:72](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L72) - -___ - -### cart - -• **cart**: [`Cart`](Cart.md) - -#### Defined in - -[models/payment.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L40) - -___ - -### cart\_id - -• **cart\_id**: `string` - -#### Defined in - -[models/payment.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L36) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -BaseEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### currency - -• **currency**: [`Currency`](Currency.md) - -#### Defined in - -[models/payment.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L59) - -___ - -### currency\_code - -• **currency\_code**: `string` - -#### Defined in - -[models/payment.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L55) - -___ - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/payment.ts:69](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L69) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -BaseEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -[models/payment.ts:81](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L81) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/payment.ts:78](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L78) - -___ - -### order - -• **order**: [`Order`](Order.md) - -#### Defined in - -[models/payment.ts:48](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L48) - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -[models/payment.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L44) - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -[models/payment.ts:66](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L66) - -___ - -### swap - -• **swap**: [`Swap`](Swap.md) - -#### Defined in - -[models/payment.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L32) - -___ - -### swap\_id - -• **swap\_id**: `string` - -#### Defined in - -[models/payment.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L28) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -BaseEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/payment.ts:84](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment.ts#L84) diff --git a/www/apps/docs/content/references/entities/classes/Payment.mdx b/www/apps/docs/content/references/entities/classes/Payment.mdx new file mode 100644 index 0000000000..ade650063d --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Payment.mdx @@ -0,0 +1,9237 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Payment + +## Properties + + [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_initiated", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_selected", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CLAIM", + "type": "``\"claim\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEFAULT", + "type": "``\"default\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DRAFT_ORDER", + "type": "``\"draft_order\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PAYMENT_LINK", + "type": "``\"payment_link\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SWAP", + "type": "``\"swap\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card", + "type": "[`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Refund`](Refund.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ARCHIVED", + "type": "``\"archived\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CONFIRMED", + "type": "``\"confirmed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DIFFERENCE_REFUNDED", + "type": "``\"difference_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/PaymentCollection.md b/www/apps/docs/content/references/entities/classes/PaymentCollection.md deleted file mode 100644 index 2bc902c8e9..0000000000 --- a/www/apps/docs/content/references/entities/classes/PaymentCollection.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: PaymentCollection - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`PaymentCollection`** - -## Constructors - -### constructor - -• **new PaymentCollection**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -[models/payment-collection.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L41) - -___ - -### authorized\_amount - -• **authorized\_amount**: ``null`` \| `number` - -#### Defined in - -[models/payment-collection.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L44) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### created\_by - -• **created\_by**: `string` - -#### Defined in - -[models/payment-collection.ts:94](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L94) - -___ - -### currency - -• **currency**: [`Currency`](Currency.md) - -#### Defined in - -[models/payment-collection.ts:60](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L60) - -___ - -### currency\_code - -• **currency\_code**: `string` - -#### Defined in - -[models/payment-collection.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L56) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### description - -• **description**: ``null`` \| `string` - -#### Defined in - -[models/payment-collection.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L38) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/payment-collection.ts:91](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L91) - -___ - -### payment\_sessions - -• **payment\_sessions**: [`PaymentSession`](PaymentSession.md)[] - -#### Defined in - -[models/payment-collection.ts:74](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L74) - -___ - -### payments - -• **payments**: [`Payment`](Payment.md)[] - -#### Defined in - -[models/payment-collection.ts:88](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L88) - -___ - -### region - -• **region**: [`Region`](Region.md) - -#### Defined in - -[models/payment-collection.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L52) - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -[models/payment-collection.ts:48](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L48) - -___ - -### status - -• **status**: [`PaymentCollectionStatus`](../enums/PaymentCollectionStatus.md) - -#### Defined in - -[models/payment-collection.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L35) - -___ - -### type - -• **type**: [`ORDER_EDIT`](../enums/PaymentCollectionType.md#order_edit) - -#### Defined in - -[models/payment-collection.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L32) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/payment-collection.ts:97](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L97) diff --git a/www/apps/docs/content/references/entities/classes/PaymentCollection.mdx b/www/apps/docs/content/references/entities/classes/PaymentCollection.mdx new file mode 100644 index 0000000000..36829c1d2f --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/PaymentCollection.mdx @@ -0,0 +1,2347 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentCollection + +## Properties + + [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_initiated", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_selected", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_2", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_3", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "num_code", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentProvider`](PaymentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`PaymentCollectionStatus`](../enums/PaymentCollectionStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AUTHORIZED", + "type": "``\"authorized\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_AUTHORIZED", + "type": "``\"partially_authorized\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`ORDER_EDIT`](../enums/PaymentCollectionType.mdx#order_edit)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/PaymentProvider.md b/www/apps/docs/content/references/entities/classes/PaymentProvider.md deleted file mode 100644 index 609bd48007..0000000000 --- a/www/apps/docs/content/references/entities/classes/PaymentProvider.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: PaymentProvider - -## Constructors - -### constructor - -• **new PaymentProvider**() - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -[models/payment-provider.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-provider.ts#L6) - -___ - -### is\_installed - -• **is\_installed**: `boolean` - -#### Defined in - -[models/payment-provider.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-provider.ts#L9) diff --git a/www/apps/docs/content/references/entities/classes/PaymentProvider.mdx b/www/apps/docs/content/references/entities/classes/PaymentProvider.mdx new file mode 100644 index 0000000000..8345ed321e --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/PaymentProvider.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentProvider + +## Properties + + diff --git a/www/apps/docs/content/references/entities/classes/PaymentSession.md b/www/apps/docs/content/references/entities/classes/PaymentSession.md deleted file mode 100644 index 7f778b6bfe..0000000000 --- a/www/apps/docs/content/references/entities/classes/PaymentSession.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: PaymentSession - -## Hierarchy - -- `BaseEntity` - - ↳ **`PaymentSession`** - -## Constructors - -### constructor - -• **new PaymentSession**() - -#### Inherited from - -BaseEntity.constructor - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -[models/payment-session.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L59) - -___ - -### cart - -• **cart**: [`Cart`](Cart.md) - -#### Defined in - -[models/payment-session.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L37) - -___ - -### cart\_id - -• **cart\_id**: ``null`` \| `string` - -#### Defined in - -[models/payment-session.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L33) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -BaseEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/payment-session.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L53) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -BaseEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -[models/payment-session.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L56) - -___ - -### is\_initiated - -• **is\_initiated**: `boolean` - -#### Defined in - -[models/payment-session.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L47) - -___ - -### is\_selected - -• **is\_selected**: ``null`` \| `boolean` - -#### Defined in - -[models/payment-session.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L44) - -___ - -### payment\_authorized\_at - -• **payment\_authorized\_at**: `Date` - -#### Defined in - -[models/payment-session.ts:62](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L62) - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -[models/payment-session.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L41) - -___ - -### status - -• **status**: `string` - -#### Defined in - -[models/payment-session.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L50) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -BaseEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/payment-session.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L65) diff --git a/www/apps/docs/content/references/entities/classes/PaymentSession.mdx b/www/apps/docs/content/references/entities/classes/PaymentSession.mdx new file mode 100644 index 0000000000..ab895cb242 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/PaymentSession.mdx @@ -0,0 +1,2224 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentSession + +## Properties + + [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_initiated", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_selected", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CLAIM", + "type": "``\"claim\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEFAULT", + "type": "``\"default\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DRAFT_ORDER", + "type": "``\"draft_order\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PAYMENT_LINK", + "type": "``\"payment_link\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SWAP", + "type": "``\"swap\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_initiated", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_selected", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/PriceList.md b/www/apps/docs/content/references/entities/classes/PriceList.md deleted file mode 100644 index 5cc5d43ab7..0000000000 --- a/www/apps/docs/content/references/entities/classes/PriceList.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: PriceList - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`PriceList`** - -## Constructors - -### constructor - -• **new PriceList**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### customer\_groups - -• **customer\_groups**: [`CustomerGroup`](CustomerGroup.md)[] - -#### Defined in - -[models/price-list.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L56) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### description - -• **description**: `string` - -#### Defined in - -[models/price-list.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L25) - -___ - -### ends\_at - -• **ends\_at**: ``null`` \| `Date` - -#### Defined in - -[models/price-list.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L40) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### includes\_tax - -• **includes\_tax**: `boolean` - -#### Defined in - -[models/price-list.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L64) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[models/price-list.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L22) - -___ - -### prices - -• **prices**: [`MoneyAmount`](MoneyAmount.md)[] - -#### Defined in - -[models/price-list.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L61) - -___ - -### starts\_at - -• **starts\_at**: ``null`` \| `Date` - -#### Defined in - -[models/price-list.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L37) - -___ - -### status - -• **status**: `PriceListStatus` - -#### Defined in - -[models/price-list.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L31) - -___ - -### type - -• **type**: `PriceListType` - -#### Defined in - -[models/price-list.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L28) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `undefined` \| `void` - -#### Returns - -`undefined` \| `void` - -#### Defined in - -[models/price-list.ts:67](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/price-list.ts#L67) diff --git a/www/apps/docs/content/references/entities/classes/PriceList.mdx b/www/apps/docs/content/references/entities/classes/PriceList.mdx new file mode 100644 index 0000000000..09dd328285 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/PriceList.mdx @@ -0,0 +1,1324 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PriceList + +## Properties + + [`CustomerGroup`](CustomerGroup.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customers", + "type": "[`Customer`](Customer.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_lists", + "type": "[`PriceList`](PriceList.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`PriceListStatus`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "`PriceListType`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`MoneyAmount`](MoneyAmount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list", + "type": "``null`` \\| [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "starts_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`PriceListStatus`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "`PriceListType`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Product.md b/www/apps/docs/content/references/entities/classes/Product.md deleted file mode 100644 index 26e8d3269b..0000000000 --- a/www/apps/docs/content/references/entities/classes/Product.md +++ /dev/null @@ -1,429 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Product - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`Product`** - -## Constructors - -### constructor - -• **new Product**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### categories - -• **categories**: [`ProductCategory`](ProductCategory.md)[] - -#### Defined in - -[models/product.ts:95](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L95) - -___ - -### collection - -• **collection**: [`ProductCollection`](ProductCollection.md) - -#### Defined in - -[models/product.ts:146](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L146) - -___ - -### collection\_id - -• **collection\_id**: ``null`` \| `string` - -#### Defined in - -[models/product.ts:142](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L142) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### description - -• **description**: ``null`` \| `string` - -#### Defined in - -[models/product.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L46) - -___ - -### discountable - -• **discountable**: `boolean` - -#### Defined in - -[models/product.ts:170](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L170) - -___ - -### external\_id - -• **external\_id**: ``null`` \| `string` - -#### Defined in - -[models/product.ts:173](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L173) - -___ - -### handle - -• **handle**: ``null`` \| `string` - -#### Defined in - -[models/product.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L50) - -___ - -### height - -• **height**: ``null`` \| `number` - -#### Defined in - -[models/product.ts:124](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L124) - -___ - -### hs\_code - -• **hs\_code**: ``null`` \| `string` - -#### Defined in - -[models/product.ts:130](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L130) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### images - -• **images**: [`Image`](Image.md)[] - -#### Defined in - -[models/product.ts:70](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L70) - -___ - -### is\_giftcard - -• **is\_giftcard**: `boolean` - -#### Defined in - -[models/product.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L53) - -___ - -### length - -• **length**: ``null`` \| `number` - -#### Defined in - -[models/product.ts:121](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L121) - -___ - -### material - -• **material**: ``null`` \| `string` - -#### Defined in - -[models/product.ts:139](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L139) - -___ - -### metadata - -• **metadata**: ``null`` \| `Record`<`string`, `unknown`\> - -#### Defined in - -[models/product.ts:176](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L176) - -___ - -### mid\_code - -• **mid\_code**: ``null`` \| `string` - -#### Defined in - -[models/product.ts:136](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L136) - -___ - -### options - -• **options**: [`ProductOption`](ProductOption.md)[] - -#### Defined in - -[models/product.ts:76](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L76) - -___ - -### origin\_country - -• **origin\_country**: ``null`` \| `string` - -#### Defined in - -[models/product.ts:133](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L133) - -___ - -### profile - -• **profile**: [`ShippingProfile`](ShippingProfile.md) - -#### Defined in - -[models/product.ts:99](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L99) - -___ - -### profile\_id - -• **profile\_id**: `string` - -#### Defined in - -[models/product.ts:97](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L97) - -___ - -### profiles - -• **profiles**: [`ShippingProfile`](ShippingProfile.md)[] - -#### Defined in - -[models/product.ts:115](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L115) - -___ - -### sales\_channels - -• **sales\_channels**: [`SalesChannel`](SalesChannel.md)[] - -#### Defined in - -[models/product.ts:192](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L192) - -___ - -### status - -• **status**: [`ProductStatus`](../enums/ProductStatus.md) - -#### Defined in - -[models/product.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L56) - -___ - -### subtitle - -• **subtitle**: ``null`` \| `string` - -#### Defined in - -[models/product.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L43) - -___ - -### tags - -• **tags**: [`ProductTag`](ProductTag.md)[] - -#### Defined in - -[models/product.ts:167](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L167) - -___ - -### thumbnail - -• **thumbnail**: ``null`` \| `string` - -#### Defined in - -[models/product.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L73) - -___ - -### title - -• **title**: `string` - -#### Defined in - -[models/product.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L40) - -___ - -### type - -• **type**: [`ProductType`](ProductType.md) - -#### Defined in - -[models/product.ts:153](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L153) - -___ - -### type\_id - -• **type\_id**: ``null`` \| `string` - -#### Defined in - -[models/product.ts:149](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L149) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### variants - -• **variants**: [`ProductVariant`](ProductVariant.md)[] - -#### Defined in - -[models/product.ts:81](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L81) - -___ - -### weight - -• **weight**: ``null`` \| `number` - -#### Defined in - -[models/product.ts:118](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L118) - -___ - -### width - -• **width**: ``null`` \| `number` - -#### Defined in - -[models/product.ts:127](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L127) - -## Methods - -### afterLoad - -▸ `Private` **afterLoad**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/product.ts:215](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L215) - -___ - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/product.ts:195](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L195) - -___ - -### beforeUpdate - -▸ `Private` **beforeUpdate**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/product.ts:208](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L208) diff --git a/www/apps/docs/content/references/entities/classes/Product.mdx b/www/apps/docs/content/references/entities/classes/Product.mdx new file mode 100644 index 0000000000..61827905c8 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Product.mdx @@ -0,0 +1,4247 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Product + +## Properties + + [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "category_children", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "category_children", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_active", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_internal", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category", + "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rank", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryProductJoinTable", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "`\"product_category_product\"`", + "children": [] + }, + { + "name": "treeRelations", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_active", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_internal", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category", + "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rank", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryProductJoinTable", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "`\"product_category_product\"`", + "children": [] + }, + { + "name": "treeRelations", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Image`](Image.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOptionValue`](ProductOptionValue.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option", + "type": "[`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CUSTOM", + "type": "``\"custom\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEFAULT", + "type": "``\"default\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "GIFT_CARD", + "type": "``\"gift_card\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CUSTOM", + "type": "``\"custom\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEFAULT", + "type": "``\"default\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "GIFT_CARD", + "type": "``\"gift_card\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannelLocation`](SalesChannelLocation.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "DRAFT", + "type": "``\"draft\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PROPOSED", + "type": "``\"proposed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PUBLISHED", + "type": "``\"published\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REJECTED", + "type": "``\"rejected\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "required_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOptionValue`](ProductOptionValue.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option", + "type": "[`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`MoneyAmount`](MoneyAmount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list", + "type": "``null`` \\| [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ProductCategory.md b/www/apps/docs/content/references/entities/classes/ProductCategory.md deleted file mode 100644 index a0d0845675..0000000000 --- a/www/apps/docs/content/references/entities/classes/ProductCategory.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ProductCategory - -## Hierarchy - -- `BaseEntity` - - ↳ **`ProductCategory`** - -## Constructors - -### constructor - -• **new ProductCategory**() - -#### Inherited from - -BaseEntity.constructor - -## Properties - -### category\_children - -• **category\_children**: [`ProductCategory`](ProductCategory.md)[] - -#### Defined in - -[models/product-category.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L56) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -BaseEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### description - -• **description**: `string` - -#### Defined in - -[models/product-category.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L29) - -___ - -### handle - -• **handle**: `string` - -#### Defined in - -[models/product-category.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L33) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -BaseEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### is\_active - -• **is\_active**: `Boolean` - -#### Defined in - -[models/product-category.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L36) - -___ - -### is\_internal - -• **is\_internal**: `Boolean` - -#### Defined in - -[models/product-category.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L39) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[models/product-category.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L26) - -___ - -### parent\_category - -• **parent\_category**: ``null`` \| [`ProductCategory`](ProductCategory.md) - -#### Defined in - -[models/product-category.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L49) - -___ - -### parent\_category\_id - -• **parent\_category\_id**: ``null`` \| `string` - -#### Defined in - -[models/product-category.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L53) - -___ - -### products - -• **products**: [`Product`](Product.md)[] - -#### Defined in - -[models/product-category.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L73) - -___ - -### rank - -• **rank**: `number` - -#### Defined in - -[models/product-category.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L59) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -BaseEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### productCategoryProductJoinTable - -▪ `Static` **productCategoryProductJoinTable**: `string` = `"product_category_product"` - -#### Defined in - -[models/product-category.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L22) - -___ - -### treeRelations - -▪ `Static` **treeRelations**: `string`[] - -#### Defined in - -[models/product-category.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L23) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/product-category.ts:76](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-category.ts#L76) diff --git a/www/apps/docs/content/references/entities/classes/ProductCategory.mdx b/www/apps/docs/content/references/entities/classes/ProductCategory.mdx new file mode 100644 index 0000000000..8269efe298 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ProductCategory.mdx @@ -0,0 +1,2075 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductCategory + +## Properties + + [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "category_children", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "category_children", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_active", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_internal", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category", + "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rank", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryProductJoinTable", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "`\"product_category_product\"`", + "children": [] + }, + { + "name": "treeRelations", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_active", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_internal", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category", + "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rank", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryProductJoinTable", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "`\"product_category_product\"`", + "children": [] + }, + { + "name": "treeRelations", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_active", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_internal", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category", + "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "category_children", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_active", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_internal", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category", + "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rank", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryProductJoinTable", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "`\"product_category_product\"`", + "children": [] + }, + { + "name": "treeRelations", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Image`](Image.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "DRAFT", + "type": "``\"draft\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PROPOSED", + "type": "``\"proposed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PUBLISHED", + "type": "``\"published\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REJECTED", + "type": "``\"rejected\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rank", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryProductJoinTable", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "`\"product_category_product\"`", + "children": [] + }, + { + "name": "treeRelations", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ProductCollection.md b/www/apps/docs/content/references/entities/classes/ProductCollection.md deleted file mode 100644 index e9f77bd3e6..0000000000 --- a/www/apps/docs/content/references/entities/classes/ProductCollection.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ProductCollection - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ProductCollection`** - -## Constructors - -### constructor - -• **new ProductCollection**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### handle - -• **handle**: `string` - -#### Defined in - -[models/product-collection.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-collection.ts#L16) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/product-collection.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-collection.ts#L22) - -___ - -### products - -• **products**: [`Product`](Product.md)[] - -#### Defined in - -[models/product-collection.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-collection.ts#L19) - -___ - -### title - -• **title**: `string` - -#### Defined in - -[models/product-collection.ts:12](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-collection.ts#L12) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### createHandleIfNotProvided - -▸ `Private` **createHandleIfNotProvided**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/product-collection.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-collection.ts#L25) diff --git a/www/apps/docs/content/references/entities/classes/ProductCollection.mdx b/www/apps/docs/content/references/entities/classes/ProductCollection.mdx new file mode 100644 index 0000000000..26e695dfc7 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ProductCollection.mdx @@ -0,0 +1,1432 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductCollection + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "category_children", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_active", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_internal", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category", + "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rank", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryProductJoinTable", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "`\"product_category_product\"`", + "children": [] + }, + { + "name": "treeRelations", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Image`](Image.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "DRAFT", + "type": "``\"draft\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PROPOSED", + "type": "``\"proposed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PUBLISHED", + "type": "``\"published\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REJECTED", + "type": "``\"rejected\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ProductOption.md b/www/apps/docs/content/references/entities/classes/ProductOption.md deleted file mode 100644 index 2560f17b46..0000000000 --- a/www/apps/docs/content/references/entities/classes/ProductOption.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ProductOption - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ProductOption`** - -## Constructors - -### constructor - -• **new ProductOption**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/product-option.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option.ts#L34) - -___ - -### product - -• **product**: [`Product`](Product.md) - -#### Defined in - -[models/product-option.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option.ts#L31) - -___ - -### product\_id - -• **product\_id**: `string` - -#### Defined in - -[models/product-option.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option.ts#L27) - -___ - -### title - -• **title**: `string` - -#### Defined in - -[models/product-option.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option.ts#L19) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### values - -• **values**: [`ProductOptionValue`](ProductOptionValue.md)[] - -#### Defined in - -[models/product-option.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option.ts#L24) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/product-option.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option.ts#L37) diff --git a/www/apps/docs/content/references/entities/classes/ProductOption.mdx b/www/apps/docs/content/references/entities/classes/ProductOption.mdx new file mode 100644 index 0000000000..5818dfd699 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ProductOption.mdx @@ -0,0 +1,1867 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductOption + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "category_children", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_active", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_internal", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category", + "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rank", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryProductJoinTable", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "`\"product_category_product\"`", + "children": [] + }, + { + "name": "treeRelations", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Image`](Image.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "DRAFT", + "type": "``\"draft\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PROPOSED", + "type": "``\"proposed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PUBLISHED", + "type": "``\"published\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REJECTED", + "type": "``\"rejected\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOptionValue`](ProductOptionValue.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option", + "type": "[`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ProductOptionValue.md b/www/apps/docs/content/references/entities/classes/ProductOptionValue.md deleted file mode 100644 index 1d6fc6dc06..0000000000 --- a/www/apps/docs/content/references/entities/classes/ProductOptionValue.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ProductOptionValue - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ProductOptionValue`** - -## Constructors - -### constructor - -• **new ProductOptionValue**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/product-option-value.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option-value.ts#L40) - -___ - -### option - -• **option**: [`ProductOption`](ProductOption.md) - -#### Defined in - -[models/product-option-value.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option-value.ts#L27) - -___ - -### option\_id - -• **option\_id**: `string` - -#### Defined in - -[models/product-option-value.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option-value.ts#L23) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### value - -• **value**: `string` - -#### Defined in - -[models/product-option-value.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option-value.ts#L19) - -___ - -### variant - -• **variant**: [`ProductVariant`](ProductVariant.md) - -#### Defined in - -[models/product-option-value.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option-value.ts#L37) - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -[models/product-option-value.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option-value.ts#L31) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/product-option-value.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-option-value.ts#L43) diff --git a/www/apps/docs/content/references/entities/classes/ProductOptionValue.mdx b/www/apps/docs/content/references/entities/classes/ProductOptionValue.mdx new file mode 100644 index 0000000000..9c1ec22c52 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ProductOptionValue.mdx @@ -0,0 +1,1484 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductOptionValue + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option", + "type": "[`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOptionValue`](ProductOptionValue.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option", + "type": "[`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "required_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOptionValue`](ProductOptionValue.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option", + "type": "[`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`MoneyAmount`](MoneyAmount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list", + "type": "``null`` \\| [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ProductTag.md b/www/apps/docs/content/references/entities/classes/ProductTag.md deleted file mode 100644 index f5f0d4ae8e..0000000000 --- a/www/apps/docs/content/references/entities/classes/ProductTag.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ProductTag - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ProductTag`** - -## Constructors - -### constructor - -• **new ProductTag**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/product-tag.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-tag.ts#L13) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### value - -• **value**: `string` - -#### Defined in - -[models/product-tag.ts:10](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-tag.ts#L10) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/product-tag.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-tag.ts#L16) diff --git a/www/apps/docs/content/references/entities/classes/ProductTag.mdx b/www/apps/docs/content/references/entities/classes/ProductTag.mdx new file mode 100644 index 0000000000..daac07dc74 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ProductTag.mdx @@ -0,0 +1,60 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductTag + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ProductTaxRate.md b/www/apps/docs/content/references/entities/classes/ProductTaxRate.md deleted file mode 100644 index 0c18803bd2..0000000000 --- a/www/apps/docs/content/references/entities/classes/ProductTaxRate.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ProductTaxRate - -## Constructors - -### constructor - -• **new ProductTaxRate**() - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Defined in - -[models/product-tax-rate.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-tax-rate.ts#L32) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/product-tax-rate.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-tax-rate.ts#L38) - -___ - -### product - -• `Optional` **product**: [`Product`](Product.md) - -#### Defined in - -[models/product-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-tax-rate.ts#L24) - -___ - -### product\_id - -• **product\_id**: `string` - -#### Defined in - -[models/product-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-tax-rate.ts#L17) - -___ - -### rate\_id - -• **rate\_id**: `string` - -#### Defined in - -[models/product-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-tax-rate.ts#L20) - -___ - -### tax\_rate - -• `Optional` **tax\_rate**: [`TaxRate`](TaxRate.md) - -#### Defined in - -[models/product-tax-rate.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-tax-rate.ts#L29) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Defined in - -[models/product-tax-rate.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-tax-rate.ts#L35) diff --git a/www/apps/docs/content/references/entities/classes/ProductTaxRate.mdx b/www/apps/docs/content/references/entities/classes/ProductTaxRate.mdx new file mode 100644 index 0000000000..11533e9dde --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ProductTaxRate.mdx @@ -0,0 +1,2277 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductTaxRate + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "category_children", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_active", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_internal", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category", + "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rank", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryProductJoinTable", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "`\"product_category_product\"`", + "children": [] + }, + { + "name": "treeRelations", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Image`](Image.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "DRAFT", + "type": "``\"draft\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PROPOSED", + "type": "``\"proposed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PUBLISHED", + "type": "``\"published\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REJECTED", + "type": "``\"rejected\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "[`TaxRate`](TaxRate.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TaxRate`](TaxRate.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_type_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_types", + "type": "[`ProductType`](ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ProductType.md b/www/apps/docs/content/references/entities/classes/ProductType.md deleted file mode 100644 index 9cd6dcd173..0000000000 --- a/www/apps/docs/content/references/entities/classes/ProductType.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ProductType - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ProductType`** - -## Constructors - -### constructor - -• **new ProductType**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/product-type.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-type.ts#L13) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### value - -• **value**: `string` - -#### Defined in - -[models/product-type.ts:10](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-type.ts#L10) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/product-type.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-type.ts#L16) diff --git a/www/apps/docs/content/references/entities/classes/ProductType.mdx b/www/apps/docs/content/references/entities/classes/ProductType.mdx new file mode 100644 index 0000000000..199f39d94b --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ProductType.mdx @@ -0,0 +1,60 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductType + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ProductTypeTaxRate.md b/www/apps/docs/content/references/entities/classes/ProductTypeTaxRate.md deleted file mode 100644 index 27bab91257..0000000000 --- a/www/apps/docs/content/references/entities/classes/ProductTypeTaxRate.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ProductTypeTaxRate - -## Constructors - -### constructor - -• **new ProductTypeTaxRate**() - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Defined in - -[models/product-type-tax-rate.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-type-tax-rate.ts#L31) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/product-type-tax-rate.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-type-tax-rate.ts#L37) - -___ - -### product\_type - -• `Optional` **product\_type**: [`ProductType`](ProductType.md) - -#### Defined in - -[models/product-type-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-type-tax-rate.ts#L24) - -___ - -### product\_type\_id - -• **product\_type\_id**: `string` - -#### Defined in - -[models/product-type-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-type-tax-rate.ts#L17) - -___ - -### rate\_id - -• **rate\_id**: `string` - -#### Defined in - -[models/product-type-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-type-tax-rate.ts#L20) - -___ - -### tax\_rate - -• `Optional` **tax\_rate**: [`TaxRate`](TaxRate.md) - -#### Defined in - -[models/product-type-tax-rate.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-type-tax-rate.ts#L28) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Defined in - -[models/product-type-tax-rate.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-type-tax-rate.ts#L34) diff --git a/www/apps/docs/content/references/entities/classes/ProductTypeTaxRate.mdx b/www/apps/docs/content/references/entities/classes/ProductTypeTaxRate.mdx new file mode 100644 index 0000000000..bf981bcaf8 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ProductTypeTaxRate.mdx @@ -0,0 +1,986 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductTypeTaxRate + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_type_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "[`TaxRate`](TaxRate.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TaxRate`](TaxRate.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_type_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_types", + "type": "[`ProductType`](ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ProductVariant.md b/www/apps/docs/content/references/entities/classes/ProductVariant.md deleted file mode 100644 index e19317bd13..0000000000 --- a/www/apps/docs/content/references/entities/classes/ProductVariant.md +++ /dev/null @@ -1,331 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ProductVariant - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ProductVariant`** - -## Constructors - -### constructor - -• **new ProductVariant**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### allow\_backorder - -• **allow\_backorder**: `boolean` - -#### Defined in - -[models/product-variant.ts:72](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L72) - -___ - -### barcode - -• **barcode**: ``null`` \| `string` - -#### Defined in - -[models/product-variant.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L55) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### ean - -• **ean**: ``null`` \| `string` - -#### Defined in - -[models/product-variant.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L59) - -___ - -### height - -• **height**: ``null`` \| `number` - -#### Defined in - -[models/product-variant.ts:96](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L96) - -___ - -### hs\_code - -• **hs\_code**: ``null`` \| `string` - -#### Defined in - -[models/product-variant.ts:78](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L78) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### inventory\_items - -• **inventory\_items**: [`ProductVariantInventoryItem`](ProductVariantInventoryItem.md)[] - -#### Defined in - -[models/product-variant.ts:113](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L113) - -___ - -### inventory\_quantity - -• **inventory\_quantity**: `number` - -#### Defined in - -[models/product-variant.ts:69](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L69) - -___ - -### length - -• **length**: ``null`` \| `number` - -#### Defined in - -[models/product-variant.ts:93](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L93) - -___ - -### manage\_inventory - -• **manage\_inventory**: `boolean` - -#### Defined in - -[models/product-variant.ts:75](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L75) - -___ - -### material - -• **material**: ``null`` \| `string` - -#### Defined in - -[models/product-variant.ts:87](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L87) - -___ - -### metadata - -• **metadata**: ``null`` \| `Record`<`string`, `unknown`\> - -#### Defined in - -[models/product-variant.ts:116](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L116) - -___ - -### mid\_code - -• **mid\_code**: ``null`` \| `string` - -#### Defined in - -[models/product-variant.ts:84](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L84) - -___ - -### options - -• **options**: [`ProductOptionValue`](ProductOptionValue.md)[] - -#### Defined in - -[models/product-variant.ts:104](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L104) - -___ - -### origin\_country - -• **origin\_country**: ``null`` \| `string` - -#### Defined in - -[models/product-variant.ts:81](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L81) - -___ - -### prices - -• **prices**: [`MoneyAmount`](MoneyAmount.md)[] - -#### Defined in - -[models/product-variant.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L47) - -___ - -### product - -• **product**: [`Product`](Product.md) - -#### Defined in - -[models/product-variant.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L31) - -___ - -### product\_id - -• **product\_id**: `string` - -#### Defined in - -[models/product-variant.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L27) - -___ - -### purchasable - -• `Optional` **purchasable**: `boolean` - -#### Defined in - -[models/product-variant.ts:118](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L118) - -___ - -### sku - -• **sku**: ``null`` \| `string` - -#### Defined in - -[models/product-variant.ts:51](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L51) - -___ - -### title - -• **title**: `string` - -#### Defined in - -[models/product-variant.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L23) - -___ - -### upc - -• **upc**: ``null`` \| `string` - -#### Defined in - -[models/product-variant.ts:63](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L63) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### variant\_rank - -• **variant\_rank**: ``null`` \| `number` - -#### Defined in - -[models/product-variant.ts:66](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L66) - -___ - -### weight - -• **weight**: ``null`` \| `number` - -#### Defined in - -[models/product-variant.ts:90](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L90) - -___ - -### width - -• **width**: ``null`` \| `number` - -#### Defined in - -[models/product-variant.ts:99](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L99) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/product-variant.ts:121](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant.ts#L121) diff --git a/www/apps/docs/content/references/entities/classes/ProductVariant.mdx b/www/apps/docs/content/references/entities/classes/ProductVariant.mdx new file mode 100644 index 0000000000..9da7feefc1 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ProductVariant.mdx @@ -0,0 +1,3202 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariant + +## Properties + + [`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "required_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOptionValue`](ProductOptionValue.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option", + "type": "[`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`MoneyAmount`](MoneyAmount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list", + "type": "``null`` \\| [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "category_children", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_active", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_internal", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category", + "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rank", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryProductJoinTable", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "`\"product_category_product\"`", + "children": [] + }, + { + "name": "treeRelations", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Image`](Image.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "DRAFT", + "type": "``\"draft\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PROPOSED", + "type": "``\"proposed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PUBLISHED", + "type": "``\"published\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REJECTED", + "type": "``\"rejected\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ProductVariantInventoryItem.md b/www/apps/docs/content/references/entities/classes/ProductVariantInventoryItem.md deleted file mode 100644 index d5efd56235..0000000000 --- a/www/apps/docs/content/references/entities/classes/ProductVariantInventoryItem.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ProductVariantInventoryItem - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ProductVariantInventoryItem`** - -## Constructors - -### constructor - -• **new ProductVariantInventoryItem**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### inventory\_item\_id - -• **inventory\_item\_id**: `string` - -#### Defined in - -[models/product-variant-inventory-item.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant-inventory-item.ts#L17) - -___ - -### required\_quantity - -• **required\_quantity**: `number` - -#### Defined in - -[models/product-variant-inventory-item.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant-inventory-item.ts#L28) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### variant - -• **variant**: [`ProductVariant`](ProductVariant.md) - -#### Defined in - -[models/product-variant-inventory-item.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant-inventory-item.ts#L25) - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -[models/product-variant-inventory-item.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant-inventory-item.ts#L21) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/product-variant-inventory-item.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant-inventory-item.ts#L31) diff --git a/www/apps/docs/content/references/entities/classes/ProductVariantInventoryItem.mdx b/www/apps/docs/content/references/entities/classes/ProductVariantInventoryItem.mdx new file mode 100644 index 0000000000..7f1f81e17a --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ProductVariantInventoryItem.mdx @@ -0,0 +1,969 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantInventoryItem + +## Properties + + [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "required_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOptionValue`](ProductOptionValue.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option", + "type": "[`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`MoneyAmount`](MoneyAmount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list", + "type": "``null`` \\| [`PriceList`](PriceList.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `undefined` \\| `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ProductVariantMoneyAmount.md b/www/apps/docs/content/references/entities/classes/ProductVariantMoneyAmount.md deleted file mode 100644 index 324b0e65cf..0000000000 --- a/www/apps/docs/content/references/entities/classes/ProductVariantMoneyAmount.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ProductVariantMoneyAmount - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ProductVariantMoneyAmount`** - -## Constructors - -### constructor - -• **new ProductVariantMoneyAmount**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### money\_amount\_id - -• **money\_amount\_id**: `string` - -#### Defined in - -[models/product-variant-money-amount.ts:11](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant-money-amount.ts#L11) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### variant\_id - -• **variant\_id**: `string` - -#### Defined in - -[models/product-variant-money-amount.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant-money-amount.ts#L15) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/product-variant-money-amount.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product-variant-money-amount.ts#L18) diff --git a/www/apps/docs/content/references/entities/classes/ProductVariantMoneyAmount.mdx b/www/apps/docs/content/references/entities/classes/ProductVariantMoneyAmount.mdx new file mode 100644 index 0000000000..0aaf5f46c0 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ProductVariantMoneyAmount.mdx @@ -0,0 +1,60 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductVariantMoneyAmount + +## Properties + + diff --git a/www/apps/docs/content/references/entities/classes/PublishableApiKey.md b/www/apps/docs/content/references/entities/classes/PublishableApiKey.md deleted file mode 100644 index e51662cba6..0000000000 --- a/www/apps/docs/content/references/entities/classes/PublishableApiKey.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: PublishableApiKey - -## Hierarchy - -- `BaseEntity` - - ↳ **`PublishableApiKey`** - -## Constructors - -### constructor - -• **new PublishableApiKey**() - -#### Inherited from - -BaseEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -BaseEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### created\_by - -• **created\_by**: ``null`` \| `string` - -#### Defined in - -[models/publishable-api-key.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/publishable-api-key.ts#L9) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -BaseEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### revoked\_at - -• `Optional` **revoked\_at**: `Date` - -#### Defined in - -[models/publishable-api-key.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/publishable-api-key.ts#L15) - -___ - -### revoked\_by - -• **revoked\_by**: ``null`` \| `string` - -#### Defined in - -[models/publishable-api-key.ts:12](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/publishable-api-key.ts#L12) - -___ - -### title - -• **title**: `string` - -#### Defined in - -[models/publishable-api-key.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/publishable-api-key.ts#L18) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -BaseEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/publishable-api-key.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/publishable-api-key.ts#L21) diff --git a/www/apps/docs/content/references/entities/classes/PublishableApiKey.mdx b/www/apps/docs/content/references/entities/classes/PublishableApiKey.mdx new file mode 100644 index 0000000000..90886b215d --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/PublishableApiKey.mdx @@ -0,0 +1,68 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PublishableApiKey + +## Properties + + diff --git a/www/apps/docs/content/references/entities/classes/PublishableApiKeySalesChannel.md b/www/apps/docs/content/references/entities/classes/PublishableApiKeySalesChannel.md deleted file mode 100644 index 4c55a4add6..0000000000 --- a/www/apps/docs/content/references/entities/classes/PublishableApiKeySalesChannel.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: PublishableApiKeySalesChannel - -## Constructors - -### constructor - -• **new PublishableApiKeySalesChannel**() - -## Properties - -### publishable\_key\_id - -• **publishable\_key\_id**: `string` - -#### Defined in - -[models/publishable-api-key-sales-channel.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/publishable-api-key-sales-channel.ts#L9) - -___ - -### sales\_channel\_id - -• **sales\_channel\_id**: `string` - -#### Defined in - -[models/publishable-api-key-sales-channel.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/publishable-api-key-sales-channel.ts#L6) diff --git a/www/apps/docs/content/references/entities/classes/PublishableApiKeySalesChannel.mdx b/www/apps/docs/content/references/entities/classes/PublishableApiKeySalesChannel.mdx new file mode 100644 index 0000000000..116340d39d --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/PublishableApiKeySalesChannel.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PublishableApiKeySalesChannel + +## Properties + + diff --git a/www/apps/docs/content/references/entities/classes/Refund.md b/www/apps/docs/content/references/entities/classes/Refund.md deleted file mode 100644 index 5b9285f294..0000000000 --- a/www/apps/docs/content/references/entities/classes/Refund.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Refund - -## Hierarchy - -- `BaseEntity` - - ↳ **`Refund`** - -## Constructors - -### constructor - -• **new Refund**() - -#### Inherited from - -BaseEntity.constructor - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -[models/refund.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L44) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -BaseEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -BaseEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -[models/refund.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L56) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/refund.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L53) - -___ - -### note - -• **note**: `string` - -#### Defined in - -[models/refund.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L47) - -___ - -### order - -• **order**: [`Order`](Order.md) - -#### Defined in - -[models/refund.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L37) - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -[models/refund.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L29) - -___ - -### payment - -• **payment**: [`Payment`](Payment.md) - -#### Defined in - -[models/refund.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L41) - -___ - -### payment\_id - -• **payment\_id**: `string` - -#### Defined in - -[models/refund.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L33) - -___ - -### reason - -• **reason**: `string` - -#### Defined in - -[models/refund.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L50) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -BaseEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/refund.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L59) diff --git a/www/apps/docs/content/references/entities/classes/Refund.mdx b/www/apps/docs/content/references/entities/classes/Refund.mdx new file mode 100644 index 0000000000..9107690c2d --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Refund.mdx @@ -0,0 +1,5882 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Refund + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card", + "type": "[`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Refund`](Refund.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ARCHIVED", + "type": "``\"archived\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Region.md b/www/apps/docs/content/references/entities/classes/Region.md deleted file mode 100644 index 8d18d3c647..0000000000 --- a/www/apps/docs/content/references/entities/classes/Region.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Region - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`Region`** - -## Constructors - -### constructor - -• **new Region**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### automatic\_taxes - -• **automatic\_taxes**: `boolean` - -#### Defined in - -[models/region.ts:51](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L51) - -___ - -### countries - -• **countries**: [`Country`](Country.md)[] - -#### Defined in - -[models/region.ts:54](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L54) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### currency - -• **currency**: [`Currency`](Currency.md) - -#### Defined in - -[models/region.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L36) - -___ - -### currency\_code - -• **currency\_code**: `string` - -#### Defined in - -[models/region.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L32) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### fulfillment\_providers - -• **fulfillment\_providers**: [`FulfillmentProvider`](FulfillmentProvider.md)[] - -#### Defined in - -[models/region.ts:93](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L93) - -___ - -### gift\_cards\_taxable - -• **gift\_cards\_taxable**: `boolean` - -#### Defined in - -[models/region.ts:48](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L48) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### includes\_tax - -• **includes\_tax**: `boolean` - -#### Defined in - -[models/region.ts:99](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L99) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/region.ts:96](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L96) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[models/region.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L28) - -___ - -### payment\_providers - -• **payment\_providers**: [`PaymentProvider`](PaymentProvider.md)[] - -#### Defined in - -[models/region.ts:77](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L77) - -___ - -### tax\_code - -• **tax\_code**: `string` - -#### Defined in - -[models/region.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L45) - -___ - -### tax\_provider - -• **tax\_provider**: [`TaxProvider`](TaxProvider.md) - -#### Defined in - -[models/region.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L61) - -___ - -### tax\_provider\_id - -• **tax\_provider\_id**: ``null`` \| `string` - -#### Defined in - -[models/region.ts:57](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L57) - -___ - -### tax\_rate - -• **tax\_rate**: `number` - -#### Defined in - -[models/region.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L39) - -___ - -### tax\_rates - -• **tax\_rates**: ``null`` \| [`TaxRate`](TaxRate.md)[] - -#### Defined in - -[models/region.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L42) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/region.ts:102](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/region.ts#L102) diff --git a/www/apps/docs/content/references/entities/classes/Region.mdx b/www/apps/docs/content/references/entities/classes/Region.mdx new file mode 100644 index 0000000000..4542a1a2a8 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Region.mdx @@ -0,0 +1,530 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Region + +## Properties + + [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_2", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_3", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "num_code", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentProvider`](PaymentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Return.md b/www/apps/docs/content/references/entities/classes/Return.md deleted file mode 100644 index a5b71b1e2d..0000000000 --- a/www/apps/docs/content/references/entities/classes/Return.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Return - -## Hierarchy - -- `BaseEntity` - - ↳ **`Return`** - -## Constructors - -### constructor - -• **new Return**() - -#### Inherited from - -BaseEntity.constructor - -## Properties - -### claim\_order - -• **claim\_order**: [`ClaimOrder`](ClaimOrder.md) - -#### Defined in - -[models/return.ts:57](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L57) - -___ - -### claim\_order\_id - -• **claim\_order\_id**: ``null`` \| `string` - -#### Defined in - -[models/return.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L53) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -BaseEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -BaseEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### idempotency\_key - -• **idempotency\_key**: ``null`` \| `string` - -#### Defined in - -[models/return.ts:92](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L92) - -___ - -### items - -• **items**: [`ReturnItem`](ReturnItem.md)[] - -#### Defined in - -[models/return.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L41) - -___ - -### location\_id - -• **location\_id**: ``null`` \| `string` - -#### Defined in - -[models/return.ts:74](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L74) - -___ - -### metadata - -• **metadata**: ``null`` \| `Record`<`string`, `unknown`\> - -#### Defined in - -[models/return.ts:89](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L89) - -___ - -### no\_notification - -• **no\_notification**: ``null`` \| `boolean` - -#### Defined in - -[models/return.ts:86](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L86) - -___ - -### order - -• **order**: [`Order`](Order.md) - -#### Defined in - -[models/return.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L65) - -___ - -### order\_id - -• **order\_id**: ``null`` \| `string` - -#### Defined in - -[models/return.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L61) - -___ - -### received\_at - -• **received\_at**: `Date` - -#### Defined in - -[models/return.ts:83](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L83) - -___ - -### refund\_amount - -• **refund\_amount**: `number` - -#### Defined in - -[models/return.ts:80](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L80) - -___ - -### shipping\_data - -• **shipping\_data**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/return.ts:77](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L77) - -___ - -### shipping\_method - -• **shipping\_method**: [`ShippingMethod`](ShippingMethod.md) - -#### Defined in - -[models/return.ts:70](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L70) - -___ - -### status - -• **status**: [`ReturnStatus`](../enums/ReturnStatus.md) - -#### Defined in - -[models/return.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L35) - -___ - -### swap - -• **swap**: [`Swap`](Swap.md) - -#### Defined in - -[models/return.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L49) - -___ - -### swap\_id - -• **swap\_id**: ``null`` \| `string` - -#### Defined in - -[models/return.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L45) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -BaseEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/return.ts:95](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L95) diff --git a/www/apps/docs/content/references/entities/classes/Return.mdx b/www/apps/docs/content/references/entities/classes/Return.mdx new file mode 100644 index 0000000000..9a110e4d84 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Return.mdx @@ -0,0 +1,11688 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Return + +## Properties + + [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimItem`](ClaimItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`ClaimImage`](ClaimImage.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ClaimReason`](../enums/ClaimReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ClaimTag`](ClaimTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "NA", + "type": "``\"na\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_REFUNDED", + "type": "``\"not_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "REFUND", + "type": "``\"refund\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REPLACE", + "type": "``\"replace\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ReturnItem`](ReturnItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_requested", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "label", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason", + "type": "``null`` \\| [`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_reason_children", + "type": "[`ReturnReason`](ReturnReason.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "reason_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card", + "type": "[`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Refund`](Refund.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ARCHIVED", + "type": "``\"archived\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RECEIVED", + "type": "``\"received\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUESTED", + "type": "``\"requested\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CONFIRMED", + "type": "``\"confirmed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DIFFERENCE_REFUNDED", + "type": "``\"difference_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ReturnItem.md b/www/apps/docs/content/references/entities/classes/ReturnItem.md deleted file mode 100644 index 147d223112..0000000000 --- a/www/apps/docs/content/references/entities/classes/ReturnItem.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ReturnItem - -## Constructors - -### constructor - -• **new ReturnItem**() - -## Properties - -### is\_requested - -• **is\_requested**: `boolean` - -#### Defined in - -[models/return-item.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-item.ts#L28) - -___ - -### item - -• **item**: [`LineItem`](LineItem.md) - -#### Defined in - -[models/return-item.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-item.ts#L22) - -___ - -### item\_id - -• **item\_id**: `string` - -#### Defined in - -[models/return-item.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-item.ts#L14) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/return-item.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-item.ts#L47) - -___ - -### note - -• **note**: `string` - -#### Defined in - -[models/return-item.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-item.ts#L44) - -___ - -### quantity - -• **quantity**: `number` - -#### Defined in - -[models/return-item.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-item.ts#L25) - -___ - -### reason - -• **reason**: [`ReturnReason`](ReturnReason.md) - -#### Defined in - -[models/return-item.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-item.ts#L41) - -___ - -### reason\_id - -• **reason\_id**: `string` - -#### Defined in - -[models/return-item.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-item.ts#L37) - -___ - -### received\_quantity - -• **received\_quantity**: `number` - -#### Defined in - -[models/return-item.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-item.ts#L34) - -___ - -### requested\_quantity - -• **requested\_quantity**: `number` - -#### Defined in - -[models/return-item.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-item.ts#L31) - -___ - -### return\_id - -• **return\_id**: `string` - -#### Defined in - -[models/return-item.ts:11](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-item.ts#L11) - -___ - -### return\_order - -• **return\_order**: [`Return`](Return.md) - -#### Defined in - -[models/return-item.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-item.ts#L18) diff --git a/www/apps/docs/content/references/entities/classes/ReturnItem.mdx b/www/apps/docs/content/references/entities/classes/ReturnItem.mdx new file mode 100644 index 0000000000..fca49c9469 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ReturnItem.mdx @@ -0,0 +1,3685 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnItem + +## Properties + + [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemAdjustment`](LineItemAdjustment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemTaxLine`](LineItemTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "label", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason", + "type": "``null`` \\| [`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_reason_children", + "type": "[`ReturnReason`](ReturnReason.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "label", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason", + "type": "``null`` \\| [`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_reason_children", + "type": "[`ReturnReason`](ReturnReason.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "reason_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ReturnItem`](ReturnItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_requested", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RECEIVED", + "type": "``\"received\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUESTED", + "type": "``\"requested\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ReturnReason.md b/www/apps/docs/content/references/entities/classes/ReturnReason.md deleted file mode 100644 index 861517986a..0000000000 --- a/www/apps/docs/content/references/entities/classes/ReturnReason.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ReturnReason - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ReturnReason`** - -## Constructors - -### constructor - -• **new ReturnReason**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### description - -• **description**: `string` - -#### Defined in - -[models/return-reason.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-reason.ts#L25) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### label - -• **label**: `string` - -#### Defined in - -[models/return-reason.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-reason.ts#L22) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/return-reason.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-reason.ts#L42) - -___ - -### parent\_return\_reason - -• **parent\_return\_reason**: ``null`` \| [`ReturnReason`](ReturnReason.md) - -#### Defined in - -[models/return-reason.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-reason.ts#L32) - -___ - -### parent\_return\_reason\_id - -• **parent\_return\_reason\_id**: ``null`` \| `string` - -#### Defined in - -[models/return-reason.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-reason.ts#L28) - -___ - -### return\_reason\_children - -• **return\_reason\_children**: [`ReturnReason`](ReturnReason.md)[] - -#### Defined in - -[models/return-reason.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-reason.ts#L39) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### value - -• **value**: `string` - -#### Defined in - -[models/return-reason.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-reason.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/return-reason.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return-reason.ts#L45) diff --git a/www/apps/docs/content/references/entities/classes/ReturnReason.mdx b/www/apps/docs/content/references/entities/classes/ReturnReason.mdx new file mode 100644 index 0000000000..ac41bd290e --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ReturnReason.mdx @@ -0,0 +1,310 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnReason + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason", + "type": "``null`` \\| [`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_reason_children", + "type": "[`ReturnReason`](ReturnReason.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "label", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason", + "type": "``null`` \\| [`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_reason_children", + "type": "[`ReturnReason`](ReturnReason.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "label", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason", + "type": "``null`` \\| [`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_return_reason_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_reason_children", + "type": "[`ReturnReason`](ReturnReason.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/SalesChannel.md b/www/apps/docs/content/references/entities/classes/SalesChannel.md deleted file mode 100644 index 4686fd2eb7..0000000000 --- a/www/apps/docs/content/references/entities/classes/SalesChannel.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: SalesChannel - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`SalesChannel`** - -## Constructors - -### constructor - -• **new SalesChannel**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### description - -• **description**: ``null`` \| `string` - -#### Defined in - -[models/sales-channel.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/sales-channel.ts#L14) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### is\_disabled - -• **is\_disabled**: `boolean` - -#### Defined in - -[models/sales-channel.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/sales-channel.ts#L17) - -___ - -### locations - -• **locations**: [`SalesChannelLocation`](SalesChannelLocation.md)[] - -#### Defined in - -[models/sales-channel.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/sales-channel.ts#L29) - -___ - -### metadata - -• **metadata**: ``null`` \| `Record`<`string`, `unknown`\> - -#### Defined in - -[models/sales-channel.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/sales-channel.ts#L20) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[models/sales-channel.ts:11](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/sales-channel.ts#L11) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/sales-channel.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/sales-channel.ts#L32) diff --git a/www/apps/docs/content/references/entities/classes/SalesChannel.mdx b/www/apps/docs/content/references/entities/classes/SalesChannel.mdx new file mode 100644 index 0000000000..ef8fc51028 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/SalesChannel.mdx @@ -0,0 +1,246 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SalesChannel + +## Properties + + [`SalesChannelLocation`](SalesChannelLocation.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/SalesChannelLocation.md b/www/apps/docs/content/references/entities/classes/SalesChannelLocation.md deleted file mode 100644 index 2ddf27511c..0000000000 --- a/www/apps/docs/content/references/entities/classes/SalesChannelLocation.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: SalesChannelLocation - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`SalesChannelLocation`** - -## Constructors - -### constructor - -• **new SalesChannelLocation**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### location\_id - -• **location\_id**: `string` - -#### Defined in - -[models/sales-channel-location.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/sales-channel-location.ts#L16) - -___ - -### sales\_channel - -• **sales\_channel**: [`SalesChannel`](SalesChannel.md) - -#### Defined in - -[models/sales-channel-location.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/sales-channel-location.ts#L20) - -___ - -### sales\_channel\_id - -• **sales\_channel\_id**: `string` - -#### Defined in - -[models/sales-channel-location.ts:12](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/sales-channel-location.ts#L12) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/sales-channel-location.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/sales-channel-location.ts#L23) diff --git a/www/apps/docs/content/references/entities/classes/SalesChannelLocation.mdx b/www/apps/docs/content/references/entities/classes/SalesChannelLocation.mdx new file mode 100644 index 0000000000..dda7f7b6cd --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/SalesChannelLocation.mdx @@ -0,0 +1,230 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SalesChannelLocation + +## Properties + + [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannelLocation`](SalesChannelLocation.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ShippingMethod.md b/www/apps/docs/content/references/entities/classes/ShippingMethod.md deleted file mode 100644 index 41c0fef0c1..0000000000 --- a/www/apps/docs/content/references/entities/classes/ShippingMethod.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ShippingMethod - -## Constructors - -### constructor - -• **new ShippingMethod**() - -## Properties - -### cart - -• **cart**: [`Cart`](Cart.md) - -#### Defined in - -[models/shipping-method.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L61) - -___ - -### cart\_id - -• **cart\_id**: `string` - -#### Defined in - -[models/shipping-method.ts:57](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L57) - -___ - -### claim\_order - -• **claim\_order**: [`ClaimOrder`](ClaimOrder.md) - -#### Defined in - -[models/shipping-method.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L53) - -___ - -### claim\_order\_id - -• **claim\_order\_id**: ``null`` \| `string` - -#### Defined in - -[models/shipping-method.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L49) - -___ - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/shipping-method.ts:92](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L92) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[models/shipping-method.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L33) - -___ - -### includes\_tax - -• **includes\_tax**: `boolean` - -#### Defined in - -[models/shipping-method.ts:95](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L95) - -___ - -### order - -• **order**: [`Order`](Order.md) - -#### Defined in - -[models/shipping-method.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L45) - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -[models/shipping-method.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L41) - -___ - -### price - -• **price**: `number` - -#### Defined in - -[models/shipping-method.ts:89](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L89) - -___ - -### return\_id - -• **return\_id**: `string` - -#### Defined in - -[models/shipping-method.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L73) - -___ - -### return\_order - -• **return\_order**: [`Return`](Return.md) - -#### Defined in - -[models/shipping-method.ts:77](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L77) - -___ - -### shipping\_option - -• **shipping\_option**: [`ShippingOption`](ShippingOption.md) - -#### Defined in - -[models/shipping-method.ts:81](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L81) - -___ - -### shipping\_option\_id - -• **shipping\_option\_id**: `string` - -#### Defined in - -[models/shipping-method.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L37) - -___ - -### subtotal - -• `Optional` **subtotal**: `number` - -#### Defined in - -[models/shipping-method.ts:97](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L97) - -___ - -### swap - -• **swap**: [`Swap`](Swap.md) - -#### Defined in - -[models/shipping-method.ts:69](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L69) - -___ - -### swap\_id - -• **swap\_id**: `string` - -#### Defined in - -[models/shipping-method.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L65) - -___ - -### tax\_lines - -• **tax\_lines**: [`ShippingMethodTaxLine`](ShippingMethodTaxLine.md)[] - -#### Defined in - -[models/shipping-method.ts:86](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L86) - -___ - -### tax\_total - -• `Optional` **tax\_total**: `number` - -#### Defined in - -[models/shipping-method.ts:99](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L99) - -___ - -### total - -• `Optional` **total**: `number` - -#### Defined in - -[models/shipping-method.ts:98](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L98) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/shipping-method.ts:102](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method.ts#L102) diff --git a/www/apps/docs/content/references/entities/classes/ShippingMethod.mdx b/www/apps/docs/content/references/entities/classes/ShippingMethod.mdx new file mode 100644 index 0000000000..99613c4096 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ShippingMethod.mdx @@ -0,0 +1,13334 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingMethod + +## Properties + + [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_initiated", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_selected", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CLAIM", + "type": "``\"claim\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEFAULT", + "type": "``\"default\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DRAFT_ORDER", + "type": "``\"draft_order\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PAYMENT_LINK", + "type": "``\"payment_link\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SWAP", + "type": "``\"swap\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimItem`](ClaimItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`ClaimImage`](ClaimImage.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ClaimReason`](../enums/ClaimReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ClaimTag`](ClaimTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "NA", + "type": "``\"na\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_REFUNDED", + "type": "``\"not_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "REFUND", + "type": "``\"refund\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REPLACE", + "type": "``\"replace\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card", + "type": "[`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Refund`](Refund.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ARCHIVED", + "type": "``\"archived\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ReturnItem`](ReturnItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_requested", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RECEIVED", + "type": "``\"received\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUESTED", + "type": "``\"requested\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CALCULATED", + "type": "``\"calculated\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FLAT_RATE", + "type": "``\"flat_rate\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`RequirementType`](../enums/RequirementType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CONFIRMED", + "type": "``\"confirmed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DIFFERENCE_REFUNDED", + "type": "``\"difference_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_method_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ShippingMethodTaxLine.md b/www/apps/docs/content/references/entities/classes/ShippingMethodTaxLine.md deleted file mode 100644 index 55e443cef8..0000000000 --- a/www/apps/docs/content/references/entities/classes/ShippingMethodTaxLine.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ShippingMethodTaxLine - -## Hierarchy - -- `TaxLine` - - ↳ **`ShippingMethodTaxLine`** - -## Constructors - -### constructor - -• **new ShippingMethodTaxLine**() - -#### Inherited from - -TaxLine.constructor - -## Properties - -### code - -• **code**: ``null`` \| `string` - -#### Inherited from - -TaxLine.code - -#### Defined in - -[models/tax-line.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-line.ts#L13) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -TaxLine.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -TaxLine.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Inherited from - -TaxLine.metadata - -#### Defined in - -[models/tax-line.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-line.ts#L16) - -___ - -### name - -• **name**: `string` - -#### Inherited from - -TaxLine.name - -#### Defined in - -[models/tax-line.ts:10](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-line.ts#L10) - -___ - -### rate - -• **rate**: `number` - -#### Inherited from - -TaxLine.rate - -#### Defined in - -[models/tax-line.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-line.ts#L7) - -___ - -### shipping\_method - -• **shipping\_method**: [`ShippingMethod`](ShippingMethod.md) - -#### Defined in - -[models/shipping-method-tax-line.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method-tax-line.ts#L24) - -___ - -### shipping\_method\_id - -• **shipping\_method\_id**: `string` - -#### Defined in - -[models/shipping-method-tax-line.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method-tax-line.ts#L20) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -TaxLine.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/shipping-method-tax-line.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-method-tax-line.ts#L27) diff --git a/www/apps/docs/content/references/entities/classes/ShippingMethodTaxLine.mdx b/www/apps/docs/content/references/entities/classes/ShippingMethodTaxLine.mdx new file mode 100644 index 0000000000..0d9cce4487 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ShippingMethodTaxLine.mdx @@ -0,0 +1,1916 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingMethodTaxLine + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_method_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ShippingOption.md b/www/apps/docs/content/references/entities/classes/ShippingOption.md deleted file mode 100644 index 6efd2f485c..0000000000 --- a/www/apps/docs/content/references/entities/classes/ShippingOption.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ShippingOption - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ShippingOption`** - -## Constructors - -### constructor - -• **new ShippingOption**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### admin\_only - -• **admin\_only**: `boolean` - -#### Defined in - -[models/shipping-option.ts:67](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L67) - -___ - -### amount - -• **amount**: ``null`` \| `number` - -#### Defined in - -[models/shipping-option.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L61) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/shipping-option.ts:75](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L75) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### includes\_tax - -• **includes\_tax**: `boolean` - -#### Defined in - -[models/shipping-option.ts:81](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L81) - -___ - -### is\_return - -• **is\_return**: `boolean` - -#### Defined in - -[models/shipping-option.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L64) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/shipping-option.ts:78](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L78) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[models/shipping-option.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L31) - -___ - -### price\_type - -• **price\_type**: [`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.md) - -#### Defined in - -[models/shipping-option.ts:58](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L58) - -___ - -### profile - -• **profile**: [`ShippingProfile`](ShippingProfile.md) - -#### Defined in - -[models/shipping-option.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L47) - -___ - -### profile\_id - -• **profile\_id**: `string` - -#### Defined in - -[models/shipping-option.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L43) - -___ - -### provider - -• **provider**: [`FulfillmentProvider`](FulfillmentProvider.md) - -#### Defined in - -[models/shipping-option.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L55) - -___ - -### provider\_id - -• **provider\_id**: `string` - -#### Defined in - -[models/shipping-option.ts:51](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L51) - -___ - -### region - -• **region**: [`Region`](Region.md) - -#### Defined in - -[models/shipping-option.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L39) - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -[models/shipping-option.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L35) - -___ - -### requirements - -• **requirements**: [`ShippingOptionRequirement`](ShippingOptionRequirement.md)[] - -#### Defined in - -[models/shipping-option.ts:72](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L72) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/shipping-option.ts:84](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L84) diff --git a/www/apps/docs/content/references/entities/classes/ShippingOption.mdx b/www/apps/docs/content/references/entities/classes/ShippingOption.mdx new file mode 100644 index 0000000000..5777ce206b --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ShippingOption.mdx @@ -0,0 +1,1419 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingOption + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CALCULATED", + "type": "``\"calculated\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FLAT_RATE", + "type": "``\"flat_rate\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CUSTOM", + "type": "``\"custom\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEFAULT", + "type": "``\"default\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "GIFT_CARD", + "type": "``\"gift_card\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_2", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_3", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "num_code", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentProvider`](PaymentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`RequirementType`](../enums/RequirementType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "MAX_SUBTOTAL", + "type": "``\"max_subtotal\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "MIN_SUBTOTAL", + "type": "``\"min_subtotal\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ShippingOptionRequirement.md b/www/apps/docs/content/references/entities/classes/ShippingOptionRequirement.md deleted file mode 100644 index 80c80f1c77..0000000000 --- a/www/apps/docs/content/references/entities/classes/ShippingOptionRequirement.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ShippingOptionRequirement - -## Constructors - -### constructor - -• **new ShippingOptionRequirement**() - -## Properties - -### amount - -• **amount**: `number` - -#### Defined in - -[models/shipping-option-requirement.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option-requirement.ts#L38) - -___ - -### deleted\_at - -• **deleted\_at**: `Date` - -#### Defined in - -[models/shipping-option-requirement.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option-requirement.ts#L41) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[models/shipping-option-requirement.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option-requirement.ts#L24) - -___ - -### shipping\_option - -• **shipping\_option**: [`ShippingOption`](ShippingOption.md) - -#### Defined in - -[models/shipping-option-requirement.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option-requirement.ts#L32) - -___ - -### shipping\_option\_id - -• **shipping\_option\_id**: `string` - -#### Defined in - -[models/shipping-option-requirement.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option-requirement.ts#L28) - -___ - -### type - -• **type**: [`RequirementType`](../enums/RequirementType.md) - -#### Defined in - -[models/shipping-option-requirement.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option-requirement.ts#L35) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/shipping-option-requirement.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option-requirement.ts#L44) diff --git a/www/apps/docs/content/references/entities/classes/ShippingOptionRequirement.mdx b/www/apps/docs/content/references/entities/classes/ShippingOptionRequirement.mdx new file mode 100644 index 0000000000..6706f54b2c --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ShippingOptionRequirement.mdx @@ -0,0 +1,611 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingOptionRequirement + +## Properties + + [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CALCULATED", + "type": "``\"calculated\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FLAT_RATE", + "type": "``\"flat_rate\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`RequirementType`](../enums/RequirementType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`RequirementType`](../enums/RequirementType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "MAX_SUBTOTAL", + "type": "``\"max_subtotal\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "MIN_SUBTOTAL", + "type": "``\"min_subtotal\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ShippingProfile.md b/www/apps/docs/content/references/entities/classes/ShippingProfile.md deleted file mode 100644 index f1f971f92d..0000000000 --- a/www/apps/docs/content/references/entities/classes/ShippingProfile.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ShippingProfile - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`ShippingProfile`** - -## Constructors - -### constructor - -• **new ShippingProfile**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/shipping-profile.ts:47](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-profile.ts#L47) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[models/shipping-profile.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-profile.ts#L24) - -___ - -### products - -• **products**: [`Product`](Product.md)[] - -#### Defined in - -[models/shipping-profile.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-profile.ts#L41) - -___ - -### shipping\_options - -• **shipping\_options**: [`ShippingOption`](ShippingOption.md)[] - -#### Defined in - -[models/shipping-profile.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-profile.ts#L44) - -___ - -### type - -• **type**: [`ShippingProfileType`](../enums/ShippingProfileType.md) - -#### Defined in - -[models/shipping-profile.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-profile.ts#L27) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/shipping-profile.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-profile.ts#L50) diff --git a/www/apps/docs/content/references/entities/classes/ShippingProfile.mdx b/www/apps/docs/content/references/entities/classes/ShippingProfile.mdx new file mode 100644 index 0000000000..0b43fd81ac --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ShippingProfile.mdx @@ -0,0 +1,1999 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingProfile + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "category_children", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_active", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_internal", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category", + "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rank", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryProductJoinTable", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "`\"product_category_product\"`", + "children": [] + }, + { + "name": "treeRelations", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Image`](Image.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "DRAFT", + "type": "``\"draft\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PROPOSED", + "type": "``\"proposed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PUBLISHED", + "type": "``\"published\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REJECTED", + "type": "``\"rejected\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CALCULATED", + "type": "``\"calculated\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FLAT_RATE", + "type": "``\"flat_rate\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`RequirementType`](../enums/RequirementType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CUSTOM", + "type": "``\"custom\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEFAULT", + "type": "``\"default\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "GIFT_CARD", + "type": "``\"gift_card\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/ShippingTaxRate.md b/www/apps/docs/content/references/entities/classes/ShippingTaxRate.md deleted file mode 100644 index e632cce14c..0000000000 --- a/www/apps/docs/content/references/entities/classes/ShippingTaxRate.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: ShippingTaxRate - -## Constructors - -### constructor - -• **new ShippingTaxRate**() - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Defined in - -[models/shipping-tax-rate.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-tax-rate.ts#L31) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/shipping-tax-rate.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-tax-rate.ts#L37) - -___ - -### rate\_id - -• **rate\_id**: `string` - -#### Defined in - -[models/shipping-tax-rate.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-tax-rate.ts#L20) - -___ - -### shipping\_option - -• `Optional` **shipping\_option**: [`ShippingOption`](ShippingOption.md) - -#### Defined in - -[models/shipping-tax-rate.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-tax-rate.ts#L24) - -___ - -### shipping\_option\_id - -• **shipping\_option\_id**: `string` - -#### Defined in - -[models/shipping-tax-rate.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-tax-rate.ts#L17) - -___ - -### tax\_rate - -• `Optional` **tax\_rate**: [`TaxRate`](TaxRate.md) - -#### Defined in - -[models/shipping-tax-rate.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-tax-rate.ts#L28) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Defined in - -[models/shipping-tax-rate.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-tax-rate.ts#L34) diff --git a/www/apps/docs/content/references/entities/classes/ShippingTaxRate.mdx b/www/apps/docs/content/references/entities/classes/ShippingTaxRate.mdx new file mode 100644 index 0000000000..2d634fea1f --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/ShippingTaxRate.mdx @@ -0,0 +1,1455 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingTaxRate + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CALCULATED", + "type": "``\"calculated\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FLAT_RATE", + "type": "``\"flat_rate\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`RequirementType`](../enums/RequirementType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "[`TaxRate`](TaxRate.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TaxRate`](TaxRate.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_type_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_types", + "type": "[`ProductType`](ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/StagedJob.md b/www/apps/docs/content/references/entities/classes/StagedJob.md deleted file mode 100644 index 743c32fc79..0000000000 --- a/www/apps/docs/content/references/entities/classes/StagedJob.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: StagedJob - -## Constructors - -### constructor - -• **new StagedJob**() - -## Properties - -### data - -• **data**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/staged-job.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/staged-job.ts#L15) - -___ - -### event\_name - -• **event\_name**: `string` - -#### Defined in - -[models/staged-job.ts:12](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/staged-job.ts#L12) - -___ - -### id - -• **id**: `string` - -#### Defined in - -[models/staged-job.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/staged-job.ts#L9) - -___ - -### options - -• **options**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/staged-job.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/staged-job.ts#L18) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/staged-job.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/staged-job.ts#L21) diff --git a/www/apps/docs/content/references/entities/classes/StagedJob.mdx b/www/apps/docs/content/references/entities/classes/StagedJob.mdx new file mode 100644 index 0000000000..0012f2802c --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/StagedJob.mdx @@ -0,0 +1,44 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# StagedJob + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "event_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Store.md b/www/apps/docs/content/references/entities/classes/Store.md deleted file mode 100644 index 920ee0cb2d..0000000000 --- a/www/apps/docs/content/references/entities/classes/Store.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Store - -## Hierarchy - -- `BaseEntity` - - ↳ **`Store`** - -## Constructors - -### constructor - -• **new Store**() - -#### Inherited from - -BaseEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -BaseEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### currencies - -• **currencies**: [`Currency`](Currency.md)[] - -#### Defined in - -[models/store.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/store.ts#L46) - -___ - -### default\_currency - -• **default\_currency**: [`Currency`](Currency.md) - -#### Defined in - -[models/store.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/store.ts#L32) - -___ - -### default\_currency\_code - -• **default\_currency\_code**: `string` - -#### Defined in - -[models/store.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/store.ts#L28) - -___ - -### default\_location\_id - -• **default\_location\_id**: `string` - -#### Defined in - -[models/store.ts:58](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/store.ts#L58) - -___ - -### default\_sales\_channel - -• **default\_sales\_channel**: [`SalesChannel`](SalesChannel.md) - -#### Defined in - -[models/store.ts:70](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/store.ts#L70) - -___ - -### default\_sales\_channel\_id - -• **default\_sales\_channel\_id**: ``null`` \| `string` - -#### Defined in - -[models/store.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/store.ts#L64) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -BaseEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### invite\_link\_template - -• **invite\_link\_template**: ``null`` \| `string` - -#### Defined in - -[models/store.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/store.ts#L55) - -___ - -### metadata - -• **metadata**: ``null`` \| `Record`<`string`, `unknown`\> - -#### Defined in - -[models/store.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/store.ts#L61) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[models/store.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/store.ts#L25) - -___ - -### payment\_link\_template - -• **payment\_link\_template**: ``null`` \| `string` - -#### Defined in - -[models/store.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/store.ts#L52) - -___ - -### swap\_link\_template - -• **swap\_link\_template**: ``null`` \| `string` - -#### Defined in - -[models/store.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/store.ts#L49) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -BaseEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/store.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/store.ts#L73) diff --git a/www/apps/docs/content/references/entities/classes/Store.mdx b/www/apps/docs/content/references/entities/classes/Store.mdx new file mode 100644 index 0000000000..0657e4cc6f --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Store.mdx @@ -0,0 +1,384 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Store + +## Properties + + [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "default_currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "default_currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "default_location_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "default_sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannelLocation`](SalesChannelLocation.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "default_sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "invite_link_template", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_link_template", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_link_template", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/Swap.md b/www/apps/docs/content/references/entities/classes/Swap.md deleted file mode 100644 index 17413ea0a4..0000000000 --- a/www/apps/docs/content/references/entities/classes/Swap.md +++ /dev/null @@ -1,291 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: Swap - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`Swap`** - -## Constructors - -### constructor - -• **new Swap**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### additional\_items - -• **additional\_items**: [`LineItem`](LineItem.md)[] - -#### Defined in - -[models/swap.ts:62](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L62) - -___ - -### allow\_backorder - -• **allow\_backorder**: `boolean` - -#### Defined in - -[models/swap.ts:107](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L107) - -___ - -### canceled\_at - -• **canceled\_at**: `Date` - -#### Defined in - -[models/swap.ts:101](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L101) - -___ - -### cart - -• **cart**: [`Cart`](Cart.md) - -#### Defined in - -[models/swap.ts:95](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L95) - -___ - -### cart\_id - -• **cart\_id**: `string` - -#### Defined in - -[models/swap.ts:91](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L91) - -___ - -### confirmed\_at - -• **confirmed\_at**: `Date` - -#### Defined in - -[models/swap.ts:98](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L98) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### difference\_due - -• **difference\_due**: `number` - -#### Defined in - -[models/swap.ts:76](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L76) - -___ - -### fulfillment\_status - -• **fulfillment\_status**: [`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.md) - -#### Defined in - -[models/swap.ts:48](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L48) - -___ - -### fulfillments - -• **fulfillments**: [`Fulfillment`](Fulfillment.md)[] - -#### Defined in - -[models/swap.ts:70](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L70) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -[models/swap.ts:110](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L110) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/swap.ts:113](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L113) - -___ - -### no\_notification - -• **no\_notification**: `boolean` - -#### Defined in - -[models/swap.ts:104](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L104) - -___ - -### order - -• **order**: [`Order`](Order.md) - -#### Defined in - -[models/swap.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L59) - -___ - -### order\_id - -• **order\_id**: `string` - -#### Defined in - -[models/swap.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L55) - -___ - -### payment - -• **payment**: [`Payment`](Payment.md) - -#### Defined in - -[models/swap.ts:73](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L73) - -___ - -### payment\_status - -• **payment\_status**: [`SwapPaymentStatus`](../enums/SwapPaymentStatus.md) - -#### Defined in - -[models/swap.ts:51](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L51) - -___ - -### return\_order - -• **return\_order**: [`Return`](Return.md) - -#### Defined in - -[models/swap.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L65) - -___ - -### shipping\_address - -• **shipping\_address**: [`Address`](Address.md) - -#### Defined in - -[models/swap.ts:83](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L83) - -___ - -### shipping\_address\_id - -• **shipping\_address\_id**: `string` - -#### Defined in - -[models/swap.ts:79](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L79) - -___ - -### shipping\_methods - -• **shipping\_methods**: [`ShippingMethod`](ShippingMethod.md)[] - -#### Defined in - -[models/swap.ts:88](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L88) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/swap.ts:116](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L116) diff --git a/www/apps/docs/content/references/entities/classes/Swap.mdx b/www/apps/docs/content/references/entities/classes/Swap.mdx new file mode 100644 index 0000000000..1f3ae71715 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/Swap.mdx @@ -0,0 +1,14791 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# Swap + +## Properties + + [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemAdjustment`](LineItemAdjustment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItemTaxLine`](LineItemTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_initiated", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_selected", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CLAIM", + "type": "``\"claim\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEFAULT", + "type": "``\"default\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DRAFT_ORDER", + "type": "``\"draft_order\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PAYMENT_LINK", + "type": "``\"payment_link\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SWAP", + "type": "``\"swap\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentItem`](FulfillmentItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment", + "type": "[`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TrackingLink`](TrackingLink.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment", + "type": "[`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_number", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "groups", + "type": "[`CustomerGroup`](CustomerGroup.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "has_account", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "orders", + "type": "[`Order`](Order.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_addresses", + "type": "[`Address`](Address.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_dynamic", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount", + "type": "[`Discount`](Discount.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_discount_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "regions", + "type": "[`Region`](Region.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule", + "type": "[`DiscountRule`](DiscountRule.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "starts_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_count", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "usage_limit", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "valid_duration", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upperCaseCodeAndTrim", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification_order", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`DraftOrderStatus`](../enums/DraftOrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "changes", + "type": "[`OrderItemChange`](OrderItemChange.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_by", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "declined_reason", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "internal_note", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection", + "type": "[`PaymentCollection`](PaymentCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_collection_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_at", + "type": "`Date`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_by", + "type": "`string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderEditStatus`](../enums/OrderEditStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "loadStatus", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FULFILLED", + "type": "``\"fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_FULFILLED", + "type": "``\"not_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_FULFILLED", + "type": "``\"partially_fulfilled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_RETURNED", + "type": "``\"partially_returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_SHIPPED", + "type": "``\"partially_shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RETURNED", + "type": "``\"returned\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "SHIPPED", + "type": "``\"shipped\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCardTransaction`](GiftCardTransaction.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card", + "type": "[`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`GiftCard`](GiftCard.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "balance", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ends_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Refund`](Refund.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "adjustments", + "type": "[`LineItemAdjustment`](LineItemAdjustment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_discounts", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfilled_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "has_shipping", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit", + "type": "``null`` \\| [`OrderEdit`](OrderEdit.mdx)", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_edit_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "original_item_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "original_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returned_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_quantity", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "should_merge", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`LineItemTaxLine`](LineItemTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "unit_price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant", + "type": "[`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterUpdateOrLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ARCHIVED", + "type": "``\"archived\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "COMPLETED", + "type": "``\"completed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PENDING", + "type": "``\"pending\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount_refunded", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "captured_at", + "type": "`string` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "AWAITING", + "type": "``\"awaiting\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CAPTURED", + "type": "``\"captured\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "CONFIRMED", + "type": "``\"confirmed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DIFFERENCE_REFUNDED", + "type": "``\"difference_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "NOT_PAID", + "type": "``\"not_paid\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PARTIALLY_REFUNDED", + "type": "``\"partially_refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REFUNDED", + "type": "``\"refunded\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ReturnItem`](ReturnItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_requested", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "note", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason", + "type": "[`ReturnReason`](ReturnReason.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "reason_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requested_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CANCELED", + "type": "``\"canceled\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "RECEIVED", + "type": "``\"received\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUESTED", + "type": "``\"requested\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REQUIRES_ACTION", + "type": "``\"requires_action\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_1", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "address_2", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "city", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "company", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country", + "type": "``null`` \\| [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "country_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "``null`` \\| [`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "first_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "last_name", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "phone", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "postal_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "province", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "completed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "context", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"cart\"``", + "description": "", + "optional": false, + "defaultValue": "`\"cart\"`", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_authorized_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_session", + "type": "``null`` \\| [`PaymentSession`](PaymentSession.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_sessions", + "type": "[`PaymentSession`](PaymentSession.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "``null`` \\| [`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`CartType`](../enums/CartType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`ReturnItem`](ReturnItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "``null`` \\| `boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "received_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`ReturnStatus`](../enums/ReturnStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_lines", + "type": "[`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingMethodTaxLine`](ShippingMethodTaxLine.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method", + "type": "[`ShippingMethod`](ShippingMethod.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_method_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/TaxProvider.md b/www/apps/docs/content/references/entities/classes/TaxProvider.md deleted file mode 100644 index cc65f19075..0000000000 --- a/www/apps/docs/content/references/entities/classes/TaxProvider.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: TaxProvider - -## Constructors - -### constructor - -• **new TaxProvider**() - -## Properties - -### id - -• **id**: `string` - -#### Defined in - -[models/tax-provider.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-provider.ts#L6) - -___ - -### is\_installed - -• **is\_installed**: `boolean` - -#### Defined in - -[models/tax-provider.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-provider.ts#L9) diff --git a/www/apps/docs/content/references/entities/classes/TaxProvider.mdx b/www/apps/docs/content/references/entities/classes/TaxProvider.mdx new file mode 100644 index 0000000000..28edf131f8 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/TaxProvider.mdx @@ -0,0 +1,28 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# TaxProvider + +## Properties + + diff --git a/www/apps/docs/content/references/entities/classes/TaxRate.md b/www/apps/docs/content/references/entities/classes/TaxRate.md deleted file mode 100644 index 6dc2556d31..0000000000 --- a/www/apps/docs/content/references/entities/classes/TaxRate.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: TaxRate - -## Hierarchy - -- `BaseEntity` - - ↳ **`TaxRate`** - -## Constructors - -### constructor - -• **new TaxRate**() - -#### Inherited from - -BaseEntity.constructor - -## Properties - -### code - -• **code**: ``null`` \| `string` - -#### Defined in - -[models/tax-rate.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-rate.ts#L25) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -BaseEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -BaseEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/tax-rate.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-rate.ts#L38) - -___ - -### name - -• **name**: `string` - -#### Defined in - -[models/tax-rate.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-rate.ts#L28) - -___ - -### product\_count - -• `Optional` **product\_count**: `number` - -#### Defined in - -[models/tax-rate.ts:83](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-rate.ts#L83) - -___ - -### product\_type\_count - -• `Optional` **product\_type\_count**: `number` - -#### Defined in - -[models/tax-rate.ts:84](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-rate.ts#L84) - -___ - -### product\_types - -• **product\_types**: [`ProductType`](ProductType.md)[] - -#### Defined in - -[models/tax-rate.ts:66](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-rate.ts#L66) - -___ - -### products - -• **products**: [`Product`](Product.md)[] - -#### Defined in - -[models/tax-rate.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-rate.ts#L52) - -___ - -### rate - -• **rate**: ``null`` \| `number` - -#### Defined in - -[models/tax-rate.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-rate.ts#L22) - -___ - -### region - -• **region**: [`Region`](Region.md) - -#### Defined in - -[models/tax-rate.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-rate.ts#L35) - -___ - -### region\_id - -• **region\_id**: `string` - -#### Defined in - -[models/tax-rate.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-rate.ts#L31) - -___ - -### shipping\_option\_count - -• `Optional` **shipping\_option\_count**: `number` - -#### Defined in - -[models/tax-rate.ts:85](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-rate.ts#L85) - -___ - -### shipping\_options - -• **shipping\_options**: [`ShippingOption`](ShippingOption.md)[] - -#### Defined in - -[models/tax-rate.ts:80](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-rate.ts#L80) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -BaseEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/tax-rate.ts:88](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tax-rate.ts#L88) diff --git a/www/apps/docs/content/references/entities/classes/TaxRate.mdx b/www/apps/docs/content/references/entities/classes/TaxRate.mdx new file mode 100644 index 0000000000..3c24542636 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/TaxRate.mdx @@ -0,0 +1,2453 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# TaxRate + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_type_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "product_types", + "type": "[`ProductType`](ProductType.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "categories", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "category_children", + "type": "[`ProductCategory`](ProductCategory.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_active", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_internal", + "type": "`Boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category", + "type": "``null`` \\| [`ProductCategory`](ProductCategory.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "parent_category_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rank", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "productCategoryProductJoinTable", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "`\"product_category_product\"`", + "children": [] + }, + { + "name": "treeRelations", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection", + "type": "[`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductCollection`](ProductCollection.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "createHandleIfNotProvided", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "collection_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discountable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "handle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "images", + "type": "[`Image`](Image.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Image`](Image.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "is_giftcard", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOption`](ProductOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductOption`](ProductOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "values", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "profiles", + "type": "[`ShippingProfile`](ShippingProfile.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "sales_channels", + "type": "[`SalesChannel`](SalesChannel.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "description", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_disabled", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "locations", + "type": "[`SalesChannelLocation`](SalesChannelLocation.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "status", + "type": "[`ProductStatus`](../enums/ProductStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "DRAFT", + "type": "``\"draft\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PROPOSED", + "type": "``\"proposed\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "PUBLISHED", + "type": "``\"published\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "REJECTED", + "type": "``\"rejected\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "subtitle", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tags", + "type": "[`ProductTag`](ProductTag.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductTag`](ProductTag.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "thumbnail", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductType`](ProductType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "type_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variants", + "type": "[`ProductVariant`](ProductVariant.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ProductVariant`](ProductVariant.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "barcode", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "ean", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "height", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "hs_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_items", + "type": "[`ProductVariantInventoryItem`](ProductVariantInventoryItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inventory_quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "length", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "manage_inventory", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "material", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "``null`` \\| Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "mid_code", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "options", + "type": "[`ProductOptionValue`](ProductOptionValue.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "origin_country", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "prices", + "type": "[`MoneyAmount`](MoneyAmount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product", + "type": "[`Product`](Product.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "product_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "purchasable", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "sku", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "upc", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "variant_rank", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "weight", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "width", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "afterLoad", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeUpdate", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Country`](Country.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_2", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "iso_3", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "num_code", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`PaymentProvider`](PaymentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_count", + "type": "`number`", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "admin_only", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_return", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_type", + "type": "[`ShippingOptionPriceType`](../enums/ShippingOptionPriceType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "CALCULATED", + "type": "``\"calculated\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "FLAT_RATE", + "type": "``\"flat_rate\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile", + "type": "[`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingProfile`](ShippingProfile.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "products", + "type": "[`Product`](Product.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_options", + "type": "[`ShippingOption`](ShippingOption.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ShippingProfileType`](../enums/ShippingProfileType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "profile_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "automatic_taxes", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "countries", + "type": "[`Country`](Country.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_providers", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards_taxable", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "includes_tax", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_providers", + "type": "[`PaymentProvider`](PaymentProvider.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider", + "type": "[`TaxProvider`](TaxProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_provider_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rates", + "type": "``null`` \\| [`TaxRate`](TaxRate.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "requirements", + "type": "[`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ShippingOptionRequirement`](ShippingOptionRequirement.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option", + "type": "[`ShippingOption`](ShippingOption.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_option_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`RequirementType`](../enums/RequirementType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/TrackingLink.md b/www/apps/docs/content/references/entities/classes/TrackingLink.md deleted file mode 100644 index 17f8e5e855..0000000000 --- a/www/apps/docs/content/references/entities/classes/TrackingLink.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: TrackingLink - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`TrackingLink`** - -## Constructors - -### constructor - -• **new TrackingLink**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### fulfillment - -• **fulfillment**: [`Fulfillment`](Fulfillment.md) - -#### Defined in - -[models/tracking-link.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tracking-link.ts#L21) - -___ - -### fulfillment\_id - -• **fulfillment\_id**: `string` - -#### Defined in - -[models/tracking-link.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tracking-link.ts#L17) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### idempotency\_key - -• **idempotency\_key**: `string` - -#### Defined in - -[models/tracking-link.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tracking-link.ts#L24) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/tracking-link.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tracking-link.ts#L27) - -___ - -### tracking\_number - -• **tracking\_number**: `string` - -#### Defined in - -[models/tracking-link.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tracking-link.ts#L14) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -___ - -### url - -• **url**: `string` - -#### Defined in - -[models/tracking-link.ts:11](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tracking-link.ts#L11) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/tracking-link.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/tracking-link.ts#L30) diff --git a/www/apps/docs/content/references/entities/classes/TrackingLink.mdx b/www/apps/docs/content/references/entities/classes/TrackingLink.mdx new file mode 100644 index 0000000000..033a90f187 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/TrackingLink.mdx @@ -0,0 +1,1315 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# TrackingLink + +## Properties + + [`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_order", + "type": "[`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`ClaimOrder`](ClaimOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claim_items", + "type": "[`ClaimItem`](ClaimItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`ClaimFulfillmentStatus`](../enums/ClaimFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`ClaimPaymentStatus`](../enums/ClaimPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refund_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "type", + "type": "[`ClaimType`](../enums/ClaimType.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "claim_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "data", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`FulfillmentItem`](FulfillmentItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentItem`](FulfillmentItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment", + "type": "[`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item", + "type": "[`LineItem`](LineItem.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "quantity", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "location_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "billing_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "claims", + "type": "[`ClaimOrder`](ClaimOrder.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`Currency`](Currency.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer", + "type": "[`Customer`](Customer.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "customer_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "discounts", + "type": "[`Discount`](Discount.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "display_id", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order", + "type": "[`DraftOrder`](DraftOrder.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "draft_order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "edits", + "type": "[`OrderEdit`](OrderEdit.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "email", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "external_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`FulfillmentStatus`](../enums/FulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_tax_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_card_transactions", + "type": "[`GiftCardTransaction`](GiftCardTransaction.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "gift_cards", + "type": "[`GiftCard`](GiftCard.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "item_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "object", + "type": "``\"order\"``", + "description": "", + "optional": false, + "defaultValue": "`\"order\"`", + "children": [] + }, + { + "name": "paid_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`PaymentStatus`](../enums/PaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payments", + "type": "[`Payment`](Payment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "raw_discount_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refundable_amount", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunded_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "refunds", + "type": "[`Refund`](Refund.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region", + "type": "[`Region`](Region.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "region_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "returnable_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "returns", + "type": "[`Return`](Return.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel", + "type": "[`SalesChannel`](SalesChannel.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "sales_channel_id", + "type": "``null`` \\| `string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "status", + "type": "[`OrderStatus`](../enums/OrderStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "subtotal", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swaps", + "type": "[`Swap`](Swap.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_rate", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tax_total", + "type": "``null`` \\| `number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "total", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `Promise`<`void`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "provider", + "type": "[`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`FulfillmentProvider`](FulfillmentProvider.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "is_installed", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "provider_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipped_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "swap", + "type": "[`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`Swap`](Swap.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "additional_items", + "type": "[`LineItem`](LineItem.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "allow_backorder", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "canceled_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart", + "type": "[`Cart`](Cart.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "cart_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "confirmed_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "difference_due", + "type": "`number`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_status", + "type": "[`SwapFulfillmentStatus`](../enums/SwapFulfillmentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillments", + "type": "[`Fulfillment`](Fulfillment.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "no_notification", + "type": "`boolean`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order", + "type": "[`Order`](Order.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "order_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment", + "type": "[`Payment`](Payment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "payment_status", + "type": "[`SwapPaymentStatus`](../enums/SwapPaymentStatus.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "return_order", + "type": "[`Return`](Return.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address", + "type": "[`Address`](Address.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_address_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "shipping_methods", + "type": "[`ShippingMethod`](ShippingMethod.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "swap_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_links", + "type": "[`TrackingLink`](TrackingLink.mdx)[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "constructor", + "type": "() => [`TrackingLink`](TrackingLink.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "created_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "deleted_at", + "type": "``null`` \\| `Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment", + "type": "[`Fulfillment`](Fulfillment.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "fulfillment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_number", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "tracking_numbers", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "beforeInsert", + "type": "() => `void`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "fulfillment_id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "idempotency_key", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "metadata", + "type": "Record<`string`, `unknown`\\>", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "tracking_number", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "url", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/classes/User.md b/www/apps/docs/content/references/entities/classes/User.md deleted file mode 100644 index d8035b6829..0000000000 --- a/www/apps/docs/content/references/entities/classes/User.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Class: User - -## Hierarchy - -- `SoftDeletableEntity` - - ↳ **`User`** - -## Constructors - -### constructor - -• **new User**() - -#### Inherited from - -SoftDeletableEntity.constructor - -## Properties - -### api\_token - -• **api\_token**: `string` - -#### Defined in - -[models/user.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/user.ts#L37) - -___ - -### created\_at - -• **created\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.created\_at - -#### Defined in - -[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L16) - -___ - -### deleted\_at - -• **deleted\_at**: ``null`` \| `Date` - -#### Inherited from - -SoftDeletableEntity.deleted\_at - -#### Defined in - -[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7) - -___ - -### email - -• **email**: `string` - -#### Defined in - -[models/user.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/user.ts#L25) - -___ - -### first\_name - -• **first\_name**: `string` - -#### Defined in - -[models/user.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/user.ts#L28) - -___ - -### id - -• **id**: `string` - -#### Inherited from - -SoftDeletableEntity.id - -#### Defined in - -[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L13) - -___ - -### last\_name - -• **last\_name**: `string` - -#### Defined in - -[models/user.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/user.ts#L31) - -___ - -### metadata - -• **metadata**: `Record`<`string`, `unknown`\> - -#### Defined in - -[models/user.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/user.ts#L40) - -___ - -### password\_hash - -• **password\_hash**: `string` - -#### Defined in - -[models/user.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/user.ts#L34) - -___ - -### role - -• **role**: [`UserRoles`](../enums/UserRoles.md) - -#### Defined in - -[models/user.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/user.ts#L21) - -___ - -### updated\_at - -• **updated\_at**: `Date` - -#### Inherited from - -SoftDeletableEntity.updated\_at - -#### Defined in - -[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/models/base-entity.ts#L19) - -## Methods - -### beforeInsert - -▸ `Private` **beforeInsert**(): `void` - -#### Returns - -`void` - -#### Defined in - -[models/user.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/user.ts#L43) diff --git a/www/apps/docs/content/references/entities/classes/User.mdx b/www/apps/docs/content/references/entities/classes/User.mdx new file mode 100644 index 0000000000..ab2ef70bf9 --- /dev/null +++ b/www/apps/docs/content/references/entities/classes/User.mdx @@ -0,0 +1,125 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# User + +## Properties + +", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "password_hash", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "role", + "type": "[`UserRoles`](../enums/UserRoles.mdx)", + "description": "", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "ADMIN", + "type": "``\"admin\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "DEVELOPER", + "type": "``\"developer\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "MEMBER", + "type": "``\"member\"``", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "updated_at", + "type": "`Date`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/entities/enums/AllocationType.md b/www/apps/docs/content/references/entities/enums/AllocationType.md deleted file mode 100644 index 5d20392e58..0000000000 --- a/www/apps/docs/content/references/entities/enums/AllocationType.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: AllocationType - -## Enumeration Members - -### ITEM - -• **ITEM** = ``"item"`` - -#### Defined in - -[models/discount-rule.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L16) - -___ - -### TOTAL - -• **TOTAL** = ``"total"`` - -#### Defined in - -[models/discount-rule.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L15) diff --git a/www/apps/docs/content/references/entities/enums/AllocationType.mdx b/www/apps/docs/content/references/entities/enums/AllocationType.mdx new file mode 100644 index 0000000000..cd487a9597 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/AllocationType.mdx @@ -0,0 +1,19 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# AllocationType + +## Enumeration Members + +### ITEM + + **ITEM** = ``"item"`` + +___ + +### TOTAL + + **TOTAL** = ``"total"`` diff --git a/www/apps/docs/content/references/entities/enums/CartType.md b/www/apps/docs/content/references/entities/enums/CartType.md deleted file mode 100644 index 032f4eed8b..0000000000 --- a/www/apps/docs/content/references/entities/enums/CartType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: CartType - -## Enumeration Members - -### CLAIM - -• **CLAIM** = ``"claim"`` - -#### Defined in - -[models/cart.ts:270](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L270) - -___ - -### DEFAULT - -• **DEFAULT** = ``"default"`` - -#### Defined in - -[models/cart.ts:266](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L266) - -___ - -### DRAFT\_ORDER - -• **DRAFT\_ORDER** = ``"draft_order"`` - -#### Defined in - -[models/cart.ts:268](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L268) - -___ - -### PAYMENT\_LINK - -• **PAYMENT\_LINK** = ``"payment_link"`` - -#### Defined in - -[models/cart.ts:269](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L269) - -___ - -### SWAP - -• **SWAP** = ``"swap"`` - -#### Defined in - -[models/cart.ts:267](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/cart.ts#L267) diff --git a/www/apps/docs/content/references/entities/enums/CartType.mdx b/www/apps/docs/content/references/entities/enums/CartType.mdx new file mode 100644 index 0000000000..bfdc2ef588 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/CartType.mdx @@ -0,0 +1,37 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# CartType + +## Enumeration Members + +### CLAIM + + **CLAIM** = ``"claim"`` + +___ + +### DEFAULT + + **DEFAULT** = ``"default"`` + +___ + +### DRAFT\_ORDER + + **DRAFT\_ORDER** = ``"draft_order"`` + +___ + +### PAYMENT\_LINK + + **PAYMENT\_LINK** = ``"payment_link"`` + +___ + +### SWAP + + **SWAP** = ``"swap"`` diff --git a/www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.md b/www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.md deleted file mode 100644 index 57d3ff8c66..0000000000 --- a/www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: ClaimFulfillmentStatus - -## Enumeration Members - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -[models/claim-order.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L45) - -___ - -### FULFILLED - -• **FULFILLED** = ``"fulfilled"`` - -#### Defined in - -[models/claim-order.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L40) - -___ - -### NOT\_FULFILLED - -• **NOT\_FULFILLED** = ``"not_fulfilled"`` - -#### Defined in - -[models/claim-order.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L38) - -___ - -### PARTIALLY\_FULFILLED - -• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` - -#### Defined in - -[models/claim-order.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L39) - -___ - -### PARTIALLY\_RETURNED - -• **PARTIALLY\_RETURNED** = ``"partially_returned"`` - -#### Defined in - -[models/claim-order.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L43) - -___ - -### PARTIALLY\_SHIPPED - -• **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` - -#### Defined in - -[models/claim-order.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L41) - -___ - -### REQUIRES\_ACTION - -• **REQUIRES\_ACTION** = ``"requires_action"`` - -#### Defined in - -[models/claim-order.ts:46](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L46) - -___ - -### RETURNED - -• **RETURNED** = ``"returned"`` - -#### Defined in - -[models/claim-order.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L44) - -___ - -### SHIPPED - -• **SHIPPED** = ``"shipped"`` - -#### Defined in - -[models/claim-order.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L42) diff --git a/www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.mdx b/www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.mdx new file mode 100644 index 0000000000..1dd7d402f2 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/ClaimFulfillmentStatus.mdx @@ -0,0 +1,61 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimFulfillmentStatus + +## Enumeration Members + +### CANCELED + + **CANCELED** = ``"canceled"`` + +___ + +### FULFILLED + + **FULFILLED** = ``"fulfilled"`` + +___ + +### NOT\_FULFILLED + + **NOT\_FULFILLED** = ``"not_fulfilled"`` + +___ + +### PARTIALLY\_FULFILLED + + **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` + +___ + +### PARTIALLY\_RETURNED + + **PARTIALLY\_RETURNED** = ``"partially_returned"`` + +___ + +### PARTIALLY\_SHIPPED + + **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` + +___ + +### REQUIRES\_ACTION + + **REQUIRES\_ACTION** = ``"requires_action"`` + +___ + +### RETURNED + + **RETURNED** = ``"returned"`` + +___ + +### SHIPPED + + **SHIPPED** = ``"shipped"`` diff --git a/www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.md b/www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.md deleted file mode 100644 index 7f0b340bbc..0000000000 --- a/www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: ClaimPaymentStatus - -## Enumeration Members - -### NA - -• **NA** = ``"na"`` - -#### Defined in - -[models/claim-order.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L32) - -___ - -### NOT\_REFUNDED - -• **NOT\_REFUNDED** = ``"not_refunded"`` - -#### Defined in - -[models/claim-order.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L33) - -___ - -### REFUNDED - -• **REFUNDED** = ``"refunded"`` - -#### Defined in - -[models/claim-order.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L34) diff --git a/www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.mdx b/www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.mdx new file mode 100644 index 0000000000..c0a905dbe7 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/ClaimPaymentStatus.mdx @@ -0,0 +1,25 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimPaymentStatus + +## Enumeration Members + +### NA + + **NA** = ``"na"`` + +___ + +### NOT\_REFUNDED + + **NOT\_REFUNDED** = ``"not_refunded"`` + +___ + +### REFUNDED + + **REFUNDED** = ``"refunded"`` diff --git a/www/apps/docs/content/references/entities/enums/ClaimReason.md b/www/apps/docs/content/references/entities/enums/ClaimReason.md deleted file mode 100644 index 4d9f87169f..0000000000 --- a/www/apps/docs/content/references/entities/enums/ClaimReason.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: ClaimReason - -## Enumeration Members - -### MISSING\_ITEM - -• **MISSING\_ITEM** = ``"missing_item"`` - -#### Defined in - -[models/claim-item.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L23) - -___ - -### OTHER - -• **OTHER** = ``"other"`` - -#### Defined in - -[models/claim-item.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L26) - -___ - -### PRODUCTION\_FAILURE - -• **PRODUCTION\_FAILURE** = ``"production_failure"`` - -#### Defined in - -[models/claim-item.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L25) - -___ - -### WRONG\_ITEM - -• **WRONG\_ITEM** = ``"wrong_item"`` - -#### Defined in - -[models/claim-item.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-item.ts#L24) diff --git a/www/apps/docs/content/references/entities/enums/ClaimReason.mdx b/www/apps/docs/content/references/entities/enums/ClaimReason.mdx new file mode 100644 index 0000000000..7e4c39c018 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/ClaimReason.mdx @@ -0,0 +1,31 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimReason + +## Enumeration Members + +### MISSING\_ITEM + + **MISSING\_ITEM** = ``"missing_item"`` + +___ + +### OTHER + + **OTHER** = ``"other"`` + +___ + +### PRODUCTION\_FAILURE + + **PRODUCTION\_FAILURE** = ``"production_failure"`` + +___ + +### WRONG\_ITEM + + **WRONG\_ITEM** = ``"wrong_item"`` diff --git a/www/apps/docs/content/references/entities/enums/ClaimType.md b/www/apps/docs/content/references/entities/enums/ClaimType.md deleted file mode 100644 index 413e7172d8..0000000000 --- a/www/apps/docs/content/references/entities/enums/ClaimType.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: ClaimType - -## Enumeration Members - -### REFUND - -• **REFUND** = ``"refund"`` - -#### Defined in - -[models/claim-order.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L27) - -___ - -### REPLACE - -• **REPLACE** = ``"replace"`` - -#### Defined in - -[models/claim-order.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/claim-order.ts#L28) diff --git a/www/apps/docs/content/references/entities/enums/ClaimType.mdx b/www/apps/docs/content/references/entities/enums/ClaimType.mdx new file mode 100644 index 0000000000..d326148b1f --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/ClaimType.mdx @@ -0,0 +1,19 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ClaimType + +## Enumeration Members + +### REFUND + + **REFUND** = ``"refund"`` + +___ + +### REPLACE + + **REPLACE** = ``"replace"`` diff --git a/www/apps/docs/content/references/entities/enums/DiscountConditionOperator.md b/www/apps/docs/content/references/entities/enums/DiscountConditionOperator.md deleted file mode 100644 index a57adb6f53..0000000000 --- a/www/apps/docs/content/references/entities/enums/DiscountConditionOperator.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: DiscountConditionOperator - -## Enumeration Members - -### IN - -• **IN** = ``"in"`` - -#### Defined in - -[models/discount-condition.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L34) - -___ - -### NOT\_IN - -• **NOT\_IN** = ``"not_in"`` - -#### Defined in - -[models/discount-condition.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L35) diff --git a/www/apps/docs/content/references/entities/enums/DiscountConditionOperator.mdx b/www/apps/docs/content/references/entities/enums/DiscountConditionOperator.mdx new file mode 100644 index 0000000000..4912cf2819 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/DiscountConditionOperator.mdx @@ -0,0 +1,19 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionOperator + +## Enumeration Members + +### IN + + **IN** = ``"in"`` + +___ + +### NOT\_IN + + **NOT\_IN** = ``"not_in"`` diff --git a/www/apps/docs/content/references/entities/enums/DiscountConditionType.md b/www/apps/docs/content/references/entities/enums/DiscountConditionType.md deleted file mode 100644 index 9953cafdce..0000000000 --- a/www/apps/docs/content/references/entities/enums/DiscountConditionType.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: DiscountConditionType - -## Enumeration Members - -### CUSTOMER\_GROUPS - -• **CUSTOMER\_GROUPS** = ``"customer_groups"`` - -#### Defined in - -[models/discount-condition.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L30) - -___ - -### PRODUCTS - -• **PRODUCTS** = ``"products"`` - -#### Defined in - -[models/discount-condition.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L26) - -___ - -### PRODUCT\_COLLECTIONS - -• **PRODUCT\_COLLECTIONS** = ``"product_collections"`` - -#### Defined in - -[models/discount-condition.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L28) - -___ - -### PRODUCT\_TAGS - -• **PRODUCT\_TAGS** = ``"product_tags"`` - -#### Defined in - -[models/discount-condition.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L29) - -___ - -### PRODUCT\_TYPES - -• **PRODUCT\_TYPES** = ``"product_types"`` - -#### Defined in - -[models/discount-condition.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-condition.ts#L27) diff --git a/www/apps/docs/content/references/entities/enums/DiscountConditionType.mdx b/www/apps/docs/content/references/entities/enums/DiscountConditionType.mdx new file mode 100644 index 0000000000..3f5855f2c2 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/DiscountConditionType.mdx @@ -0,0 +1,37 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountConditionType + +## Enumeration Members + +### CUSTOMER\_GROUPS + + **CUSTOMER\_GROUPS** = ``"customer_groups"`` + +___ + +### PRODUCTS + + **PRODUCTS** = ``"products"`` + +___ + +### PRODUCT\_COLLECTIONS + + **PRODUCT\_COLLECTIONS** = ``"product_collections"`` + +___ + +### PRODUCT\_TAGS + + **PRODUCT\_TAGS** = ``"product_tags"`` + +___ + +### PRODUCT\_TYPES + + **PRODUCT\_TYPES** = ``"product_types"`` diff --git a/www/apps/docs/content/references/entities/enums/DiscountRuleType.md b/www/apps/docs/content/references/entities/enums/DiscountRuleType.md deleted file mode 100644 index f3bb28eb47..0000000000 --- a/www/apps/docs/content/references/entities/enums/DiscountRuleType.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: DiscountRuleType - -## Enumeration Members - -### FIXED - -• **FIXED** = ``"fixed"`` - -#### Defined in - -[models/discount-rule.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L9) - -___ - -### FREE\_SHIPPING - -• **FREE\_SHIPPING** = ``"free_shipping"`` - -#### Defined in - -[models/discount-rule.ts:11](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L11) - -___ - -### PERCENTAGE - -• **PERCENTAGE** = ``"percentage"`` - -#### Defined in - -[models/discount-rule.ts:10](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/discount-rule.ts#L10) diff --git a/www/apps/docs/content/references/entities/enums/DiscountRuleType.mdx b/www/apps/docs/content/references/entities/enums/DiscountRuleType.mdx new file mode 100644 index 0000000000..f67d420cc9 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/DiscountRuleType.mdx @@ -0,0 +1,25 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DiscountRuleType + +## Enumeration Members + +### FIXED + + **FIXED** = ``"fixed"`` + +___ + +### FREE\_SHIPPING + + **FREE\_SHIPPING** = ``"free_shipping"`` + +___ + +### PERCENTAGE + + **PERCENTAGE** = ``"percentage"`` diff --git a/www/apps/docs/content/references/entities/enums/DraftOrderStatus.md b/www/apps/docs/content/references/entities/enums/DraftOrderStatus.md deleted file mode 100644 index 339f6ed242..0000000000 --- a/www/apps/docs/content/references/entities/enums/DraftOrderStatus.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: DraftOrderStatus - -## Enumeration Members - -### COMPLETED - -• **COMPLETED** = ``"completed"`` - -#### Defined in - -[models/draft-order.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L23) - -___ - -### OPEN - -• **OPEN** = ``"open"`` - -#### Defined in - -[models/draft-order.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/draft-order.ts#L22) diff --git a/www/apps/docs/content/references/entities/enums/DraftOrderStatus.mdx b/www/apps/docs/content/references/entities/enums/DraftOrderStatus.mdx new file mode 100644 index 0000000000..be456f2121 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/DraftOrderStatus.mdx @@ -0,0 +1,19 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# DraftOrderStatus + +## Enumeration Members + +### COMPLETED + + **COMPLETED** = ``"completed"`` + +___ + +### OPEN + + **OPEN** = ``"open"`` diff --git a/www/apps/docs/content/references/entities/enums/FulfillmentStatus.md b/www/apps/docs/content/references/entities/enums/FulfillmentStatus.md deleted file mode 100644 index 9e032454c4..0000000000 --- a/www/apps/docs/content/references/entities/enums/FulfillmentStatus.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: FulfillmentStatus - -## Enumeration Members - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -[models/order.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L56) - -___ - -### FULFILLED - -• **FULFILLED** = ``"fulfilled"`` - -#### Defined in - -[models/order.ts:51](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L51) - -___ - -### NOT\_FULFILLED - -• **NOT\_FULFILLED** = ``"not_fulfilled"`` - -#### Defined in - -[models/order.ts:49](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L49) - -___ - -### PARTIALLY\_FULFILLED - -• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` - -#### Defined in - -[models/order.ts:50](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L50) - -___ - -### PARTIALLY\_RETURNED - -• **PARTIALLY\_RETURNED** = ``"partially_returned"`` - -#### Defined in - -[models/order.ts:54](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L54) - -___ - -### PARTIALLY\_SHIPPED - -• **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` - -#### Defined in - -[models/order.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L52) - -___ - -### REQUIRES\_ACTION - -• **REQUIRES\_ACTION** = ``"requires_action"`` - -#### Defined in - -[models/order.ts:57](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L57) - -___ - -### RETURNED - -• **RETURNED** = ``"returned"`` - -#### Defined in - -[models/order.ts:55](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L55) - -___ - -### SHIPPED - -• **SHIPPED** = ``"shipped"`` - -#### Defined in - -[models/order.ts:53](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L53) diff --git a/www/apps/docs/content/references/entities/enums/FulfillmentStatus.mdx b/www/apps/docs/content/references/entities/enums/FulfillmentStatus.mdx new file mode 100644 index 0000000000..91e9a72c28 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/FulfillmentStatus.mdx @@ -0,0 +1,61 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# FulfillmentStatus + +## Enumeration Members + +### CANCELED + + **CANCELED** = ``"canceled"`` + +___ + +### FULFILLED + + **FULFILLED** = ``"fulfilled"`` + +___ + +### NOT\_FULFILLED + + **NOT\_FULFILLED** = ``"not_fulfilled"`` + +___ + +### PARTIALLY\_FULFILLED + + **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` + +___ + +### PARTIALLY\_RETURNED + + **PARTIALLY\_RETURNED** = ``"partially_returned"`` + +___ + +### PARTIALLY\_SHIPPED + + **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` + +___ + +### REQUIRES\_ACTION + + **REQUIRES\_ACTION** = ``"requires_action"`` + +___ + +### RETURNED + + **RETURNED** = ``"returned"`` + +___ + +### SHIPPED + + **SHIPPED** = ``"shipped"`` diff --git a/www/apps/docs/content/references/entities/enums/OrderEditItemChangeType.md b/www/apps/docs/content/references/entities/enums/OrderEditItemChangeType.md deleted file mode 100644 index d86d5c2acf..0000000000 --- a/www/apps/docs/content/references/entities/enums/OrderEditItemChangeType.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: OrderEditItemChangeType - -## Enumeration Members - -### ITEM\_ADD - -• **ITEM\_ADD** = ``"item_add"`` - -#### Defined in - -[models/order-item-change.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L18) - -___ - -### ITEM\_REMOVE - -• **ITEM\_REMOVE** = ``"item_remove"`` - -#### Defined in - -[models/order-item-change.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L19) - -___ - -### ITEM\_UPDATE - -• **ITEM\_UPDATE** = ``"item_update"`` - -#### Defined in - -[models/order-item-change.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-item-change.ts#L20) diff --git a/www/apps/docs/content/references/entities/enums/OrderEditItemChangeType.mdx b/www/apps/docs/content/references/entities/enums/OrderEditItemChangeType.mdx new file mode 100644 index 0000000000..d39f597211 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/OrderEditItemChangeType.mdx @@ -0,0 +1,25 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderEditItemChangeType + +## Enumeration Members + +### ITEM\_ADD + + **ITEM\_ADD** = ``"item_add"`` + +___ + +### ITEM\_REMOVE + + **ITEM\_REMOVE** = ``"item_remove"`` + +___ + +### ITEM\_UPDATE + + **ITEM\_UPDATE** = ``"item_update"`` diff --git a/www/apps/docs/content/references/entities/enums/OrderEditStatus.md b/www/apps/docs/content/references/entities/enums/OrderEditStatus.md deleted file mode 100644 index be919ffd0e..0000000000 --- a/www/apps/docs/content/references/entities/enums/OrderEditStatus.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: OrderEditStatus - -## Enumeration Members - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -[models/order-edit.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L24) - -___ - -### CONFIRMED - -• **CONFIRMED** = ``"confirmed"`` - -#### Defined in - -[models/order-edit.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L20) - -___ - -### CREATED - -• **CREATED** = ``"created"`` - -#### Defined in - -[models/order-edit.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L23) - -___ - -### DECLINED - -• **DECLINED** = ``"declined"`` - -#### Defined in - -[models/order-edit.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L21) - -___ - -### REQUESTED - -• **REQUESTED** = ``"requested"`` - -#### Defined in - -[models/order-edit.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order-edit.ts#L22) diff --git a/www/apps/docs/content/references/entities/enums/OrderEditStatus.mdx b/www/apps/docs/content/references/entities/enums/OrderEditStatus.mdx new file mode 100644 index 0000000000..b4ab382d8c --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/OrderEditStatus.mdx @@ -0,0 +1,37 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderEditStatus + +## Enumeration Members + +### CANCELED + + **CANCELED** = ``"canceled"`` + +___ + +### CONFIRMED + + **CONFIRMED** = ``"confirmed"`` + +___ + +### CREATED + + **CREATED** = ``"created"`` + +___ + +### DECLINED + + **DECLINED** = ``"declined"`` + +___ + +### REQUESTED + + **REQUESTED** = ``"requested"`` diff --git a/www/apps/docs/content/references/entities/enums/OrderStatus.md b/www/apps/docs/content/references/entities/enums/OrderStatus.md deleted file mode 100644 index 868576d377..0000000000 --- a/www/apps/docs/content/references/entities/enums/OrderStatus.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: OrderStatus - -## Enumeration Members - -### ARCHIVED - -• **ARCHIVED** = ``"archived"`` - -#### Defined in - -[models/order.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L43) - -___ - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -[models/order.ts:44](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L44) - -___ - -### COMPLETED - -• **COMPLETED** = ``"completed"`` - -#### Defined in - -[models/order.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L42) - -___ - -### PENDING - -• **PENDING** = ``"pending"`` - -#### Defined in - -[models/order.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L41) - -___ - -### REQUIRES\_ACTION - -• **REQUIRES\_ACTION** = ``"requires_action"`` - -#### Defined in - -[models/order.ts:45](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L45) diff --git a/www/apps/docs/content/references/entities/enums/OrderStatus.mdx b/www/apps/docs/content/references/entities/enums/OrderStatus.mdx new file mode 100644 index 0000000000..9a291b4dbd --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/OrderStatus.mdx @@ -0,0 +1,37 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# OrderStatus + +## Enumeration Members + +### ARCHIVED + + **ARCHIVED** = ``"archived"`` + +___ + +### CANCELED + + **CANCELED** = ``"canceled"`` + +___ + +### COMPLETED + + **COMPLETED** = ``"completed"`` + +___ + +### PENDING + + **PENDING** = ``"pending"`` + +___ + +### REQUIRES\_ACTION + + **REQUIRES\_ACTION** = ``"requires_action"`` diff --git a/www/apps/docs/content/references/entities/enums/PaymentCollectionStatus.md b/www/apps/docs/content/references/entities/enums/PaymentCollectionStatus.md deleted file mode 100644 index c7bc7fefd4..0000000000 --- a/www/apps/docs/content/references/entities/enums/PaymentCollectionStatus.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: PaymentCollectionStatus - -## Enumeration Members - -### AUTHORIZED - -• **AUTHORIZED** = ``"authorized"`` - -#### Defined in - -[models/payment-collection.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L20) - -___ - -### AWAITING - -• **AWAITING** = ``"awaiting"`` - -#### Defined in - -[models/payment-collection.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L19) - -___ - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -[models/payment-collection.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L22) - -___ - -### NOT\_PAID - -• **NOT\_PAID** = ``"not_paid"`` - -#### Defined in - -[models/payment-collection.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L18) - -___ - -### PARTIALLY\_AUTHORIZED - -• **PARTIALLY\_AUTHORIZED** = ``"partially_authorized"`` - -#### Defined in - -[models/payment-collection.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L21) diff --git a/www/apps/docs/content/references/entities/enums/PaymentCollectionStatus.mdx b/www/apps/docs/content/references/entities/enums/PaymentCollectionStatus.mdx new file mode 100644 index 0000000000..3e62180852 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/PaymentCollectionStatus.mdx @@ -0,0 +1,37 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentCollectionStatus + +## Enumeration Members + +### AUTHORIZED + + **AUTHORIZED** = ``"authorized"`` + +___ + +### AWAITING + + **AWAITING** = ``"awaiting"`` + +___ + +### CANCELED + + **CANCELED** = ``"canceled"`` + +___ + +### NOT\_PAID + + **NOT\_PAID** = ``"not_paid"`` + +___ + +### PARTIALLY\_AUTHORIZED + + **PARTIALLY\_AUTHORIZED** = ``"partially_authorized"`` diff --git a/www/apps/docs/content/references/entities/enums/PaymentCollectionType.md b/www/apps/docs/content/references/entities/enums/PaymentCollectionType.md deleted file mode 100644 index 29bdad6444..0000000000 --- a/www/apps/docs/content/references/entities/enums/PaymentCollectionType.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: PaymentCollectionType - -## Enumeration Members - -### ORDER\_EDIT - -• **ORDER\_EDIT** = ``"order_edit"`` - -#### Defined in - -[models/payment-collection.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-collection.ts#L26) diff --git a/www/apps/docs/content/references/entities/enums/PaymentCollectionType.mdx b/www/apps/docs/content/references/entities/enums/PaymentCollectionType.mdx new file mode 100644 index 0000000000..243d97f2bd --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/PaymentCollectionType.mdx @@ -0,0 +1,13 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentCollectionType + +## Enumeration Members + +### ORDER\_EDIT + + **ORDER\_EDIT** = ``"order_edit"`` diff --git a/www/apps/docs/content/references/entities/enums/PaymentSessionStatus.md b/www/apps/docs/content/references/entities/enums/PaymentSessionStatus.md deleted file mode 100644 index a96a1f522f..0000000000 --- a/www/apps/docs/content/references/entities/enums/PaymentSessionStatus.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: PaymentSessionStatus - -## Enumeration Members - -### AUTHORIZED - -• **AUTHORIZED** = ``"authorized"`` - -#### Defined in - -[models/payment-session.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L17) - -___ - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -[models/payment-session.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L21) - -___ - -### ERROR - -• **ERROR** = ``"error"`` - -#### Defined in - -[models/payment-session.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L20) - -___ - -### PENDING - -• **PENDING** = ``"pending"`` - -#### Defined in - -[models/payment-session.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L18) - -___ - -### REQUIRES\_MORE - -• **REQUIRES\_MORE** = ``"requires_more"`` - -#### Defined in - -[models/payment-session.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/payment-session.ts#L19) diff --git a/www/apps/docs/content/references/entities/enums/PaymentSessionStatus.mdx b/www/apps/docs/content/references/entities/enums/PaymentSessionStatus.mdx new file mode 100644 index 0000000000..a5b2b74ab2 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/PaymentSessionStatus.mdx @@ -0,0 +1,37 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentSessionStatus + +## Enumeration Members + +### AUTHORIZED + + **AUTHORIZED** = ``"authorized"`` + +___ + +### CANCELED + + **CANCELED** = ``"canceled"`` + +___ + +### ERROR + + **ERROR** = ``"error"`` + +___ + +### PENDING + + **PENDING** = ``"pending"`` + +___ + +### REQUIRES\_MORE + + **REQUIRES\_MORE** = ``"requires_more"`` diff --git a/www/apps/docs/content/references/entities/enums/PaymentStatus.md b/www/apps/docs/content/references/entities/enums/PaymentStatus.md deleted file mode 100644 index 7253bb33fd..0000000000 --- a/www/apps/docs/content/references/entities/enums/PaymentStatus.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: PaymentStatus - -## Enumeration Members - -### AWAITING - -• **AWAITING** = ``"awaiting"`` - -#### Defined in - -[models/order.ts:62](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L62) - -___ - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -[models/order.ts:66](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L66) - -___ - -### CAPTURED - -• **CAPTURED** = ``"captured"`` - -#### Defined in - -[models/order.ts:63](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L63) - -___ - -### NOT\_PAID - -• **NOT\_PAID** = ``"not_paid"`` - -#### Defined in - -[models/order.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L61) - -___ - -### PARTIALLY\_REFUNDED - -• **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` - -#### Defined in - -[models/order.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L64) - -___ - -### REFUNDED - -• **REFUNDED** = ``"refunded"`` - -#### Defined in - -[models/order.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L65) - -___ - -### REQUIRES\_ACTION - -• **REQUIRES\_ACTION** = ``"requires_action"`` - -#### Defined in - -[models/order.ts:67](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/order.ts#L67) diff --git a/www/apps/docs/content/references/entities/enums/PaymentStatus.mdx b/www/apps/docs/content/references/entities/enums/PaymentStatus.mdx new file mode 100644 index 0000000000..c8249230a7 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/PaymentStatus.mdx @@ -0,0 +1,49 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# PaymentStatus + +## Enumeration Members + +### AWAITING + + **AWAITING** = ``"awaiting"`` + +___ + +### CANCELED + + **CANCELED** = ``"canceled"`` + +___ + +### CAPTURED + + **CAPTURED** = ``"captured"`` + +___ + +### NOT\_PAID + + **NOT\_PAID** = ``"not_paid"`` + +___ + +### PARTIALLY\_REFUNDED + + **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` + +___ + +### REFUNDED + + **REFUNDED** = ``"refunded"`` + +___ + +### REQUIRES\_ACTION + + **REQUIRES\_ACTION** = ``"requires_action"`` diff --git a/www/apps/docs/content/references/entities/enums/ProductStatus.md b/www/apps/docs/content/references/entities/enums/ProductStatus.md deleted file mode 100644 index 83dbd9109d..0000000000 --- a/www/apps/docs/content/references/entities/enums/ProductStatus.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: ProductStatus - -## Enumeration Members - -### DRAFT - -• **DRAFT** = ``"draft"`` - -#### Defined in - -[models/product.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L31) - -___ - -### PROPOSED - -• **PROPOSED** = ``"proposed"`` - -#### Defined in - -[models/product.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L32) - -___ - -### PUBLISHED - -• **PUBLISHED** = ``"published"`` - -#### Defined in - -[models/product.ts:33](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L33) - -___ - -### REJECTED - -• **REJECTED** = ``"rejected"`` - -#### Defined in - -[models/product.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/product.ts#L34) diff --git a/www/apps/docs/content/references/entities/enums/ProductStatus.mdx b/www/apps/docs/content/references/entities/enums/ProductStatus.mdx new file mode 100644 index 0000000000..d22a8766bb --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/ProductStatus.mdx @@ -0,0 +1,31 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ProductStatus + +## Enumeration Members + +### DRAFT + + **DRAFT** = ``"draft"`` + +___ + +### PROPOSED + + **PROPOSED** = ``"proposed"`` + +___ + +### PUBLISHED + + **PUBLISHED** = ``"published"`` + +___ + +### REJECTED + + **REJECTED** = ``"rejected"`` diff --git a/www/apps/docs/content/references/entities/enums/RefundReason.md b/www/apps/docs/content/references/entities/enums/RefundReason.md deleted file mode 100644 index 9773b1450d..0000000000 --- a/www/apps/docs/content/references/entities/enums/RefundReason.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: RefundReason - -## Enumeration Members - -### CLAIM - -• **CLAIM** = ``"claim"`` - -#### Defined in - -[models/refund.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L21) - -___ - -### DISCOUNT - -• **DISCOUNT** = ``"discount"`` - -#### Defined in - -[models/refund.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L18) - -___ - -### OTHER - -• **OTHER** = ``"other"`` - -#### Defined in - -[models/refund.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L22) - -___ - -### RETURN - -• **RETURN** = ``"return"`` - -#### Defined in - -[models/refund.ts:19](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L19) - -___ - -### SWAP - -• **SWAP** = ``"swap"`` - -#### Defined in - -[models/refund.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/refund.ts#L20) diff --git a/www/apps/docs/content/references/entities/enums/RefundReason.mdx b/www/apps/docs/content/references/entities/enums/RefundReason.mdx new file mode 100644 index 0000000000..4984d1446c --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/RefundReason.mdx @@ -0,0 +1,37 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RefundReason + +## Enumeration Members + +### CLAIM + + **CLAIM** = ``"claim"`` + +___ + +### DISCOUNT + + **DISCOUNT** = ``"discount"`` + +___ + +### OTHER + + **OTHER** = ``"other"`` + +___ + +### RETURN + + **RETURN** = ``"return"`` + +___ + +### SWAP + + **SWAP** = ``"swap"`` diff --git a/www/apps/docs/content/references/entities/enums/RequirementType.md b/www/apps/docs/content/references/entities/enums/RequirementType.md deleted file mode 100644 index 2cba5591ba..0000000000 --- a/www/apps/docs/content/references/entities/enums/RequirementType.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: RequirementType - -## Enumeration Members - -### MAX\_SUBTOTAL - -• **MAX\_SUBTOTAL** = ``"max_subtotal"`` - -#### Defined in - -[models/shipping-option-requirement.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option-requirement.ts#L18) - -___ - -### MIN\_SUBTOTAL - -• **MIN\_SUBTOTAL** = ``"min_subtotal"`` - -#### Defined in - -[models/shipping-option-requirement.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option-requirement.ts#L17) diff --git a/www/apps/docs/content/references/entities/enums/RequirementType.mdx b/www/apps/docs/content/references/entities/enums/RequirementType.mdx new file mode 100644 index 0000000000..db19115785 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/RequirementType.mdx @@ -0,0 +1,19 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# RequirementType + +## Enumeration Members + +### MAX\_SUBTOTAL + + **MAX\_SUBTOTAL** = ``"max_subtotal"`` + +___ + +### MIN\_SUBTOTAL + + **MIN\_SUBTOTAL** = ``"min_subtotal"`` diff --git a/www/apps/docs/content/references/entities/enums/ReturnStatus.md b/www/apps/docs/content/references/entities/enums/ReturnStatus.md deleted file mode 100644 index 18ee384e69..0000000000 --- a/www/apps/docs/content/references/entities/enums/ReturnStatus.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: ReturnStatus - -## Enumeration Members - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -[models/return.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L25) - -___ - -### RECEIVED - -• **RECEIVED** = ``"received"`` - -#### Defined in - -[models/return.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L23) - -___ - -### REQUESTED - -• **REQUESTED** = ``"requested"`` - -#### Defined in - -[models/return.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L22) - -___ - -### REQUIRES\_ACTION - -• **REQUIRES\_ACTION** = ``"requires_action"`` - -#### Defined in - -[models/return.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/return.ts#L24) diff --git a/www/apps/docs/content/references/entities/enums/ReturnStatus.mdx b/www/apps/docs/content/references/entities/enums/ReturnStatus.mdx new file mode 100644 index 0000000000..45c6bd243d --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/ReturnStatus.mdx @@ -0,0 +1,31 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ReturnStatus + +## Enumeration Members + +### CANCELED + + **CANCELED** = ``"canceled"`` + +___ + +### RECEIVED + + **RECEIVED** = ``"received"`` + +___ + +### REQUESTED + + **REQUESTED** = ``"requested"`` + +___ + +### REQUIRES\_ACTION + + **REQUIRES\_ACTION** = ``"requires_action"`` diff --git a/www/apps/docs/content/references/entities/enums/ShippingOptionPriceType.md b/www/apps/docs/content/references/entities/enums/ShippingOptionPriceType.md deleted file mode 100644 index 22ae43da09..0000000000 --- a/www/apps/docs/content/references/entities/enums/ShippingOptionPriceType.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: ShippingOptionPriceType - -## Enumeration Members - -### CALCULATED - -• **CALCULATED** = ``"calculated"`` - -#### Defined in - -[models/shipping-option.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L24) - -___ - -### FLAT\_RATE - -• **FLAT\_RATE** = ``"flat_rate"`` - -#### Defined in - -[models/shipping-option.ts:23](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-option.ts#L23) diff --git a/www/apps/docs/content/references/entities/enums/ShippingOptionPriceType.mdx b/www/apps/docs/content/references/entities/enums/ShippingOptionPriceType.mdx new file mode 100644 index 0000000000..03bd6fd7fd --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/ShippingOptionPriceType.mdx @@ -0,0 +1,19 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingOptionPriceType + +## Enumeration Members + +### CALCULATED + + **CALCULATED** = ``"calculated"`` + +___ + +### FLAT\_RATE + + **FLAT\_RATE** = ``"flat_rate"`` diff --git a/www/apps/docs/content/references/entities/enums/ShippingProfileType.md b/www/apps/docs/content/references/entities/enums/ShippingProfileType.md deleted file mode 100644 index dbb975ad21..0000000000 --- a/www/apps/docs/content/references/entities/enums/ShippingProfileType.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: ShippingProfileType - -## Enumeration Members - -### CUSTOM - -• **CUSTOM** = ``"custom"`` - -#### Defined in - -[models/shipping-profile.ts:18](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-profile.ts#L18) - -___ - -### DEFAULT - -• **DEFAULT** = ``"default"`` - -#### Defined in - -[models/shipping-profile.ts:16](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-profile.ts#L16) - -___ - -### GIFT\_CARD - -• **GIFT\_CARD** = ``"gift_card"`` - -#### Defined in - -[models/shipping-profile.ts:17](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/shipping-profile.ts#L17) diff --git a/www/apps/docs/content/references/entities/enums/ShippingProfileType.mdx b/www/apps/docs/content/references/entities/enums/ShippingProfileType.mdx new file mode 100644 index 0000000000..e11ca82c16 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/ShippingProfileType.mdx @@ -0,0 +1,25 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# ShippingProfileType + +## Enumeration Members + +### CUSTOM + + **CUSTOM** = ``"custom"`` + +___ + +### DEFAULT + + **DEFAULT** = ``"default"`` + +___ + +### GIFT\_CARD + + **GIFT\_CARD** = ``"gift_card"`` diff --git a/www/apps/docs/content/references/entities/enums/SwapFulfillmentStatus.md b/www/apps/docs/content/references/entities/enums/SwapFulfillmentStatus.md deleted file mode 100644 index 96e09b8015..0000000000 --- a/www/apps/docs/content/references/entities/enums/SwapFulfillmentStatus.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: SwapFulfillmentStatus - -## Enumeration Members - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -[models/swap.ts:29](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L29) - -___ - -### FULFILLED - -• **FULFILLED** = ``"fulfilled"`` - -#### Defined in - -[models/swap.ts:26](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L26) - -___ - -### NOT\_FULFILLED - -• **NOT\_FULFILLED** = ``"not_fulfilled"`` - -#### Defined in - -[models/swap.ts:25](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L25) - -___ - -### PARTIALLY\_SHIPPED - -• **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` - -#### Defined in - -[models/swap.ts:28](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L28) - -___ - -### REQUIRES\_ACTION - -• **REQUIRES\_ACTION** = ``"requires_action"`` - -#### Defined in - -[models/swap.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L30) - -___ - -### SHIPPED - -• **SHIPPED** = ``"shipped"`` - -#### Defined in - -[models/swap.ts:27](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L27) diff --git a/www/apps/docs/content/references/entities/enums/SwapFulfillmentStatus.mdx b/www/apps/docs/content/references/entities/enums/SwapFulfillmentStatus.mdx new file mode 100644 index 0000000000..050ec3fbe1 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/SwapFulfillmentStatus.mdx @@ -0,0 +1,43 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SwapFulfillmentStatus + +## Enumeration Members + +### CANCELED + + **CANCELED** = ``"canceled"`` + +___ + +### FULFILLED + + **FULFILLED** = ``"fulfilled"`` + +___ + +### NOT\_FULFILLED + + **NOT\_FULFILLED** = ``"not_fulfilled"`` + +___ + +### PARTIALLY\_SHIPPED + + **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` + +___ + +### REQUIRES\_ACTION + + **REQUIRES\_ACTION** = ``"requires_action"`` + +___ + +### SHIPPED + + **SHIPPED** = ``"shipped"`` diff --git a/www/apps/docs/content/references/entities/enums/SwapPaymentStatus.md b/www/apps/docs/content/references/entities/enums/SwapPaymentStatus.md deleted file mode 100644 index a1ec64839b..0000000000 --- a/www/apps/docs/content/references/entities/enums/SwapPaymentStatus.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: SwapPaymentStatus - -## Enumeration Members - -### AWAITING - -• **AWAITING** = ``"awaiting"`` - -#### Defined in - -[models/swap.ts:35](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L35) - -___ - -### CANCELED - -• **CANCELED** = ``"canceled"`` - -#### Defined in - -[models/swap.ts:38](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L38) - -___ - -### CAPTURED - -• **CAPTURED** = ``"captured"`` - -#### Defined in - -[models/swap.ts:36](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L36) - -___ - -### CONFIRMED - -• **CONFIRMED** = ``"confirmed"`` - -#### Defined in - -[models/swap.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L37) - -___ - -### DIFFERENCE\_REFUNDED - -• **DIFFERENCE\_REFUNDED** = ``"difference_refunded"`` - -#### Defined in - -[models/swap.ts:39](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L39) - -___ - -### NOT\_PAID - -• **NOT\_PAID** = ``"not_paid"`` - -#### Defined in - -[models/swap.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L34) - -___ - -### PARTIALLY\_REFUNDED - -• **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` - -#### Defined in - -[models/swap.ts:40](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L40) - -___ - -### REFUNDED - -• **REFUNDED** = ``"refunded"`` - -#### Defined in - -[models/swap.ts:41](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L41) - -___ - -### REQUIRES\_ACTION - -• **REQUIRES\_ACTION** = ``"requires_action"`` - -#### Defined in - -[models/swap.ts:42](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/swap.ts#L42) diff --git a/www/apps/docs/content/references/entities/enums/SwapPaymentStatus.mdx b/www/apps/docs/content/references/entities/enums/SwapPaymentStatus.mdx new file mode 100644 index 0000000000..0def1da0aa --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/SwapPaymentStatus.mdx @@ -0,0 +1,61 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# SwapPaymentStatus + +## Enumeration Members + +### AWAITING + + **AWAITING** = ``"awaiting"`` + +___ + +### CANCELED + + **CANCELED** = ``"canceled"`` + +___ + +### CAPTURED + + **CAPTURED** = ``"captured"`` + +___ + +### CONFIRMED + + **CONFIRMED** = ``"confirmed"`` + +___ + +### DIFFERENCE\_REFUNDED + + **DIFFERENCE\_REFUNDED** = ``"difference_refunded"`` + +___ + +### NOT\_PAID + + **NOT\_PAID** = ``"not_paid"`` + +___ + +### PARTIALLY\_REFUNDED + + **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` + +___ + +### REFUNDED + + **REFUNDED** = ``"refunded"`` + +___ + +### REQUIRES\_ACTION + + **REQUIRES\_ACTION** = ``"requires_action"`` diff --git a/www/apps/docs/content/references/entities/enums/UserRoles.md b/www/apps/docs/content/references/entities/enums/UserRoles.md deleted file mode 100644 index d78bed4bcd..0000000000 --- a/www/apps/docs/content/references/entities/enums/UserRoles.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Enumeration: UserRoles - -## Enumeration Members - -### ADMIN - -• **ADMIN** = ``"admin"`` - -#### Defined in - -[models/user.ts:8](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/user.ts#L8) - -___ - -### DEVELOPER - -• **DEVELOPER** = ``"developer"`` - -#### Defined in - -[models/user.ts:10](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/user.ts#L10) - -___ - -### MEMBER - -• **MEMBER** = ``"member"`` - -#### Defined in - -[models/user.ts:9](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/models/user.ts#L9) diff --git a/www/apps/docs/content/references/entities/enums/UserRoles.mdx b/www/apps/docs/content/references/entities/enums/UserRoles.mdx new file mode 100644 index 0000000000..e8eaac0713 --- /dev/null +++ b/www/apps/docs/content/references/entities/enums/UserRoles.mdx @@ -0,0 +1,25 @@ +--- +displayed_sidebar: entitiesSidebar +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# UserRoles + +## Enumeration Members + +### ADMIN + + **ADMIN** = ``"admin"`` + +___ + +### DEVELOPER + + **DEVELOPER** = ``"developer"`` + +___ + +### MEMBER + + **MEMBER** = ``"member"`` diff --git a/www/apps/docs/content/references/entities/index.md b/www/apps/docs/content/references/entities/index.md deleted file mode 100644 index 3aedc2c30f..0000000000 --- a/www/apps/docs/content/references/entities/index.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -displayed_sidebar: entitiesSidebar ---- - -# Entities Reference - -## Enumerations - -- [AllocationType](enums/AllocationType.md) -- [CartType](enums/CartType.md) -- [ClaimFulfillmentStatus](enums/ClaimFulfillmentStatus.md) -- [ClaimPaymentStatus](enums/ClaimPaymentStatus.md) -- [ClaimReason](enums/ClaimReason.md) -- [ClaimType](enums/ClaimType.md) -- [DiscountConditionOperator](enums/DiscountConditionOperator.md) -- [DiscountConditionType](enums/DiscountConditionType.md) -- [DiscountRuleType](enums/DiscountRuleType.md) -- [DraftOrderStatus](enums/DraftOrderStatus.md) -- [FulfillmentStatus](enums/FulfillmentStatus.md) -- [OrderEditItemChangeType](enums/OrderEditItemChangeType.md) -- [OrderEditStatus](enums/OrderEditStatus.md) -- [OrderStatus](enums/OrderStatus.md) -- [PaymentCollectionStatus](enums/PaymentCollectionStatus.md) -- [PaymentCollectionType](enums/PaymentCollectionType.md) -- [PaymentSessionStatus](enums/PaymentSessionStatus.md) -- [PaymentStatus](enums/PaymentStatus.md) -- [ProductStatus](enums/ProductStatus.md) -- [RefundReason](enums/RefundReason.md) -- [RequirementType](enums/RequirementType.md) -- [ReturnStatus](enums/ReturnStatus.md) -- [ShippingOptionPriceType](enums/ShippingOptionPriceType.md) -- [ShippingProfileType](enums/ShippingProfileType.md) -- [SwapFulfillmentStatus](enums/SwapFulfillmentStatus.md) -- [SwapPaymentStatus](enums/SwapPaymentStatus.md) -- [UserRoles](enums/UserRoles.md) - -## Classes - -- [Address](classes/Address.md) -- [AnalyticsConfig](classes/AnalyticsConfig.md) -- [BatchJob](classes/BatchJob.md) -- [Cart](classes/Cart.md) -- [ClaimImage](classes/ClaimImage.md) -- [ClaimItem](classes/ClaimItem.md) -- [ClaimOrder](classes/ClaimOrder.md) -- [ClaimTag](classes/ClaimTag.md) -- [Country](classes/Country.md) -- [Currency](classes/Currency.md) -- [CustomShippingOption](classes/CustomShippingOption.md) -- [Customer](classes/Customer.md) -- [CustomerGroup](classes/CustomerGroup.md) -- [Discount](classes/Discount.md) -- [DiscountCondition](classes/DiscountCondition.md) -- [DiscountConditionCustomerGroup](classes/DiscountConditionCustomerGroup.md) -- [DiscountConditionProduct](classes/DiscountConditionProduct.md) -- [DiscountConditionProductCollection](classes/DiscountConditionProductCollection.md) -- [DiscountConditionProductTag](classes/DiscountConditionProductTag.md) -- [DiscountConditionProductType](classes/DiscountConditionProductType.md) -- [DiscountRule](classes/DiscountRule.md) -- [DraftOrder](classes/DraftOrder.md) -- [Fulfillment](classes/Fulfillment.md) -- [FulfillmentItem](classes/FulfillmentItem.md) -- [FulfillmentProvider](classes/FulfillmentProvider.md) -- [GiftCard](classes/GiftCard.md) -- [GiftCardTransaction](classes/GiftCardTransaction.md) -- [IdempotencyKey](classes/IdempotencyKey.md) -- [Image](classes/Image.md) -- [Invite](classes/Invite.md) -- [LineItem](classes/LineItem.md) -- [LineItemAdjustment](classes/LineItemAdjustment.md) -- [LineItemTaxLine](classes/LineItemTaxLine.md) -- [MoneyAmount](classes/MoneyAmount.md) -- [Note](classes/Note.md) -- [Notification](classes/Notification.md) -- [Oauth](classes/Oauth.md) -- [Order](classes/Order.md) -- [OrderEdit](classes/OrderEdit.md) -- [OrderItemChange](classes/OrderItemChange.md) -- [Payment](classes/Payment.md) -- [PaymentCollection](classes/PaymentCollection.md) -- [PaymentProvider](classes/PaymentProvider.md) -- [PaymentSession](classes/PaymentSession.md) -- [PriceList](classes/PriceList.md) -- [Product](classes/Product.md) -- [ProductCategory](classes/ProductCategory.md) -- [ProductCollection](classes/ProductCollection.md) -- [ProductOption](classes/ProductOption.md) -- [ProductOptionValue](classes/ProductOptionValue.md) -- [ProductTag](classes/ProductTag.md) -- [ProductTaxRate](classes/ProductTaxRate.md) -- [ProductType](classes/ProductType.md) -- [ProductTypeTaxRate](classes/ProductTypeTaxRate.md) -- [ProductVariant](classes/ProductVariant.md) -- [ProductVariantInventoryItem](classes/ProductVariantInventoryItem.md) -- [ProductVariantMoneyAmount](classes/ProductVariantMoneyAmount.md) -- [PublishableApiKey](classes/PublishableApiKey.md) -- [PublishableApiKeySalesChannel](classes/PublishableApiKeySalesChannel.md) -- [Refund](classes/Refund.md) -- [Region](classes/Region.md) -- [Return](classes/Return.md) -- [ReturnItem](classes/ReturnItem.md) -- [ReturnReason](classes/ReturnReason.md) -- [SalesChannel](classes/SalesChannel.md) -- [SalesChannelLocation](classes/SalesChannelLocation.md) -- [ShippingMethod](classes/ShippingMethod.md) -- [ShippingMethodTaxLine](classes/ShippingMethodTaxLine.md) -- [ShippingOption](classes/ShippingOption.md) -- [ShippingOptionRequirement](classes/ShippingOptionRequirement.md) -- [ShippingProfile](classes/ShippingProfile.md) -- [ShippingTaxRate](classes/ShippingTaxRate.md) -- [StagedJob](classes/StagedJob.md) -- [Store](classes/Store.md) -- [Swap](classes/Swap.md) -- [TaxProvider](classes/TaxProvider.md) -- [TaxRate](classes/TaxRate.md) -- [TrackingLink](classes/TrackingLink.md) -- [User](classes/User.md) diff --git a/www/apps/docs/content/references/js-client/index.md b/www/apps/docs/content/references/js-client/_index.mdx similarity index 100% rename from www/apps/docs/content/references/js-client/index.md rename to www/apps/docs/content/references/js-client/_index.mdx diff --git a/www/apps/docs/content/references/js-client/addresses/classes/addresses.AddressesResource.mdx b/www/apps/docs/content/references/js-client/addresses/classes/addresses.AddressesResource.mdx index ecdd60b489..f6da9341f3 100644 --- a/www/apps/docs/content/references/js-client/addresses/classes/addresses.AddressesResource.mdx +++ b/www/apps/docs/content/references/js-client/addresses/classes/addresses.AddressesResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addAddress -▸ **addAddress**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> +**addAddress**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> Adds an address to a customers saved addresses @@ -65,7 +65,7 @@ ___ ### deleteAddress -▸ **deleteAddress**(`address_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> +**deleteAddress**(`address_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> Deletes an address of a customer @@ -118,7 +118,7 @@ ___ ### updateAddress -▸ **updateAddress**(`address_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> +**updateAddress**(`address_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> Update an address of a customer diff --git a/www/apps/docs/content/references/js-client/addresses/modules/addresses.internal.mdx b/www/apps/docs/content/references/js-client/addresses/modules/addresses.internal.mdx index 49afd79060..1b82d75840 100644 --- a/www/apps/docs/content/references/js-client/addresses/modules/addresses.internal.mdx +++ b/www/apps/docs/content/references/js-client/addresses/modules/addresses.internal.mdx @@ -17,7 +17,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### Record -Ƭ **Record**<`K`, `T`\>: { [P in K]: T } + **Record**<`K`, `T`\>: { [P in K]: T } Construct a type with a set of properties K of type T diff --git a/www/apps/docs/content/references/js-client/admin_auth/classes/admin_auth.AdminAuthResource.mdx b/www/apps/docs/content/references/js-client/admin_auth/classes/admin_auth.AdminAuthResource.mdx index 37bfe8d9b3..dc1101f4f9 100644 --- a/www/apps/docs/content/references/js-client/admin_auth/classes/admin_auth.AdminAuthResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_auth/classes/admin_auth.AdminAuthResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### createSession -▸ **createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminAuthRes`](../modules/admin_auth.internal.mdx#adminauthres)\> +**createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminAuthRes`](../modules/admin_auth.internal.mdx#adminauthres)\> #### Parameters @@ -67,7 +67,7 @@ ___ ### deleteSession -▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\> +**deleteSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\> #### Parameters @@ -105,7 +105,7 @@ ___ ### getSession -▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminAuthRes`](../modules/admin_auth.internal.mdx#adminauthres)\> +**getSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminAuthRes`](../modules/admin_auth.internal.mdx#adminauthres)\> #### Parameters @@ -153,7 +153,7 @@ ___ ### getToken -▸ **getToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBearerAuthRes`](../modules/admin_auth.internal.mdx#adminbearerauthres)\> +**getToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBearerAuthRes`](../modules/admin_auth.internal.mdx#adminbearerauthres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_auth/modules/admin_auth.internal.mdx b/www/apps/docs/content/references/js-client/admin_auth/modules/admin_auth.internal.mdx index 912d9d731d..954ba6b5c5 100644 --- a/www/apps/docs/content/references/js-client/admin_auth/modules/admin_auth.internal.mdx +++ b/www/apps/docs/content/references/js-client/admin_auth/modules/admin_auth.internal.mdx @@ -21,7 +21,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AdminAuthRes -Ƭ **AdminAuthRes**: `Object` + **AdminAuthRes**: `Object` #### Schema @@ -51,7 +51,7 @@ ___ ### AdminBearerAuthRes -Ƭ **AdminBearerAuthRes**: `Object` + **AdminBearerAuthRes**: `Object` #### Schema @@ -79,7 +79,7 @@ ___ ### Exclude -Ƭ **Exclude**<`T`, `U`\>: `T` extends `U` ? `never` : `T` + **Exclude**<`T`, `U`\>: `T` extends `U` ? `never` : `T` Exclude from T those types that are assignable to U @@ -108,7 +108,7 @@ ___ ### Omit -Ƭ **Omit**<`T`, `K`\>: [`Pick`](admin_auth.internal.mdx#pick)<`T`, [`Exclude`](admin_auth.internal.mdx#exclude)\> + **Omit**<`T`, `K`\>: [`Pick`](admin_auth.internal.mdx#pick)<`T`, [`Exclude`](admin_auth.internal.mdx#exclude)\> Construct a type with the properties of T except for those in type K. @@ -137,7 +137,7 @@ ___ ### Pick -Ƭ **Pick**<`T`, `K`\>: { [P in K]: T[P] } + **Pick**<`T`, `K`\>: { [P in K]: T[P] } From T, pick a set of properties whose keys are in the union K diff --git a/www/apps/docs/content/references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx b/www/apps/docs/content/references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx index ca778fb1ba..03c1eefa2d 100644 --- a/www/apps/docs/content/references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_batch_jobs/classes/admin_batch_jobs.AdminBatchJobsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### cancel -▸ **cancel**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> +**cancel**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> #### Parameters @@ -63,7 +63,7 @@ ___ ### confirm -▸ **confirm**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> +**confirm**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> #### Parameters @@ -114,7 +114,7 @@ ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> #### Parameters @@ -165,7 +165,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobListRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjoblistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobListRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjoblistres)\> #### Parameters @@ -216,7 +216,7 @@ ___ ### retrieve -▸ **retrieve**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> +**retrieve**(`batchJobId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminBatchJobRes`](../modules/admin_batch_jobs.internal.mdx#adminbatchjobres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_batch_jobs/modules/admin_batch_jobs.internal.mdx b/www/apps/docs/content/references/js-client/admin_batch_jobs/modules/admin_batch_jobs.internal.mdx index 8552a7b5bb..10cad83bf0 100644 --- a/www/apps/docs/content/references/js-client/admin_batch_jobs/modules/admin_batch_jobs.internal.mdx +++ b/www/apps/docs/content/references/js-client/admin_batch_jobs/modules/admin_batch_jobs.internal.mdx @@ -22,7 +22,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AdminBatchJobListRes -Ƭ **AdminBatchJobListRes**: [`PaginatedResponse`](admin_batch_jobs.internal.mdx#paginatedresponse) & { `batch_jobs`: [`BatchJob`](../../internal/classes/admin_batch_jobs.internal.BatchJob.mdx)[] } + **AdminBatchJobListRes**: [`PaginatedResponse`](admin_batch_jobs.internal.mdx#paginatedresponse) & { `batch_jobs`: [`BatchJob`](../../internal/classes/admin_batch_jobs.internal.BatchJob.mdx)[] } #### Schema @@ -53,7 +53,7 @@ ___ ### AdminBatchJobRes -Ƭ **AdminBatchJobRes**: `Object` + **AdminBatchJobRes**: `Object` #### Schema @@ -83,7 +83,7 @@ ___ ### BatchJobResultError -Ƭ **BatchJobResultError**: `Object` + **BatchJobResultError**: `Object` #### Index signature @@ -114,7 +114,7 @@ ___ ### BatchJobResultStatDescriptor -Ƭ **BatchJobResultStatDescriptor**: `Object` + **BatchJobResultStatDescriptor**: `Object` #### Type declaration @@ -149,7 +149,7 @@ ___ ### PaginatedResponse -Ƭ **PaginatedResponse**: `Object` + **PaginatedResponse**: `Object` #### Type declaration diff --git a/www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx b/www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx index 38610b02d8..5a53a0a236 100644 --- a/www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_collections/classes/admin_collections.AdminCollectionsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addProducts -▸ **addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> +**addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> #### Parameters @@ -75,7 +75,7 @@ ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> #### Parameters @@ -130,7 +130,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -185,7 +185,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsListRes`](../modules/admin_collections.internal.mdx#admincollectionslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsListRes`](../modules/admin_collections.internal.mdx#admincollectionslistres)\> #### Parameters @@ -240,7 +240,7 @@ ___ ### removeProducts -▸ **removeProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/admin_collections.internal.mdx#admindeleteproductsfromcollectionres)\> +**removeProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/admin_collections.internal.mdx#admindeleteproductsfromcollectionres)\> #### Parameters @@ -303,7 +303,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> #### Parameters @@ -358,7 +358,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCollectionsRes`](../modules/admin_collections.internal.mdx#admincollectionsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_collections/modules/admin_collections.internal.mdx b/www/apps/docs/content/references/js-client/admin_collections/modules/admin_collections.internal.mdx index 6cdbd3f19f..4c8463a2b9 100644 --- a/www/apps/docs/content/references/js-client/admin_collections/modules/admin_collections.internal.mdx +++ b/www/apps/docs/content/references/js-client/admin_collections/modules/admin_collections.internal.mdx @@ -109,13 +109,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### ORDER\_EDIT -• **ORDER\_EDIT**: ``"order_edit"`` + **ORDER\_EDIT**: ``"order_edit"`` ## Type Aliases ### AdminCollectionsListRes -Ƭ **AdminCollectionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)[] } + **AdminCollectionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)[] } #### Schema @@ -146,7 +146,7 @@ ___ ### AdminCollectionsRes -Ƭ **AdminCollectionsRes**: `Object` + **AdminCollectionsRes**: `Object` #### Schema @@ -180,7 +180,7 @@ ___ ### AdminDeleteProductsFromCollectionRes -Ƭ **AdminDeleteProductsFromCollectionRes**: `Object` + **AdminDeleteProductsFromCollectionRes**: `Object` #### Schema @@ -219,7 +219,7 @@ The ID of the collection ### Boolean -▸ **Boolean**<`T`\>(`value?`): `boolean` +**Boolean**<`T`\>(`value?`): `boolean` +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesListRes`](../modules/admin_currencies.internal.mdx#admincurrencieslistres)\> #### Parameters @@ -69,7 +69,7 @@ ___ ### update -▸ **update**(`code`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesRes`](../modules/admin_currencies.internal.mdx#admincurrenciesres)\> +**update**(`code`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCurrenciesRes`](../modules/admin_currencies.internal.mdx#admincurrenciesres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_currencies/modules/admin_currencies.internal.mdx b/www/apps/docs/content/references/js-client/admin_currencies/modules/admin_currencies.internal.mdx index ce698edc19..1c9828fddc 100644 --- a/www/apps/docs/content/references/js-client/admin_currencies/modules/admin_currencies.internal.mdx +++ b/www/apps/docs/content/references/js-client/admin_currencies/modules/admin_currencies.internal.mdx @@ -16,7 +16,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AdminCurrenciesListRes -Ƭ **AdminCurrenciesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `currencies`: [`Currency`](../../internal/classes/admin_collections.internal.Currency.mdx)[] } + **AdminCurrenciesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `currencies`: [`Currency`](../../internal/classes/admin_collections.internal.Currency.mdx)[] } #### Schema @@ -47,7 +47,7 @@ ___ ### AdminCurrenciesRes -Ƭ **AdminCurrenciesRes**: `Object` + **AdminCurrenciesRes**: `Object` #### Schema diff --git a/www/apps/docs/content/references/js-client/admin_custom/classes/admin_custom.AdminCustomResource.mdx b/www/apps/docs/content/references/js-client/admin_custom/classes/admin_custom.AdminCustomResource.mdx index 2458af3a4f..1132a870fe 100644 --- a/www/apps/docs/content/references/js-client/admin_custom/classes/admin_custom.AdminCustomResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_custom/classes/admin_custom.AdminCustomResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### delete -▸ **delete**<`TResponse`\>(`path`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\> +**delete**<`TResponse`\>(`path`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\> (`path`, `query?`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\> +**get**<`TQuery`, `TResponse`\>(`path`, `query?`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\> (`path`, `payload?`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\> +**post**<`TPayload`, `TResponse`\>(`path`, `payload?`, `options?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`TResponse`\> +**addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> Add multiple customers to a customer group. @@ -73,7 +73,7 @@ ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> Create a customer group. @@ -126,7 +126,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> Deletes a customer group. @@ -179,7 +179,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupslistres)\> Lists customer groups. @@ -232,7 +232,7 @@ ___ ### listCustomers -▸ **listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersListRes`](../../admin_customers/modules/admin_customers.internal.mdx#admincustomerslistres)\> +**listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersListRes`](../../admin_customers/modules/admin_customers.internal.mdx#admincustomerslistres)\> List and count customers that belong to provided customer groups. @@ -293,7 +293,7 @@ ___ ### removeCustomers -▸ **removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> +**removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> Remove multiple customers from a customer group. @@ -354,7 +354,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> +**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> Retrieves a customer group. @@ -415,7 +415,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomerGroupsRes`](../modules/admin_customer_groups.internal.mdx#admincustomergroupsres)\> Updates a customer group diff --git a/www/apps/docs/content/references/js-client/admin_customer_groups/modules/admin_customer_groups.internal.mdx b/www/apps/docs/content/references/js-client/admin_customer_groups/modules/admin_customer_groups.internal.mdx index 19f2d00161..511b521ecd 100644 --- a/www/apps/docs/content/references/js-client/admin_customer_groups/modules/admin_customer_groups.internal.mdx +++ b/www/apps/docs/content/references/js-client/admin_customer_groups/modules/admin_customer_groups.internal.mdx @@ -23,7 +23,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AdminCustomerGroupsListRes -Ƭ **AdminCustomerGroupsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../../internal/classes/admin_collections.internal.CustomerGroup.mdx)[] } + **AdminCustomerGroupsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../../internal/classes/admin_collections.internal.CustomerGroup.mdx)[] } #### Schema @@ -54,7 +54,7 @@ ___ ### AdminCustomerGroupsRes -Ƭ **AdminCustomerGroupsRes**: `Object` + **AdminCustomerGroupsRes**: `Object` #### Schema diff --git a/www/apps/docs/content/references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource.mdx b/www/apps/docs/content/references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource.mdx index 0f738ffbe1..023e3d8b2f 100644 --- a/www/apps/docs/content/references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_customers/classes/admin_customers.AdminCustomersResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\> Creates a customer @@ -65,7 +65,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersListRes`](../modules/admin_customers.internal.mdx#admincustomerslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersListRes`](../modules/admin_customers.internal.mdx#admincustomerslistres)\> Lists customers @@ -118,7 +118,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\> Retrieves a customer @@ -171,7 +171,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminCustomersRes`](../modules/admin_customers.internal.mdx#admincustomersres)\> Updates a customer diff --git a/www/apps/docs/content/references/js-client/admin_customers/modules/admin_customers.internal.mdx b/www/apps/docs/content/references/js-client/admin_customers/modules/admin_customers.internal.mdx index e44bb3b237..e3e9d18e6c 100644 --- a/www/apps/docs/content/references/js-client/admin_customers/modules/admin_customers.internal.mdx +++ b/www/apps/docs/content/references/js-client/admin_customers/modules/admin_customers.internal.mdx @@ -18,7 +18,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AdminCustomersListRes -Ƭ **AdminCustomersListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customers`: [`Customer`](../../internal/classes/admin_collections.internal.Customer.mdx)[] } + **AdminCustomersListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `customers`: [`Customer`](../../internal/classes/admin_collections.internal.Customer.mdx)[] } #### Schema @@ -28,7 +28,7 @@ ___ ### AdminCustomersRes -Ƭ **AdminCustomersRes**: `Object` + **AdminCustomersRes**: `Object` #### Schema diff --git a/www/apps/docs/content/references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx b/www/apps/docs/content/references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx index 19b61a55d8..2d7556f491 100644 --- a/www/apps/docs/content/references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_discounts/classes/admin_discounts.AdminDiscountsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addConditionResourceBatch -▸ **addConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> +**addConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> #### Parameters @@ -91,7 +91,7 @@ ___ ### addRegion -▸ **addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> +**addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> #### Parameters @@ -154,7 +154,7 @@ ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> #### Parameters @@ -209,7 +209,7 @@ ___ ### createCondition -▸ **createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> +**createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> #### Parameters @@ -280,7 +280,7 @@ ___ ### createDynamicCode -▸ **createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> +**createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> #### Parameters @@ -343,7 +343,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -398,7 +398,7 @@ ___ ### deleteCondition -▸ **deleteCondition**(`discountId`, `conditionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**deleteCondition**(`discountId`, `conditionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -461,7 +461,7 @@ ___ ### deleteConditionResourceBatch -▸ **deleteConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> +**deleteConditionResourceBatch**(`discountId`, `conditionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> #### Parameters @@ -532,7 +532,7 @@ ___ ### deleteDynamicCode -▸ **deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> +**deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> #### Parameters @@ -595,7 +595,7 @@ ___ ### getCondition -▸ **getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountConditionsRes`](../modules/admin_discounts.internal.mdx#admindiscountconditionsres)\> +**getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountConditionsRes`](../modules/admin_discounts.internal.mdx#admindiscountconditionsres)\> #### Parameters @@ -666,7 +666,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsListRes`](../modules/admin_discounts.internal.mdx#admindiscountslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsListRes`](../modules/admin_discounts.internal.mdx#admindiscountslistres)\> #### Parameters @@ -721,7 +721,7 @@ ___ ### removeRegion -▸ **removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> +**removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> #### Parameters @@ -784,7 +784,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> #### Parameters @@ -839,7 +839,7 @@ ___ ### retrieveByCode -▸ **retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> +**retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> #### Parameters @@ -894,7 +894,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> #### Parameters @@ -957,7 +957,7 @@ ___ ### updateCondition -▸ **updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> +**updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDiscountsRes`](../modules/admin_discounts.internal.mdx#admindiscountsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_discounts/modules/admin_discounts.internal.mdx b/www/apps/docs/content/references/js-client/admin_discounts/modules/admin_discounts.internal.mdx index 616a7f8ee1..5424e77a3d 100644 --- a/www/apps/docs/content/references/js-client/admin_discounts/modules/admin_discounts.internal.mdx +++ b/www/apps/docs/content/references/js-client/admin_discounts/modules/admin_discounts.internal.mdx @@ -234,25 +234,25 @@ Re-exports [WritableOptions](../../internal-2/interfaces/admin_discounts.interna ### DEFAULT -• **DEFAULT**: ``"default"`` + **DEFAULT**: ``"default"`` ___ ### EXTERNAL -• **EXTERNAL**: ``"external"`` + **EXTERNAL**: ``"external"`` ___ ### INTERNAL -• **INTERNAL**: ``"internal"`` + **INTERNAL**: ``"internal"`` ## Type Aliases ### AddOrderEditLineItemInput -Ƭ **AddOrderEditLineItemInput**: `Object` + **AddOrderEditLineItemInput**: `Object` #### Type declaration @@ -287,7 +287,7 @@ ___ ### AdjustmentContext -Ƭ **AdjustmentContext**: `Object` + **AdjustmentContext**: `Object` #### Type declaration @@ -314,7 +314,7 @@ ___ ### AdminDiscountConditionsRes -Ƭ **AdminDiscountConditionsRes**: `Object` + **AdminDiscountConditionsRes**: `Object` #### Schema @@ -337,7 +337,7 @@ ___ ### AdminDiscountsListRes -Ƭ **AdminDiscountsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `discounts`: [`Discount`](../../internal/classes/admin_collections.internal.Discount.mdx)[] } + **AdminDiscountsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `discounts`: [`Discount`](../../internal/classes/admin_collections.internal.Discount.mdx)[] } #### Schema @@ -374,7 +374,7 @@ ___ ### AdminDiscountsRes -Ƭ **AdminDiscountsRes**: `Object` + **AdminDiscountsRes**: `Object` #### Schema @@ -397,7 +397,7 @@ ___ ### AllocationMapOptions -Ƭ **AllocationMapOptions**: `Object` + **AllocationMapOptions**: `Object` #### Type declaration @@ -424,19 +424,19 @@ ___ ### ArrayBufferLike -Ƭ **ArrayBufferLike**: `ArrayBufferTypes`[keyof `ArrayBufferTypes`] + **ArrayBufferLike**: `ArrayBufferTypes`[keyof `ArrayBufferTypes`] ___ ### ArrayBufferView -Ƭ **ArrayBufferView**: [`TypedArray`](admin_discounts.internal.mdx#typedarray) \| `DataView` + **ArrayBufferView**: [`TypedArray`](admin_discounts.internal.mdx#typedarray) \| `DataView` ___ ### AuthenticateResult -Ƭ **AuthenticateResult**: `Object` + **AuthenticateResult**: `Object` #### Type declaration @@ -479,7 +479,7 @@ ___ ### AvailabilityContext -Ƭ **AvailabilityContext**: `Object` + **AvailabilityContext**: `Object` #### Type declaration @@ -506,19 +506,19 @@ ___ ### BinaryLike -Ƭ **BinaryLike**: `string` \| [`ArrayBufferView`](admin_discounts.internal.mdx#arraybufferview) + **BinaryLike**: `string` \| [`ArrayBufferView`](admin_discounts.internal.mdx#arraybufferview) ___ ### BufferEncoding -Ƭ **BufferEncoding**: ``"ascii"`` \| ``"utf8"`` \| ``"utf-8"`` \| ``"utf16le"`` \| ``"ucs2"`` \| ``"ucs-2"`` \| ``"base64"`` \| ``"base64url"`` \| ``"latin1"`` \| ``"binary"`` \| ``"hex"`` + **BufferEncoding**: ``"ascii"`` \| ``"utf8"`` \| ``"utf-8"`` \| ``"utf16le"`` \| ``"ucs2"`` \| ``"ucs-2"`` \| ``"base64"`` \| ``"base64url"`` \| ``"latin1"`` \| ``"binary"`` \| ``"hex"`` ___ ### CalculateOptionPriceInput -Ƭ **CalculateOptionPriceInput**: `Object` + **CalculateOptionPriceInput**: `Object` #### Type declaration @@ -545,7 +545,7 @@ ___ ### CalculationContextData -Ƭ **CalculationContextData**: `Object` + **CalculationContextData**: `Object` #### Type declaration @@ -620,7 +620,7 @@ ___ ### CalculationContextOptions -Ƭ **CalculationContextOptions**: `Object` + **CalculationContextOptions**: `Object` #### Type declaration @@ -663,7 +663,7 @@ ___ ### CartCreateProps -Ƭ **CartCreateProps**: `Object` + **CartCreateProps**: `Object` #### Type declaration @@ -794,7 +794,7 @@ ___ ### CartUpdateProps -Ƭ **CartUpdateProps**: `Object` + **CartUpdateProps**: `Object` #### Type declaration @@ -925,7 +925,7 @@ ___ ### CategoryQueryParams -Ƭ **CategoryQueryParams**: `Object` + **CategoryQueryParams**: `Object` #### Type declaration @@ -944,13 +944,13 @@ ___ ### ClaimTypeValue -Ƭ **ClaimTypeValue**: \`${ClaimType}\` + **ClaimTypeValue**: \`${ClaimType}\` ___ ### ConfigModule -Ƭ **ConfigModule**: `Object` + **ConfigModule**: `Object` #### Type declaration @@ -993,7 +993,7 @@ ___ ### Constructor -Ƭ **Constructor**<`T`\>: `Object` + **Constructor**<`T`\>: `Object` #### Type parameters @@ -1012,7 +1012,7 @@ ___ ### CreateAnalyticsConfig -Ƭ **CreateAnalyticsConfig**: `Object` + **CreateAnalyticsConfig**: `Object` #### Type declaration @@ -1039,7 +1039,7 @@ ___ ### CreateClaimInput -Ƭ **CreateClaimInput**: `Object` + **CreateClaimInput**: `Object` #### Type declaration @@ -1154,7 +1154,7 @@ ___ ### CreateClaimItemAdditionalItemInput -Ƭ **CreateClaimItemAdditionalItemInput**: `Object` + **CreateClaimItemAdditionalItemInput**: `Object` #### Type declaration @@ -1181,7 +1181,7 @@ ___ ### CreateClaimItemInput -Ƭ **CreateClaimItemInput**: `Object` + **CreateClaimItemInput**: `Object` #### Type declaration @@ -1248,7 +1248,7 @@ ___ ### CreateClaimReturnShippingInput -Ƭ **CreateClaimReturnShippingInput**: `Object` + **CreateClaimReturnShippingInput**: `Object` #### Type declaration @@ -1275,7 +1275,7 @@ ___ ### CreateClaimShippingMethodInput -Ƭ **CreateClaimShippingMethodInput**: `Object` + **CreateClaimShippingMethodInput**: `Object` #### Type declaration @@ -1318,7 +1318,7 @@ ___ ### CreateCustomShippingOptionInput -Ƭ **CreateCustomShippingOptionInput**: `Object` + **CreateCustomShippingOptionInput**: `Object` #### Type declaration @@ -1361,7 +1361,7 @@ ___ ### CreateCustomerInput -Ƭ **CreateCustomerInput**: `Object` + **CreateCustomerInput**: `Object` #### Type declaration @@ -1436,7 +1436,7 @@ ___ ### CreateDiscountInput -Ƭ **CreateDiscountInput**: `Object` + **CreateDiscountInput**: `Object` #### Type declaration @@ -1527,7 +1527,7 @@ ___ ### CreateDiscountRuleInput -Ƭ **CreateDiscountRuleInput**: `Object` + **CreateDiscountRuleInput**: `Object` #### Type declaration @@ -1578,7 +1578,7 @@ ___ ### CreateDynamicDiscountInput -Ƭ **CreateDynamicDiscountInput**: `Object` + **CreateDynamicDiscountInput**: `Object` #### Type declaration @@ -1621,13 +1621,13 @@ ___ ### CreateFulfillmentOrder -Ƭ **CreateFulfillmentOrder**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`ClaimOrder`](../../internal/classes/admin_collections.internal.ClaimOrder.mdx), ``"beforeInsert"``\> & { `billing_address`: [`Address`](../../internal/classes/admin_collections.internal.Address.mdx) ; `currency_code`: `string` ; `discounts`: [`Discount`](../../internal/classes/admin_collections.internal.Discount.mdx)[] ; `display_id`: `number` ; `email?`: `string` ; `is_claim?`: `boolean` ; `is_swap?`: `boolean` ; `items`: [`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)[] ; `no_notification`: `boolean` ; `payments`: [`Payment`](../../internal/classes/admin_collections.internal.Payment.mdx)[] ; `region?`: [`Region`](../../internal/classes/admin_collections.internal.Region.mdx) ; `region_id`: `string` ; `shipping_methods`: [`ShippingMethod`](../../internal/classes/admin_collections.internal.ShippingMethod.mdx)[] ; `tax_rate`: `number` \| ``null`` } + **CreateFulfillmentOrder**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`ClaimOrder`](../../internal/classes/admin_collections.internal.ClaimOrder.mdx), ``"beforeInsert"``\> & { `billing_address`: [`Address`](../../internal/classes/admin_collections.internal.Address.mdx) ; `currency_code`: `string` ; `discounts`: [`Discount`](../../internal/classes/admin_collections.internal.Discount.mdx)[] ; `display_id`: `number` ; `email?`: `string` ; `is_claim?`: `boolean` ; `is_swap?`: `boolean` ; `items`: [`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)[] ; `no_notification`: `boolean` ; `payments`: [`Payment`](../../internal/classes/admin_collections.internal.Payment.mdx)[] ; `region?`: [`Region`](../../internal/classes/admin_collections.internal.Region.mdx) ; `region_id`: `string` ; `shipping_methods`: [`ShippingMethod`](../../internal/classes/admin_collections.internal.ShippingMethod.mdx)[] ; `tax_rate`: `number` \| ``null`` } ___ ### CreateGiftCardInput -Ƭ **CreateGiftCardInput**: `Object` + **CreateGiftCardInput**: `Object` #### Type declaration @@ -1702,7 +1702,7 @@ ___ ### CreateGiftCardTransactionInput -Ƭ **CreateGiftCardTransactionInput**: `Object` + **CreateGiftCardTransactionInput**: `Object` #### Type declaration @@ -1761,7 +1761,7 @@ ___ ### CreateIdempotencyKeyInput -Ƭ **CreateIdempotencyKeyInput**: `Object` + **CreateIdempotencyKeyInput**: `Object` #### Type declaration @@ -1804,7 +1804,7 @@ ___ ### CreateInventoryItemInput -Ƭ **CreateInventoryItemInput**: `Object` + **CreateInventoryItemInput**: `Object` #### Type declaration @@ -1927,7 +1927,7 @@ ___ ### CreateInventoryLevelInput -Ƭ **CreateInventoryLevelInput**: `Object` + **CreateInventoryLevelInput**: `Object` #### Type declaration @@ -1978,7 +1978,7 @@ ___ ### CreateOauthInput -Ƭ **CreateOauthInput**: `Object` + **CreateOauthInput**: `Object` #### Type declaration @@ -2021,7 +2021,7 @@ ___ ### CreateOrderEditInput -Ƭ **CreateOrderEditInput**: `Object` + **CreateOrderEditInput**: `Object` #### Type declaration @@ -2048,7 +2048,7 @@ ___ ### CreateOrderEditItemChangeInput -Ƭ **CreateOrderEditItemChangeInput**: `Object` + **CreateOrderEditItemChangeInput**: `Object` #### Type declaration @@ -2091,7 +2091,7 @@ ___ ### CreatePaymentCollectionInput -Ƭ **CreatePaymentCollectionInput**: `Object` + **CreatePaymentCollectionInput**: `Object` #### Type declaration @@ -2158,7 +2158,7 @@ ___ ### CreatePaymentInput -Ƭ **CreatePaymentInput**: `Object` + **CreatePaymentInput**: `Object` #### Type declaration @@ -2217,13 +2217,13 @@ ___ ### CreateProductCategoryInput -Ƭ **CreateProductCategoryInput**: [`ProductCategoryInput`](admin_discounts.internal.mdx#productcategoryinput) & { `name`: `string` } + **CreateProductCategoryInput**: [`ProductCategoryInput`](admin_discounts.internal.mdx#productcategoryinput) & { `name`: `string` } ___ ### CreateProductCollection -Ƭ **CreateProductCollection**: `Object` + **CreateProductCollection**: `Object` #### Type declaration @@ -2258,7 +2258,7 @@ ___ ### CreateProductInput -Ƭ **CreateProductInput**: `Object` + **CreateProductInput**: `Object` Service Level DTOs @@ -2487,7 +2487,7 @@ ___ ### CreateProductProductCategoryInput -Ƭ **CreateProductProductCategoryInput**: `Object` + **CreateProductProductCategoryInput**: `Object` #### Type declaration @@ -2506,7 +2506,7 @@ ___ ### CreateProductProductOption -Ƭ **CreateProductProductOption**: `Object` + **CreateProductProductOption**: `Object` #### Type declaration @@ -2525,7 +2525,7 @@ ___ ### CreateProductProductSalesChannelInput -Ƭ **CreateProductProductSalesChannelInput**: `Object` + **CreateProductProductSalesChannelInput**: `Object` #### Type declaration @@ -2544,7 +2544,7 @@ ___ ### CreateProductProductTagInput -Ƭ **CreateProductProductTagInput**: `Object` + **CreateProductProductTagInput**: `Object` #### Type declaration @@ -2571,7 +2571,7 @@ ___ ### CreateProductProductTypeInput -Ƭ **CreateProductProductTypeInput**: `Object` + **CreateProductProductTypeInput**: `Object` #### Type declaration @@ -2598,7 +2598,7 @@ ___ ### CreateProductProductVariantInput -Ƭ **CreateProductProductVariantInput**: `Object` + **CreateProductProductVariantInput**: `Object` #### Type declaration @@ -2761,7 +2761,7 @@ ___ ### CreateProductProductVariantPriceInput -Ƭ **CreateProductProductVariantPriceInput**: `Object` + **CreateProductProductVariantPriceInput**: `Object` #### Type declaration @@ -2812,7 +2812,7 @@ ___ ### CreateProductVariantInput -Ƭ **CreateProductVariantInput**: `Object` + **CreateProductVariantInput**: `Object` #### Type declaration @@ -2991,7 +2991,7 @@ ___ ### CreateRegionInput -Ƭ **CreateRegionInput**: `Object` + **CreateRegionInput**: `Object` #### Type declaration @@ -3074,7 +3074,7 @@ ___ ### CreateReservationItemInput -Ƭ **CreateReservationItemInput**: `Object` + **CreateReservationItemInput**: `Object` #### Type declaration @@ -3149,7 +3149,7 @@ ___ ### CreateReturnInput -Ƭ **CreateReturnInput**: `Object` + **CreateReturnInput**: `Object` #### Type declaration @@ -3248,7 +3248,7 @@ ___ ### CreateReturnReason -Ƭ **CreateReturnReason**: `Object` + **CreateReturnReason**: `Object` #### Type declaration @@ -3299,13 +3299,13 @@ ___ ### CreateReturnType -Ƭ **CreateReturnType**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`Return`](../../internal/classes/admin_collections.internal.Return.mdx), ``"beforeInsert"``\> + **CreateReturnType**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`Return`](../../internal/classes/admin_collections.internal.Return.mdx), ``"beforeInsert"``\> ___ ### CreateSalesChannelInput -Ƭ **CreateSalesChannelInput**: `Object` + **CreateSalesChannelInput**: `Object` #### Type declaration @@ -3340,7 +3340,7 @@ ___ ### CreateShipmentConfig -Ƭ **CreateShipmentConfig**: `Object` + **CreateShipmentConfig**: `Object` #### Type declaration @@ -3375,7 +3375,7 @@ ___ ### CreateShippingMethod -Ƭ **CreateShippingMethod**: `Object` + **CreateShippingMethod**: `Object` #### Type declaration @@ -3458,13 +3458,13 @@ ___ ### CreateShippingMethodDto -Ƭ **CreateShippingMethodDto**: [`CreateShippingMethod`](admin_discounts.internal.mdx#createshippingmethod) & { `cart?`: [`Cart`](../../internal/classes/admin_collections.internal.Cart.mdx) ; `order?`: [`Order`](../../internal/classes/admin_collections.internal.Order.mdx) } + **CreateShippingMethodDto**: [`CreateShippingMethod`](admin_discounts.internal.mdx#createshippingmethod) & { `cart?`: [`Cart`](../../internal/classes/admin_collections.internal.Cart.mdx) ; `order?`: [`Order`](../../internal/classes/admin_collections.internal.Order.mdx) } ___ ### CreateShippingOptionInput -Ƭ **CreateShippingOptionInput**: `Object` + **CreateShippingOptionInput**: `Object` #### Type declaration @@ -3571,7 +3571,7 @@ ___ ### CreateShippingProfile -Ƭ **CreateShippingProfile**: `Object` + **CreateShippingProfile**: `Object` #### Type declaration @@ -3606,7 +3606,7 @@ ___ ### CreateStockLocationInput -Ƭ **CreateStockLocationInput**: `Object` + **CreateStockLocationInput**: `Object` #### Schema @@ -3653,7 +3653,7 @@ ___ ### CreateTaxRateInput -Ƭ **CreateTaxRateInput**: `Object` + **CreateTaxRateInput**: `Object` #### Type declaration @@ -3696,7 +3696,7 @@ ___ ### CustomerGroupConstructorProps -Ƭ **CustomerGroupConstructorProps**: `Object` + **CustomerGroupConstructorProps**: `Object` #### Type declaration @@ -3731,19 +3731,19 @@ ___ ### DefaultWithoutRelations -Ƭ **DefaultWithoutRelations**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`ExtendedFindConfig`](../../internal/modules/admin_discounts.internal.internal.mdx#extendedfindconfig)<[`CustomerGroup`](../../internal/classes/admin_collections.internal.CustomerGroup.mdx)\>, ``"relations"``\> + **DefaultWithoutRelations**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`ExtendedFindConfig`](../../internal/modules/admin_discounts.internal.internal.mdx#extendedfindconfig)<[`CustomerGroup`](../../internal/classes/admin_collections.internal.CustomerGroup.mdx)\>, ``"relations"``\> ___ ### DefaultWithoutRelations -Ƭ **DefaultWithoutRelations**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`ExtendedFindConfig`](admin_discounts.internal.mdx#extendedfindconfig)<[`Product`](../../internal/classes/admin_collections.internal.Product.mdx)\>, ``"relations"``\> + **DefaultWithoutRelations**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`ExtendedFindConfig`](admin_discounts.internal.mdx#extendedfindconfig)<[`Product`](../../internal/classes/admin_collections.internal.Product.mdx)\>, ``"relations"``\> ___ ### DeleteFileType -Ƭ **DeleteFileType**: `Object` + **DeleteFileType**: `Object` #### Index signature @@ -3766,7 +3766,7 @@ ___ ### DeleteResponse -Ƭ **DeleteResponse**: `Object` + **DeleteResponse**: `Object` #### Type declaration @@ -3801,7 +3801,7 @@ ___ ### Discount -Ƭ **Discount**: `Object` + **Discount**: `Object` #### Type declaration @@ -3820,7 +3820,7 @@ ___ ### DiscountAllocation -Ƭ **DiscountAllocation**: `Object` + **DiscountAllocation**: `Object` The amount of a discount allocated to a line item @@ -3849,7 +3849,7 @@ ___ ### DiscountConditionInput -Ƭ **DiscountConditionInput**: `Object` + **DiscountConditionInput**: `Object` #### Type declaration @@ -3924,13 +3924,13 @@ ___ ### DiscountConditionResourceType -Ƭ **DiscountConditionResourceType**: `EntityTarget`<[`DiscountConditionProduct`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionProduct.mdx) \| [`DiscountConditionProductType`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionProductType.mdx) \| [`DiscountConditionProductCollection`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionProductCollection.mdx) \| [`DiscountConditionProductTag`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionProductTag.mdx) \| [`DiscountConditionCustomerGroup`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx)\> + **DiscountConditionResourceType**: `EntityTarget`<[`DiscountConditionProduct`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionProduct.mdx) \| [`DiscountConditionProductType`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionProductType.mdx) \| [`DiscountConditionProductCollection`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionProductCollection.mdx) \| [`DiscountConditionProductTag`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionProductTag.mdx) \| [`DiscountConditionCustomerGroup`](../../internal/classes/admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx)\> ___ ### DraftOrderCreateProps -Ƭ **DraftOrderCreateProps**: `Object` + **DraftOrderCreateProps**: `Object` #### Type declaration @@ -4053,7 +4053,7 @@ ___ ### EmitData -Ƭ **EmitData**<`T`\>: `Object` + **EmitData**<`T`\>: `Object` #### Type parameters @@ -4101,7 +4101,7 @@ ___ ### ExtendedFindConfig -Ƭ **ExtendedFindConfig**<`TEntity`\>: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<`FindOneOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> \| [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<`FindManyOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> & { `order?`: `FindOptionsOrder`<`TEntity`\> ; `relations?`: `FindOptionsRelations`<`TEntity`\> ; `select?`: `FindOptionsSelect`<`TEntity`\> ; `skip?`: `number` ; `take?`: `number` ; `where`: `FindOptionsWhere`<`TEntity`\> \| `FindOptionsWhere`<`TEntity`\>[] } + **ExtendedFindConfig**<`TEntity`\>: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<`FindOneOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> \| [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<`FindManyOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> & { `order?`: `FindOptionsOrder`<`TEntity`\> ; `relations?`: `FindOptionsRelations`<`TEntity`\> ; `select?`: `FindOptionsSelect`<`TEntity`\> ; `skip?`: `number` ; `take?`: `number` ; `where`: `FindOptionsWhere`<`TEntity`\> \| `FindOptionsWhere`<`TEntity`\>[] } #### Type parameters @@ -4120,7 +4120,7 @@ ___ ### ExtendedStoreDTO -Ƭ **ExtendedStoreDTO**: [`Store`](../../internal/classes/admin_discounts.internal.internal.Store.mdx) & { `feature_flags`: [`FeatureFlagsResponse`](admin_discounts.internal.mdx#featureflagsresponse) ; `fulfillment_providers`: [`FulfillmentProvider`](../../internal/classes/admin_collections.internal.FulfillmentProvider.mdx)[] ; `modules`: [`ModulesResponse`](admin_discounts.internal.mdx#modulesresponse) ; `payment_providers`: [`PaymentProvider`](../../internal/classes/admin_collections.internal.PaymentProvider.mdx)[] } + **ExtendedStoreDTO**: [`Store`](../../internal/classes/admin_discounts.internal.internal.Store.mdx) & { `feature_flags`: [`FeatureFlagsResponse`](admin_discounts.internal.mdx#featureflagsresponse) ; `fulfillment_providers`: [`FulfillmentProvider`](../../internal/classes/admin_collections.internal.FulfillmentProvider.mdx)[] ; `modules`: [`ModulesResponse`](admin_discounts.internal.mdx#modulesresponse) ; `payment_providers`: [`PaymentProvider`](../../internal/classes/admin_collections.internal.PaymentProvider.mdx)[] } #### Schema @@ -4147,7 +4147,7 @@ ___ ### ExternalModuleDeclaration -Ƭ **ExternalModuleDeclaration**: `Object` + **ExternalModuleDeclaration**: `Object` #### Type declaration @@ -4230,7 +4230,7 @@ ___ ### FeatureFlagsResponse -Ƭ **FeatureFlagsResponse**: { `key`: `string` ; `value`: `boolean` \| Record<`string`, `boolean`\> }[] + **FeatureFlagsResponse**: { `key`: `string` ; `value`: `boolean` \| Record<`string`, `boolean`\> }[] #### Schema @@ -4253,7 +4253,7 @@ ___ ### FeatureFlagsResponse -Ƭ **FeatureFlagsResponse**: { `key`: `string` ; `value`: `boolean` \| Record<`string`, `boolean`\> }[] + **FeatureFlagsResponse**: { `key`: `string` ; `value`: `boolean` \| Record<`string`, `boolean`\> }[] #### Schema @@ -4276,7 +4276,7 @@ ___ ### FileServiceGetUploadStreamResult -Ƭ **FileServiceGetUploadStreamResult**: `Object` + **FileServiceGetUploadStreamResult**: `Object` #### Index signature @@ -4323,7 +4323,7 @@ ___ ### FileServiceUploadResult -Ƭ **FileServiceUploadResult**: `Object` + **FileServiceUploadResult**: `Object` #### Type declaration @@ -4350,7 +4350,7 @@ ___ ### FilterableInventoryItemProps -Ƭ **FilterableInventoryItemProps**: `Object` + **FilterableInventoryItemProps**: `Object` #### Type declaration @@ -4417,7 +4417,7 @@ ___ ### FilterableInventoryLevelProps -Ƭ **FilterableInventoryLevelProps**: `Object` + **FilterableInventoryLevelProps**: `Object` #### Type declaration @@ -4468,7 +4468,7 @@ ___ ### FilterableReservationItemProps -Ƭ **FilterableReservationItemProps**: `Object` + **FilterableReservationItemProps**: `Object` #### Type declaration @@ -4543,7 +4543,7 @@ ___ ### FilterableStockLocationProps -Ƭ **FilterableStockLocationProps**: `Object` + **FilterableStockLocationProps**: `Object` #### Type declaration @@ -4570,7 +4570,7 @@ ___ ### FilterableTaxRateProps -Ƭ **FilterableTaxRateProps**: `Object` + **FilterableTaxRateProps**: `Object` #### Type declaration @@ -4637,37 +4637,37 @@ ___ ### FilterableUserProps -Ƭ **FilterableUserProps**: [`PartialPick`](../../internal/modules/admin_discounts.internal.internal.mdx#partialpick)<[`User`](../../internal/classes/admin_auth.internal.User.mdx), ``"email"`` \| ``"first_name"`` \| ``"last_name"`` \| ``"created_at"`` \| ``"updated_at"`` \| ``"deleted_at"``\> + **FilterableUserProps**: [`PartialPick`](../../internal/modules/admin_discounts.internal.internal.mdx#partialpick)<[`User`](../../internal/classes/admin_auth.internal.User.mdx), ``"email"`` \| ``"first_name"`` \| ``"last_name"`` \| ``"created_at"`` \| ``"updated_at"`` \| ``"deleted_at"``\> ___ ### FindProductConfig -Ƭ **FindProductConfig**: [`FindConfig`](../../internal/interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Product`](../../internal/classes/admin_collections.internal.Product.mdx)\> & [`PriceListLoadConfig`](../../internal/modules/admin_discounts.internal.internal.mdx#pricelistloadconfig) + **FindProductConfig**: [`FindConfig`](../../internal/interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Product`](../../internal/classes/admin_collections.internal.Product.mdx)\> & [`PriceListLoadConfig`](../../internal/modules/admin_discounts.internal.internal.mdx#pricelistloadconfig) ___ ### FindWithRelationsOptions -Ƭ **FindWithRelationsOptions**: `FindManyOptions`<[`ProductVariant`](../../internal/classes/admin_collections.internal.ProductVariant.mdx)\> & { `order?`: `FindOptionsOrder`<[`ProductVariant`](../../internal/classes/admin_collections.internal.ProductVariant.mdx)\> ; `withDeleted?`: `boolean` } + **FindWithRelationsOptions**: `FindManyOptions`<[`ProductVariant`](../../internal/classes/admin_collections.internal.ProductVariant.mdx)\> & { `order?`: `FindOptionsOrder`<[`ProductVariant`](../../internal/classes/admin_collections.internal.ProductVariant.mdx)\> ; `withDeleted?`: `boolean` } ___ ### FindWithoutRelationsOptions -Ƭ **FindWithoutRelationsOptions**: [`DefaultWithoutRelations`](admin_discounts.internal.mdx#defaultwithoutrelations) & { `where`: [`DefaultWithoutRelations`](admin_discounts.internal.mdx#defaultwithoutrelations)[``"where"``] & { `discount_condition_id?`: `string` \| `FindOperator`<`string`\> } } + **FindWithoutRelationsOptions**: [`DefaultWithoutRelations`](admin_discounts.internal.mdx#defaultwithoutrelations) & { `where`: [`DefaultWithoutRelations`](admin_discounts.internal.mdx#defaultwithoutrelations)[``"where"``] & { `discount_condition_id?`: `string` \| `FindOperator`<`string`\> } } ___ ### FindWithoutRelationsOptions -Ƭ **FindWithoutRelationsOptions**: [`DefaultWithoutRelations`](admin_discounts.internal.mdx#defaultwithoutrelations-1) & { `where`: [`DefaultWithoutRelations`](admin_discounts.internal.mdx#defaultwithoutrelations-1)[``"where"``] & { `categories?`: `FindOptionsWhere`<[`ProductCategory`](../../internal/classes/admin_collections.internal.ProductCategory.mdx)\> ; `category_id?`: [`CategoryQueryParams`](admin_discounts.internal.mdx#categoryqueryparams) ; `discount_condition_id?`: `string` ; `include_category_children?`: `boolean` ; `price_list_id?`: `FindOperator`<[`PriceList`](../../internal/classes/admin_collections.internal.PriceList.mdx)\> ; `sales_channel_id?`: `FindOperator`<[`SalesChannel`](../../internal/classes/admin_collections.internal.SalesChannel.mdx)\> ; `tags?`: `FindOperator`<[`ProductTag`](../../internal/classes/admin_collections.internal.ProductTag.mdx)\> } } + **FindWithoutRelationsOptions**: [`DefaultWithoutRelations`](admin_discounts.internal.mdx#defaultwithoutrelations-1) & { `where`: [`DefaultWithoutRelations`](admin_discounts.internal.mdx#defaultwithoutrelations-1)[``"where"``] & { `categories?`: `FindOptionsWhere`<[`ProductCategory`](../../internal/classes/admin_collections.internal.ProductCategory.mdx)\> ; `category_id?`: [`CategoryQueryParams`](admin_discounts.internal.mdx#categoryqueryparams) ; `discount_condition_id?`: `string` ; `include_category_children?`: `boolean` ; `price_list_id?`: `FindOperator`<[`PriceList`](../../internal/classes/admin_collections.internal.PriceList.mdx)\> ; `sales_channel_id?`: `FindOperator`<[`SalesChannel`](../../internal/classes/admin_collections.internal.SalesChannel.mdx)\> ; `tags?`: `FindOperator`<[`ProductTag`](../../internal/classes/admin_collections.internal.ProductTag.mdx)\> } } ___ ### FulFillmentItemType -Ƭ **FulFillmentItemType**: `Object` + **FulFillmentItemType**: `Object` #### Type declaration @@ -4694,7 +4694,7 @@ ___ ### FulfillmentItemPartition -Ƭ **FulfillmentItemPartition**: `Object` + **FulfillmentItemPartition**: `Object` #### Type declaration @@ -4721,7 +4721,7 @@ ___ ### FulfillmentOptions -Ƭ **FulfillmentOptions**: `Object` + **FulfillmentOptions**: `Object` #### Type declaration @@ -4748,25 +4748,25 @@ ___ ### FulfillmentProviderContainer -Ƭ **FulfillmentProviderContainer**: [`MedusaContainer`](../../internal/modules/admin_discounts.internal.internal.mdx#medusacontainer) & { `fulfillmentProviderRepository`: typeof [`FulfillmentProviderRepository`](admin_discounts.internal.mdx#fulfillmentproviderrepository) ; `manager`: `EntityManager` } & { [key in \`${FulfillmentProviderKey}\`]: typeof BaseFulfillmentService } + **FulfillmentProviderContainer**: [`MedusaContainer`](../../internal/modules/admin_discounts.internal.internal.mdx#medusacontainer) & { `fulfillmentProviderRepository`: typeof [`FulfillmentProviderRepository`](admin_discounts.internal.mdx#fulfillmentproviderrepository) ; `manager`: `EntityManager` } & { [key in \`${FulfillmentProviderKey}\`]: typeof BaseFulfillmentService } ___ ### FulfillmentProviderData -Ƭ **FulfillmentProviderData**: Record<`string`, `unknown`\> + **FulfillmentProviderData**: Record<`string`, `unknown`\> ___ ### FulfillmentProviderKey -Ƭ **FulfillmentProviderKey**: \`fp\_${string}\` + **FulfillmentProviderKey**: \`fp\_${string}\` ___ ### GenerateInputData -Ƭ **GenerateInputData**: `Object` + **GenerateInputData**: `Object` #### Type declaration @@ -4809,7 +4809,7 @@ ___ ### GenerateLineItemContext -Ƭ **GenerateLineItemContext**: `Object` + **GenerateLineItemContext**: `Object` #### Type declaration @@ -4876,7 +4876,7 @@ ___ ### GeneratedAdjustment -Ƭ **GeneratedAdjustment**: `Object` + **GeneratedAdjustment**: `Object` #### Type declaration @@ -4911,7 +4911,7 @@ ___ ### GetLineItemTotalOptions -Ƭ **GetLineItemTotalOptions**: `Object` + **GetLineItemTotalOptions**: `Object` #### Type declaration @@ -4938,7 +4938,7 @@ ___ ### GetRegionPriceContext -Ƭ **GetRegionPriceContext**: `Object` + **GetRegionPriceContext**: `Object` #### Type declaration @@ -4981,7 +4981,7 @@ ___ ### GetShippingMethodTotalsOptions -Ƭ **GetShippingMethodTotalsOptions**: `Object` + **GetShippingMethodTotalsOptions**: `Object` #### Type declaration @@ -5016,7 +5016,7 @@ ___ ### GetTotalsOptions -Ƭ **GetTotalsOptions**: `Object` + **GetTotalsOptions**: `Object` #### Type declaration @@ -5043,7 +5043,7 @@ ___ ### GetUploadedFileType -Ƭ **GetUploadedFileType**: `Object` + **GetUploadedFileType**: `Object` #### Index signature @@ -5074,7 +5074,7 @@ ___ ### GiftCardAllocation -Ƭ **GiftCardAllocation**: `Object` + **GiftCardAllocation**: `Object` The amount of a gift card allocated to a line item @@ -5103,7 +5103,7 @@ ___ ### GiftCardTransaction -Ƭ **GiftCardTransaction**: `Object` + **GiftCardTransaction**: `Object` #### Type declaration @@ -5146,7 +5146,7 @@ ___ ### HttpCompressionOptions -Ƭ **HttpCompressionOptions**: `Object` + **HttpCompressionOptions**: `Object` #### Type declaration @@ -5189,7 +5189,7 @@ ___ ### IdempotencyCallbackResult -Ƭ **IdempotencyCallbackResult**: `Object` + **IdempotencyCallbackResult**: `Object` #### Type declaration @@ -5224,7 +5224,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -5251,7 +5251,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -5286,7 +5286,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -5329,7 +5329,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -5564,7 +5564,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -5711,7 +5711,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -5754,7 +5754,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -5781,7 +5781,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -5824,7 +5824,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -5859,7 +5859,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -5950,7 +5950,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -5985,7 +5985,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6036,7 +6036,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6063,7 +6063,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6162,7 +6162,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6205,7 +6205,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6240,7 +6240,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6283,13 +6283,13 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: [`MedusaContainer`](../../internal/modules/admin_discounts.internal.internal.mdx#medusacontainer) & { `eventBusService`: [`EventBusService`](../../internal/classes/admin_discounts.internal.internal.EventBusService.mdx) ; `manager`: `EntityManager` ; `oauthRepository`: typeof [`OauthRepository`](admin_discounts.internal.mdx#oauthrepository) } + **InjectedDependencies**: [`MedusaContainer`](../../internal/modules/admin_discounts.internal.internal.mdx#medusacontainer) & { `eventBusService`: [`EventBusService`](../../internal/classes/admin_discounts.internal.internal.EventBusService.mdx) ; `manager`: `EntityManager` ; `oauthRepository`: typeof [`OauthRepository`](admin_discounts.internal.mdx#oauthrepository) } ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6476,7 +6476,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6575,7 +6575,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6626,7 +6626,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6677,13 +6677,13 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: { `customerService`: [`CustomerService`](../../internal/classes/admin_discounts.internal.internal.CustomerService.mdx) ; `featureFlagRouter`: [`FlagRouter`](../../internal/classes/admin_discounts.internal.FlagRouter.mdx) ; `logger`: [`Logger`](../../internal/modules/admin_discounts.internal.internal.mdx#logger) ; `manager`: `EntityManager` ; `paymentProviderRepository`: typeof [`PaymentProviderRepository`](admin_discounts.internal.mdx#paymentproviderrepository) ; `paymentRepository`: typeof [`PaymentRepository`](admin_discounts.internal.mdx#paymentrepository) ; `paymentService`: [`PaymentService`](../../internal/classes/admin_discounts.internal.PaymentService.mdx) ; `paymentSessionRepository`: typeof [`PaymentSessionRepository`](admin_discounts.internal.mdx#paymentsessionrepository) ; `refundRepository`: typeof [`RefundRepository`](admin_discounts.internal.mdx#refundrepository) } & { [key in \`${PaymentProviderKey}\`]: AbstractPaymentService \| typeof BasePaymentService } + **InjectedDependencies**: { `customerService`: [`CustomerService`](../../internal/classes/admin_discounts.internal.internal.CustomerService.mdx) ; `featureFlagRouter`: [`FlagRouter`](../../internal/classes/admin_discounts.internal.FlagRouter.mdx) ; `logger`: [`Logger`](../../internal/modules/admin_discounts.internal.internal.mdx#logger) ; `manager`: `EntityManager` ; `paymentProviderRepository`: typeof [`PaymentProviderRepository`](admin_discounts.internal.mdx#paymentproviderrepository) ; `paymentRepository`: typeof [`PaymentRepository`](admin_discounts.internal.mdx#paymentrepository) ; `paymentService`: [`PaymentService`](../../internal/classes/admin_discounts.internal.PaymentService.mdx) ; `paymentSessionRepository`: typeof [`PaymentSessionRepository`](admin_discounts.internal.mdx#paymentsessionrepository) ; `refundRepository`: typeof [`RefundRepository`](admin_discounts.internal.mdx#refundrepository) } & { [key in \`${PaymentProviderKey}\`]: AbstractPaymentService \| typeof BasePaymentService } ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6742,7 +6742,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6849,7 +6849,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6884,7 +6884,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6927,7 +6927,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -6994,7 +6994,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -7101,7 +7101,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -7208,7 +7208,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -7235,7 +7235,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -7278,7 +7278,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -7321,7 +7321,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -7364,7 +7364,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -7391,7 +7391,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -7458,7 +7458,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -7525,7 +7525,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -7568,7 +7568,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Index signature @@ -7591,7 +7591,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -7610,7 +7610,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -7693,7 +7693,7 @@ ___ ### InjectedDependencies -Ƭ **InjectedDependencies**: `Object` + **InjectedDependencies**: `Object` #### Type declaration @@ -7736,7 +7736,7 @@ ___ ### InjectedProps -Ƭ **InjectedProps**: `Object` + **InjectedProps**: `Object` #### Type declaration @@ -7859,7 +7859,7 @@ ___ ### InternalModuleDeclaration -Ƭ **InternalModuleDeclaration**: `Object` + **InternalModuleDeclaration**: `Object` #### Type declaration @@ -7934,7 +7934,7 @@ ___ ### InventoryItemDTO -Ƭ **InventoryItemDTO**: `Object` + **InventoryItemDTO**: `Object` #### Schema @@ -8093,7 +8093,7 @@ ___ ### InventoryLevelDTO -Ƭ **InventoryLevelDTO**: `Object` + **InventoryLevelDTO**: `Object` #### Schema @@ -8188,7 +8188,7 @@ ___ ### Item -Ƭ **Item**: `Object` + **Item**: `Object` #### Type declaration @@ -8239,7 +8239,7 @@ ___ ### IteratorResult -Ƭ **IteratorResult**<`T`, `TReturn`\>: [`IteratorYieldResult`](../../internal/interfaces/admin_discounts.internal.IteratorYieldResult.mdx)<`T`\> \| [`IteratorReturnResult`](../../internal/interfaces/admin_discounts.internal.IteratorReturnResult.mdx)<`TReturn`\> + **IteratorResult**<`T`, `TReturn`\>: [`IteratorYieldResult`](../../internal/interfaces/admin_discounts.internal.IteratorYieldResult.mdx)<`T`\> \| [`IteratorReturnResult`](../../internal/interfaces/admin_discounts.internal.IteratorReturnResult.mdx)<`TReturn`\> #### Type parameters @@ -8266,7 +8266,7 @@ ___ ### JoinerRelationship -Ƭ **JoinerRelationship**: `Object` + **JoinerRelationship**: `Object` #### Type declaration @@ -8341,7 +8341,7 @@ ___ ### LineAllocationsMap -Ƭ **LineAllocationsMap**: `object` + **LineAllocationsMap**: `object` A map of line item ids and its corresponding gift card and discount allocations @@ -8354,7 +8354,7 @@ ___ ### LineDiscount -Ƭ **LineDiscount**: `Object` + **LineDiscount**: `Object` Associates a line item and discount allocation. @@ -8391,7 +8391,7 @@ ___ ### LineDiscountAmount -Ƭ **LineDiscountAmount**: `Object` + **LineDiscountAmount**: `Object` Associates a line item and discount allocation. @@ -8428,7 +8428,7 @@ ___ ### LineItemAdjustmentServiceProps -Ƭ **LineItemAdjustmentServiceProps**: `Object` + **LineItemAdjustmentServiceProps**: `Object` #### Type declaration @@ -8463,7 +8463,7 @@ ___ ### LineItemTotals -Ƭ **LineItemTotals**: `Object` + **LineItemTotals**: `Object` #### Type declaration @@ -8554,7 +8554,7 @@ ___ ### LineItemTotals -Ƭ **LineItemTotals**: `Object` + **LineItemTotals**: `Object` #### Type declaration @@ -8645,7 +8645,7 @@ ___ ### LineItemTotalsOptions -Ƭ **LineItemTotalsOptions**: `Object` + **LineItemTotalsOptions**: `Object` #### Type declaration @@ -8688,7 +8688,7 @@ ___ ### LineItemUpdate -Ƭ **LineItemUpdate**: `Object` + **LineItemUpdate**: `Object` #### Type declaration @@ -8755,7 +8755,7 @@ ___ ### LineItemValidateData -Ƭ **LineItemValidateData**: `Object` + **LineItemValidateData**: `Object` #### Type declaration @@ -8790,17 +8790,17 @@ ___ ### ListAndCountSelector -Ƭ **ListAndCountSelector**: [`Selector`](../../internal/modules/admin_discounts.internal.internal.mdx#selector)<[`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)\> & { `discount_condition_id?`: `string` ; `q?`: `string` } + **ListAndCountSelector**: [`Selector`](../../internal/modules/admin_discounts.internal.internal.mdx#selector)<[`ProductCollection`](../../internal/classes/admin_collections.internal.ProductCollection.mdx)\> & { `discount_condition_id?`: `string` ; `q?`: `string` } ___ ### LookupFunction -Ƭ **LookupFunction**: (`hostname`: `string`, `options`: [`LookupOneOptions`](../../internal/interfaces/admin_discounts.internal.LookupOneOptions.mdx), `callback`: (`err`: [`ErrnoException`](../../internal/interfaces/admin_discounts.internal.ErrnoException.mdx) \| ``null``, `address`: `string`, `family`: `number`) => `void`) => `void` + **LookupFunction**: (`hostname`: `string`, `options`: [`LookupOneOptions`](../../internal/interfaces/admin_discounts.internal.LookupOneOptions.mdx), `callback`: (`err`: [`ErrnoException`](../../internal/interfaces/admin_discounts.internal.ErrnoException.mdx) \| ``null``, `address`: `string`, `family`: `number`) => `void`) => `void` #### Type declaration -▸ (`hostname`, `options`, `callback`): `void` +(`hostname`, `options`, `callback`): `void` ##### Parameters @@ -8850,25 +8850,25 @@ ___ ### MedusaContainer -Ƭ **MedusaContainer**: `AwilixContainer` & { `createScope`: () => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer) ; `registerAdd`: (`name`: `string`, `registration`: `T`) => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer) } + **MedusaContainer**: `AwilixContainer` & { `createScope`: () => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer) ; `registerAdd`: (`name`: `string`, `registration`: `T`) => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer) } ___ ### MedusaContainer -Ƭ **MedusaContainer**: `AwilixContainer` & { `createScope`: () => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer-1) ; `registerAdd`: (`name`: `string`, `registration`: `T`) => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer-1) } + **MedusaContainer**: `AwilixContainer` & { `createScope`: () => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer-1) ; `registerAdd`: (`name`: `string`, `registration`: `T`) => [`MedusaContainer`](admin_discounts.internal.mdx#medusacontainer-1) } ___ ### MiddlewareVerb -Ƭ **MiddlewareVerb**: ``"USE"`` \| ``"ALL"`` \| [`RouteVerb`](admin_discounts.internal.mdx#routeverb) + **MiddlewareVerb**: ``"USE"`` \| ``"ALL"`` \| [`RouteVerb`](admin_discounts.internal.mdx#routeverb) ___ ### ModuleDefinition -Ƭ **ModuleDefinition**: `Object` + **ModuleDefinition**: `Object` #### Type declaration @@ -8959,19 +8959,19 @@ ___ ### ModuleJoinerConfig -Ƭ **ModuleJoinerConfig**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`JoinerServiceConfig`](../../internal/interfaces/admin_discounts.internal.JoinerServiceConfig.mdx), ``"serviceName"`` \| ``"primaryKeys"`` \| ``"relationships"`` \| ``"extends"``\> & { `databaseConfig?`: { `extraFields?`: Record<`string`, { `defaultValue?`: `string` ; `nullable?`: `boolean` ; `options?`: Record<`string`, `unknown`\> ; `type`: ``"date"`` \| ``"time"`` \| ``"datetime"`` \| ``"bigint"`` \| ``"blob"`` \| ``"uint8array"`` \| ``"array"`` \| ``"enumArray"`` \| ``"enum"`` \| ``"json"`` \| ``"integer"`` \| ``"smallint"`` \| ``"tinyint"`` \| ``"mediumint"`` \| ``"float"`` \| ``"double"`` \| ``"boolean"`` \| ``"decimal"`` \| ``"string"`` \| ``"uuid"`` \| ``"text"`` }\> ; `idPrefix?`: `string` ; `tableName?`: `string` } ; `extends?`: { `fieldAlias?`: Record<`string`, `string` \| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\> ; `relationship`: [`ModuleJoinerRelationship`](admin_discounts.internal.mdx#modulejoinerrelationship) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](admin_discounts.internal.mdx#modulejoinerrelationship)[] ; `schema?`: `string` ; `serviceName?`: `string` } + **ModuleJoinerConfig**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`JoinerServiceConfig`](../../internal/interfaces/admin_discounts.internal.JoinerServiceConfig.mdx), ``"serviceName"`` \| ``"primaryKeys"`` \| ``"relationships"`` \| ``"extends"``\> & { `databaseConfig?`: { `extraFields?`: Record<`string`, { `defaultValue?`: `string` ; `nullable?`: `boolean` ; `options?`: Record<`string`, `unknown`\> ; `type`: ``"date"`` \| ``"time"`` \| ``"datetime"`` \| ``"bigint"`` \| ``"blob"`` \| ``"uint8array"`` \| ``"array"`` \| ``"enumArray"`` \| ``"enum"`` \| ``"json"`` \| ``"integer"`` \| ``"smallint"`` \| ``"tinyint"`` \| ``"mediumint"`` \| ``"float"`` \| ``"double"`` \| ``"boolean"`` \| ``"decimal"`` \| ``"string"`` \| ``"uuid"`` \| ``"text"`` }\> ; `idPrefix?`: `string` ; `tableName?`: `string` } ; `extends?`: { `fieldAlias?`: Record<`string`, `string` \| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\> ; `relationship`: [`ModuleJoinerRelationship`](admin_discounts.internal.mdx#modulejoinerrelationship) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](admin_discounts.internal.mdx#modulejoinerrelationship)[] ; `schema?`: `string` ; `serviceName?`: `string` } ___ ### ModuleJoinerRelationship -Ƭ **ModuleJoinerRelationship**: [`JoinerRelationship`](admin_discounts.internal.mdx#joinerrelationship) & { `deleteCascade?`: `boolean` ; `isInternalService?`: `boolean` } + **ModuleJoinerRelationship**: [`JoinerRelationship`](admin_discounts.internal.mdx#joinerrelationship) & { `deleteCascade?`: `boolean` ; `isInternalService?`: `boolean` } ___ ### ModulesResponse -Ƭ **ModulesResponse**: [`ModulesResponse`](admin_discounts.internal.mdx#modulesresponse-1) + **ModulesResponse**: [`ModulesResponse`](admin_discounts.internal.mdx#modulesresponse-1) #### Schema @@ -8994,13 +8994,13 @@ ___ ### ModulesResponse -Ƭ **ModulesResponse**: { `module`: `string` ; `resolution`: `string` \| ``false`` }[] + **ModulesResponse**: { `module`: `string` ; `resolution`: `string` \| ``false`` }[] ___ ### OrdersReturnItem -Ƭ **OrdersReturnItem**: `Object` + **OrdersReturnItem**: `Object` #### Type declaration @@ -9043,7 +9043,7 @@ ___ ### PaginatedResponse -Ƭ **PaginatedResponse**: `Object` + **PaginatedResponse**: `Object` #### Type declaration @@ -9078,7 +9078,7 @@ ___ ### Partial -Ƭ **Partial**<`T`\>: { [P in keyof T]?: T[P] } + **Partial**<`T`\>: { [P in keyof T]?: T[P] } Make all properties in T optional @@ -9099,7 +9099,7 @@ ___ ### PaymentCollectionsSessionsBatchInput -Ƭ **PaymentCollectionsSessionsBatchInput**: `Object` + **PaymentCollectionsSessionsBatchInput**: `Object` #### Type declaration @@ -9134,7 +9134,7 @@ ___ ### PaymentCollectionsSessionsInput -Ƭ **PaymentCollectionsSessionsInput**: `Object` + **PaymentCollectionsSessionsInput**: `Object` #### Type declaration @@ -9153,7 +9153,7 @@ ___ ### PaymentDataInput -Ƭ **PaymentDataInput**: `Object` + **PaymentDataInput**: `Object` #### Type declaration @@ -9196,13 +9196,13 @@ ___ ### PaymentProviderKey -Ƭ **PaymentProviderKey**: \`pp\_${string}\` \| ``"systemPaymentProviderService"`` + **PaymentProviderKey**: \`pp\_${string}\` \| ``"systemPaymentProviderService"`` ___ ### PaymentSessionInput -Ƭ **PaymentSessionInput**: `Object` + **PaymentSessionInput**: `Object` #### Type declaration @@ -9277,13 +9277,13 @@ ___ ### Price -Ƭ **Price**: [`Partial`](admin_discounts.internal.mdx#partial)<[`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`MoneyAmount`](../../internal/classes/admin_collections.internal.MoneyAmount.mdx), ``"created_at"`` \| ``"updated_at"`` \| ``"deleted_at"``\>\> & { `amount`: `number` } + **Price**: [`Partial`](admin_discounts.internal.mdx#partial)<[`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`MoneyAmount`](../../internal/classes/admin_collections.internal.MoneyAmount.mdx), ``"created_at"`` \| ``"updated_at"`` \| ``"deleted_at"``\>\> & { `amount`: `number` } ___ ### PriceListConstructorProps -Ƭ **PriceListConstructorProps**: `Object` + **PriceListConstructorProps**: `Object` #### Type declaration @@ -9366,7 +9366,7 @@ ___ ### PricedProduct -Ƭ **PricedProduct**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`Partial`](admin_discounts.internal.mdx#partial)<[`Product`](../../internal/classes/admin_collections.internal.Product.mdx)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](admin_discounts.internal.mdx#pricedvariant)[] } + **PricedProduct**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`Partial`](admin_discounts.internal.mdx#partial)<[`Product`](../../internal/classes/admin_collections.internal.Product.mdx)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](admin_discounts.internal.mdx#pricedvariant)[] } #### Schema @@ -9386,7 +9386,7 @@ ___ ### PricedShippingOption -Ƭ **PricedShippingOption**: [`Partial`](admin_discounts.internal.mdx#partial)<[`ShippingOption`](../../internal/classes/admin_collections.internal.ShippingOption.mdx)\> & [`ShippingOptionPricing`](admin_discounts.internal.mdx#shippingoptionpricing) + **PricedShippingOption**: [`Partial`](admin_discounts.internal.mdx#partial)<[`ShippingOption`](../../internal/classes/admin_collections.internal.ShippingOption.mdx)\> & [`ShippingOptionPricing`](admin_discounts.internal.mdx#shippingoptionpricing) #### Schema @@ -9423,7 +9423,7 @@ ___ ### PricedVariant -Ƭ **PricedVariant**: [`Partial`](admin_discounts.internal.mdx#partial)<[`ProductVariant`](../../internal/classes/admin_collections.internal.ProductVariant.mdx)\> & [`ProductVariantPricing`](admin_discounts.internal.mdx#productvariantpricing) + **PricedVariant**: [`Partial`](admin_discounts.internal.mdx#partial)<[`ProductVariant`](../../internal/classes/admin_collections.internal.ProductVariant.mdx)\> & [`ProductVariantPricing`](admin_discounts.internal.mdx#productvariantpricing) #### Schema @@ -9472,7 +9472,7 @@ ___ ### PricingContext -Ƭ **PricingContext**: `Object` + **PricingContext**: `Object` #### Type declaration @@ -9507,7 +9507,7 @@ ___ ### ProductCategoryInput -Ƭ **ProductCategoryInput**: `Object` + **ProductCategoryInput**: `Object` #### Type declaration @@ -9566,7 +9566,7 @@ ___ ### ProductOptionInput -Ƭ **ProductOptionInput**: `Object` + **ProductOptionInput**: `Object` #### Type declaration @@ -9593,13 +9593,13 @@ ___ ### ProductSelector -Ƭ **ProductSelector**: [`FilterableProductProps`](../../internal/classes/admin_discounts.internal.FilterableProductProps.mdx) \| [`Selector`](../../internal/modules/admin_discounts.internal.internal.mdx#selector)<[`Product`](../../internal/classes/admin_collections.internal.Product.mdx)\> & { `category_id?`: `string`[] \| `FindOperator`<[`ProductCategory`](../../internal/classes/admin_collections.internal.ProductCategory.mdx)\> ; `discount_condition_id?`: `string` ; `price_list_id?`: `string`[] \| `FindOperator`<[`PriceList`](../../internal/classes/admin_collections.internal.PriceList.mdx)\> ; `q?`: `string` ; `sales_channel_id?`: `string`[] \| `FindOperator`<[`SalesChannel`](../../internal/classes/admin_collections.internal.SalesChannel.mdx)\> } + **ProductSelector**: [`FilterableProductProps`](../../internal/classes/admin_discounts.internal.FilterableProductProps.mdx) \| [`Selector`](../../internal/modules/admin_discounts.internal.internal.mdx#selector)<[`Product`](../../internal/classes/admin_collections.internal.Product.mdx)\> & { `category_id?`: `string`[] \| `FindOperator`<[`ProductCategory`](../../internal/classes/admin_collections.internal.ProductCategory.mdx)\> ; `discount_condition_id?`: `string` ; `price_list_id?`: `string`[] \| `FindOperator`<[`PriceList`](../../internal/classes/admin_collections.internal.PriceList.mdx)\> ; `q?`: `string` ; `sales_channel_id?`: `string`[] \| `FindOperator`<[`SalesChannel`](../../internal/classes/admin_collections.internal.SalesChannel.mdx)\> } ___ ### ProductVariantOption -Ƭ **ProductVariantOption**: `Object` + **ProductVariantOption**: `Object` #### Type declaration @@ -9626,7 +9626,7 @@ ___ ### ProductVariantPrice -Ƭ **ProductVariantPrice**: `Object` + **ProductVariantPrice**: `Object` #### Type declaration @@ -9685,13 +9685,13 @@ ___ ### ProductVariantPricing -Ƭ **ProductVariantPricing**: { `calculated_price`: `number` \| ``null`` ; `calculated_price_includes_tax?`: `boolean` \| ``null`` ; `calculated_price_type?`: `string` \| ``null`` ; `original_price`: `number` \| ``null`` ; `original_price_includes_tax?`: `boolean` \| ``null`` ; `prices`: [`MoneyAmount`](../../internal/classes/admin_collections.internal.MoneyAmount.mdx)[] } & [`TaxedPricing`](admin_discounts.internal.mdx#taxedpricing) + **ProductVariantPricing**: { `calculated_price`: `number` \| ``null`` ; `calculated_price_includes_tax?`: `boolean` \| ``null`` ; `calculated_price_type?`: `string` \| ``null`` ; `original_price`: `number` \| ``null`` ; `original_price_includes_tax?`: `boolean` \| ``null`` ; `prices`: [`MoneyAmount`](../../internal/classes/admin_collections.internal.MoneyAmount.mdx)[] } & [`TaxedPricing`](admin_discounts.internal.mdx#taxedpricing) ___ ### ProjectConfigOptions -Ƭ **ProjectConfigOptions**: `Object` + **ProjectConfigOptions**: `Object` #### Type declaration @@ -9822,11 +9822,11 @@ ___ ### PropertyDecorator -Ƭ **PropertyDecorator**: (`target`: [`Object`](admin_discounts.internal.mdx#object), `propertyKey`: `string` \| `symbol`) => `void` + **PropertyDecorator**: (`target`: [`Object`](admin_discounts.internal.mdx#object), `propertyKey`: `string` \| `symbol`) => `void` #### Type declaration -▸ (`target`, `propertyKey`): `void` +(`target`, `propertyKey`): `void` ##### Parameters @@ -9868,13 +9868,13 @@ ___ ### PropertyKey -Ƭ **PropertyKey**: `string` \| `number` \| `symbol` + **PropertyKey**: `string` \| `number` \| `symbol` ___ ### ProviderLineItemTaxLine -Ƭ **ProviderLineItemTaxLine**: `Object` + **ProviderLineItemTaxLine**: `Object` The tax line properties for a given line item. @@ -9927,7 +9927,7 @@ ___ ### ProviderShippingMethodTaxLine -Ƭ **ProviderShippingMethodTaxLine**: `Object` + **ProviderShippingMethodTaxLine**: `Object` The tax line properties for a given shipping method. @@ -9980,7 +9980,7 @@ ___ ### ProviderTaxLine -Ƭ **ProviderTaxLine**: [`ProviderLineItemTaxLine`](admin_discounts.internal.mdx#providerlineitemtaxline) \| [`ProviderShippingMethodTaxLine`](admin_discounts.internal.mdx#providershippingmethodtaxline) + **ProviderTaxLine**: [`ProviderLineItemTaxLine`](admin_discounts.internal.mdx#providerlineitemtaxline) \| [`ProviderShippingMethodTaxLine`](admin_discounts.internal.mdx#providershippingmethodtaxline) A union type of the possible provider tax lines. @@ -9988,7 +9988,7 @@ ___ ### ReadableStreamController -Ƭ **ReadableStreamController**<`T`\>: [`ReadableStreamDefaultController`](admin_discounts.internal.mdx#readablestreamdefaultcontroller)<`T`\> + **ReadableStreamController**<`T`\>: [`ReadableStreamDefaultController`](admin_discounts.internal.mdx#readablestreamdefaultcontroller)<`T`\> #### Type parameters @@ -10007,7 +10007,7 @@ ___ ### ReadableStreamDefaultReadResult -Ƭ **ReadableStreamDefaultReadResult**<`T`\>: [`ReadableStreamDefaultReadValueResult`](../../internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadValueResult.mdx)<`T`\> \| [`ReadableStreamDefaultReadDoneResult`](../../internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadDoneResult.mdx) + **ReadableStreamDefaultReadResult**<`T`\>: [`ReadableStreamDefaultReadValueResult`](../../internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadValueResult.mdx)<`T`\> \| [`ReadableStreamDefaultReadDoneResult`](../../internal/interfaces/admin_discounts.internal.ReadableStreamDefaultReadDoneResult.mdx) #### Type parameters @@ -10026,7 +10026,7 @@ ___ ### RegionDetails -Ƭ **RegionDetails**: `Object` + **RegionDetails**: `Object` #### Type declaration @@ -10053,7 +10053,7 @@ ___ ### ReorderConditions -Ƭ **ReorderConditions**: `Object` + **ReorderConditions**: `Object` #### Type declaration @@ -10136,7 +10136,7 @@ ___ ### RequestContext -Ƭ **RequestContext**: `Object` + **RequestContext**: `Object` #### Type declaration @@ -10155,7 +10155,7 @@ ___ ### ReservationItemDTO -Ƭ **ReservationItemDTO**: `Object` + **ReservationItemDTO**: `Object` #### Schema @@ -10258,7 +10258,7 @@ ___ ### ReserveQuantityContext -Ƭ **ReserveQuantityContext**: `Object` + **ReserveQuantityContext**: `Object` #### Type declaration @@ -10293,7 +10293,7 @@ ___ ### ReturnedData -Ƭ **ReturnedData**: `Object` + **ReturnedData**: `Object` #### Type declaration @@ -10328,13 +10328,13 @@ ___ ### RouteVerb -Ƭ **RouteVerb**: typeof [`HTTP_METHODS`](admin_discounts.internal.mdx#http_methods)[`number`] + **RouteVerb**: typeof [`HTTP_METHODS`](admin_discounts.internal.mdx#http_methods)[`number`] ___ ### SessionOptions -Ƭ **SessionOptions**: `Object` + **SessionOptions**: `Object` #### Type declaration @@ -10393,7 +10393,7 @@ ___ ### SharedContext -Ƭ **SharedContext**: `Object` + **SharedContext**: `Object` #### Type declaration @@ -10420,7 +10420,7 @@ ___ ### ShippingMethod -Ƭ **ShippingMethod**: `Object` + **ShippingMethod**: `Object` #### Type declaration @@ -10455,13 +10455,13 @@ ___ ### ShippingMethodData -Ƭ **ShippingMethodData**: Record<`string`, `unknown`\> + **ShippingMethodData**: Record<`string`, `unknown`\> ___ ### ShippingMethodTotals -Ƭ **ShippingMethodTotals**: `Object` + **ShippingMethodTotals**: `Object` #### Type declaration @@ -10528,7 +10528,7 @@ ___ ### ShippingMethodTotals -Ƭ **ShippingMethodTotals**: `Object` + **ShippingMethodTotals**: `Object` #### Type declaration @@ -10595,7 +10595,7 @@ ___ ### ShippingMethodUpdate -Ƭ **ShippingMethodUpdate**: `Object` + **ShippingMethodUpdate**: `Object` #### Type declaration @@ -10654,13 +10654,13 @@ ___ ### ShippingOptionData -Ƭ **ShippingOptionData**: Record<`string`, `unknown`\> + **ShippingOptionData**: Record<`string`, `unknown`\> ___ ### ShippingOptionPricing -Ƭ **ShippingOptionPricing**: `Object` + **ShippingOptionPricing**: `Object` #### Type declaration @@ -10695,19 +10695,19 @@ ___ ### SocketConnectOpts -Ƭ **SocketConnectOpts**: [`TcpSocketConnectOpts`](../../internal/interfaces/admin_discounts.internal.TcpSocketConnectOpts.mdx) \| [`IpcSocketConnectOpts`](../../internal/interfaces/admin_discounts.internal.IpcSocketConnectOpts.mdx) + **SocketConnectOpts**: [`TcpSocketConnectOpts`](../../internal/interfaces/admin_discounts.internal.TcpSocketConnectOpts.mdx) \| [`IpcSocketConnectOpts`](../../internal/interfaces/admin_discounts.internal.IpcSocketConnectOpts.mdx) ___ ### SocketReadyState -Ƭ **SocketReadyState**: ``"opening"`` \| ``"open"`` \| ``"readOnly"`` \| ``"writeOnly"`` \| ``"closed"`` + **SocketReadyState**: ``"opening"`` \| ``"open"`` \| ``"readOnly"`` \| ``"writeOnly"`` \| ``"closed"`` ___ ### StagedJobServiceProps -Ƭ **StagedJobServiceProps**: `Object` + **StagedJobServiceProps**: `Object` #### Type declaration @@ -10734,7 +10734,7 @@ ___ ### StockLocationAddressDTO -Ƭ **StockLocationAddressDTO**: `Object` + **StockLocationAddressDTO**: `Object` #### Schema @@ -10853,7 +10853,7 @@ ___ ### StockLocationAddressInput -Ƭ **StockLocationAddressInput**: `Object` + **StockLocationAddressInput**: `Object` #### Schema @@ -10932,7 +10932,7 @@ ___ ### StockLocationDTO -Ƭ **StockLocationDTO**: `Object` + **StockLocationDTO**: `Object` #### Schema @@ -11011,7 +11011,7 @@ ___ ### StockLocationExpandedDTO -Ƭ **StockLocationExpandedDTO**: [`StockLocationDTO`](admin_discounts.internal.mdx#stocklocationdto) & { `sales_channels?`: `any`[] } + **StockLocationExpandedDTO**: [`StockLocationDTO`](admin_discounts.internal.mdx#stocklocationdto) & { `sales_channels?`: `any`[] } #### Schema @@ -11027,7 +11027,7 @@ ___ ### Subscriber -Ƭ **Subscriber**<`T`\>: (`data`: `T`, `eventName`: `string`) => `Promise`<`void`\> + **Subscriber**<`T`\>: (`data`: `T`, `eventName`: `string`) => `Promise`<`void`\> #### Type parameters @@ -11044,7 +11044,7 @@ ___ #### Type declaration -▸ (`data`, `eventName`): `Promise`<`void`\> +(`data`, `eventName`): `Promise`<`void`\> ##### Parameters @@ -11086,7 +11086,7 @@ ___ ### SubscriberContext -Ƭ **SubscriberContext**: `Object` + **SubscriberContext**: `Object` #### Type declaration @@ -11105,7 +11105,7 @@ ___ ### SubscriberDescriptor -Ƭ **SubscriberDescriptor**: `Object` + **SubscriberDescriptor**: `Object` #### Type declaration @@ -11132,7 +11132,7 @@ ___ ### SubtotalOptions -Ƭ **SubtotalOptions**: `Object` + **SubtotalOptions**: `Object` Options to use for subtotal calculations @@ -11153,7 +11153,7 @@ ___ ### TaxLinesMaps -Ƭ **TaxLinesMaps**: `Object` + **TaxLinesMaps**: `Object` #### Type declaration @@ -11180,7 +11180,7 @@ ___ ### TaxRateListByConfig -Ƭ **TaxRateListByConfig**: `Object` + **TaxRateListByConfig**: `Object` #### Type declaration @@ -11199,7 +11199,7 @@ ___ ### TaxServiceRate -Ƭ **TaxServiceRate**: `Object` + **TaxServiceRate**: `Object` The tax rate object as configured in Medusa. These may have an unspecified numerical rate as they may be used for lookup purposes in the tax provider @@ -11238,7 +11238,7 @@ ___ ### TaxedPricing -Ƭ **TaxedPricing**: `Object` + **TaxedPricing**: `Object` #### Type declaration @@ -11289,7 +11289,7 @@ ___ ### TotalsConfig -Ƭ **TotalsConfig**: `Object` + **TotalsConfig**: `Object` #### Type declaration @@ -11308,7 +11308,7 @@ ___ ### TotalsContext -Ƭ **TotalsContext**: `Object` + **TotalsContext**: `Object` #### Type declaration @@ -11343,7 +11343,7 @@ ___ ### TotalsServiceProps -Ƭ **TotalsServiceProps**: `Object` + **TotalsServiceProps**: `Object` #### Type declaration @@ -11394,11 +11394,11 @@ ___ ### TransformCallback -Ƭ **TransformCallback**: (`error?`: [`Error`](admin_discounts.internal.mdx#error) \| ``null``, `data?`: `any`) => `void` + **TransformCallback**: (`error?`: [`Error`](admin_discounts.internal.mdx#error) \| ``null``, `data?`: `any`) => `void` #### Type declaration -▸ (`error?`, `data?`): `void` +(`error?`, `data?`): `void` ##### Parameters @@ -11440,11 +11440,11 @@ ___ ### Transformer -Ƭ **Transformer**: (`item?`: [`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx), `quantity?`: `number`, `additional?`: [`OrdersReturnItem`](../../internal/classes/admin_discounts.internal.OrdersReturnItem.mdx)) => `Promise`<`DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\>\> \| `DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\> + **Transformer**: (`item?`: [`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx), `quantity?`: `number`, `additional?`: [`OrdersReturnItem`](../../internal/classes/admin_discounts.internal.OrdersReturnItem.mdx)) => `Promise`<`DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\>\> \| `DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\> #### Type declaration -▸ (`item?`, `quantity?`, `additional?`): `Promise`<`DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\>\> \| `DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\> +(`item?`, `quantity?`, `additional?`): `Promise`<`DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\>\> \| `DeepPartial`<[`LineItem`](../../internal/classes/admin_collections.internal.LineItem.mdx)\> ##### Parameters @@ -11494,13 +11494,13 @@ ___ ### TypedArray -Ƭ **TypedArray**: `Uint8Array` \| `Uint8ClampedArray` \| `Uint16Array` \| `Uint32Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `BigUint64Array` \| `BigInt64Array` \| `Float32Array` \| `Float64Array` + **TypedArray**: `Uint8Array` \| `Uint8ClampedArray` \| `Uint16Array` \| `Uint32Array` \| `Int8Array` \| `Int16Array` \| `Int32Array` \| `BigUint64Array` \| `BigInt64Array` \| `Float32Array` \| `Float64Array` ___ ### UpdateAnalyticsConfig -Ƭ **UpdateAnalyticsConfig**: `Object` + **UpdateAnalyticsConfig**: `Object` #### Type declaration @@ -11527,7 +11527,7 @@ ___ ### UpdateClaimInput -Ƭ **UpdateClaimInput**: `Object` + **UpdateClaimInput**: `Object` #### Type declaration @@ -11570,7 +11570,7 @@ ___ ### UpdateClaimItemImageInput -Ƭ **UpdateClaimItemImageInput**: `Object` + **UpdateClaimItemImageInput**: `Object` #### Type declaration @@ -11597,7 +11597,7 @@ ___ ### UpdateClaimItemInput -Ƭ **UpdateClaimItemInput**: `Object` + **UpdateClaimItemInput**: `Object` #### Type declaration @@ -11656,7 +11656,7 @@ ___ ### UpdateClaimItemTagInput -Ƭ **UpdateClaimItemTagInput**: `Object` + **UpdateClaimItemTagInput**: `Object` #### Type declaration @@ -11683,7 +11683,7 @@ ___ ### UpdateClaimShippingMethodInput -Ƭ **UpdateClaimShippingMethodInput**: `Object` + **UpdateClaimShippingMethodInput**: `Object` #### Type declaration @@ -11726,7 +11726,7 @@ ___ ### UpdateCurrencyInput -Ƭ **UpdateCurrencyInput**: `Object` + **UpdateCurrencyInput**: `Object` #### Type declaration @@ -11745,7 +11745,7 @@ ___ ### UpdateCustomerInput -Ƭ **UpdateCustomerInput**: `Object` + **UpdateCustomerInput**: `Object` #### Type declaration @@ -11828,7 +11828,7 @@ ___ ### UpdateDiscountInput -Ƭ **UpdateDiscountInput**: `Object` + **UpdateDiscountInput**: `Object` #### Type declaration @@ -11911,7 +11911,7 @@ ___ ### UpdateDiscountRuleInput -Ƭ **UpdateDiscountRuleInput**: `Object` + **UpdateDiscountRuleInput**: `Object` #### Type declaration @@ -11962,7 +11962,7 @@ ___ ### UpdateGiftCardInput -Ƭ **UpdateGiftCardInput**: `Object` + **UpdateGiftCardInput**: `Object` #### Type declaration @@ -12013,7 +12013,7 @@ ___ ### UpdateInventoryLevelInput -Ƭ **UpdateInventoryLevelInput**: `Object` + **UpdateInventoryLevelInput**: `Object` #### Type declaration @@ -12040,7 +12040,7 @@ ___ ### UpdateOauthInput -Ƭ **UpdateOauthInput**: `Object` + **UpdateOauthInput**: `Object` #### Type declaration @@ -12059,7 +12059,7 @@ ___ ### UpdateOrderInput -Ƭ **UpdateOrderInput**: `Object` + **UpdateOrderInput**: `Object` #### Type declaration @@ -12206,13 +12206,13 @@ ___ ### UpdateProductCategoryInput -Ƭ **UpdateProductCategoryInput**: [`ProductCategoryInput`](admin_discounts.internal.mdx#productcategoryinput) & { `name?`: `string` } + **UpdateProductCategoryInput**: [`ProductCategoryInput`](admin_discounts.internal.mdx#productcategoryinput) & { `name?`: `string` } ___ ### UpdateProductCollection -Ƭ **UpdateProductCollection**: `Object` + **UpdateProductCollection**: `Object` #### Type declaration @@ -12247,13 +12247,13 @@ ___ ### UpdateProductInput -Ƭ **UpdateProductInput**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`Partial`](admin_discounts.internal.mdx#partial)<[`CreateProductInput`](admin_discounts.internal.mdx#createproductinput)\>, ``"variants"``\> & { `variants?`: [`UpdateProductProductVariantDTO`](admin_discounts.internal.mdx#updateproductproductvariantdto)[] } + **UpdateProductInput**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`Partial`](admin_discounts.internal.mdx#partial)<[`CreateProductInput`](admin_discounts.internal.mdx#createproductinput)\>, ``"variants"``\> & { `variants?`: [`UpdateProductProductVariantDTO`](admin_discounts.internal.mdx#updateproductproductvariantdto)[] } ___ ### UpdateProductProductVariantDTO -Ƭ **UpdateProductProductVariantDTO**: `Object` + **UpdateProductProductVariantDTO**: `Object` #### Type declaration @@ -12424,7 +12424,7 @@ ___ ### UpdateProductVariantData -Ƭ **UpdateProductVariantData**: `Object` + **UpdateProductVariantData**: `Object` #### Type declaration @@ -12451,7 +12451,7 @@ ___ ### UpdateProductVariantInput -Ƭ **UpdateProductVariantInput**: `Object` + **UpdateProductVariantInput**: `Object` #### Type declaration @@ -12630,7 +12630,7 @@ ___ ### UpdateRegionInput -Ƭ **UpdateRegionInput**: `Object` + **UpdateRegionInput**: `Object` #### Type declaration @@ -12737,7 +12737,7 @@ ___ ### UpdateReservationItemInput -Ƭ **UpdateReservationItemInput**: `Object` + **UpdateReservationItemInput**: `Object` #### Type declaration @@ -12780,7 +12780,7 @@ ___ ### UpdateReturnInput -Ƭ **UpdateReturnInput**: `Object` + **UpdateReturnInput**: `Object` #### Type declaration @@ -12839,7 +12839,7 @@ ___ ### UpdateReturnReason -Ƭ **UpdateReturnReason**: `Object` + **UpdateReturnReason**: `Object` #### Type declaration @@ -12882,7 +12882,7 @@ ___ ### UpdateShippingOptionInput -Ƭ **UpdateShippingOptionInput**: `Object` + **UpdateShippingOptionInput**: `Object` #### Type declaration @@ -12989,7 +12989,7 @@ ___ ### UpdateShippingProfile -Ƭ **UpdateShippingProfile**: `Object` + **UpdateShippingProfile**: `Object` #### Type declaration @@ -13040,7 +13040,7 @@ ___ ### UpdateStockLocationInput -Ƭ **UpdateStockLocationInput**: `Object` + **UpdateStockLocationInput**: `Object` #### Schema @@ -13087,7 +13087,7 @@ ___ ### UpdateStoreInput -Ƭ **UpdateStoreInput**: `Object` + **UpdateStoreInput**: `Object` #### Type declaration @@ -13162,7 +13162,7 @@ ___ ### UpdateTaxRateInput -Ƭ **UpdateTaxRateInput**: `Object` + **UpdateTaxRateInput**: `Object` #### Type declaration @@ -13205,7 +13205,7 @@ ___ ### UpdateVariantPricesData -Ƭ **UpdateVariantPricesData**: `Object` + **UpdateVariantPricesData**: `Object` #### Type declaration @@ -13232,7 +13232,7 @@ ___ ### UpdateVariantRegionPriceData -Ƭ **UpdateVariantRegionPriceData**: `Object` + **UpdateVariantRegionPriceData**: `Object` #### Type declaration @@ -13283,7 +13283,7 @@ ___ ### UploadStreamDescriptorType -Ƭ **UploadStreamDescriptorType**: `Object` + **UploadStreamDescriptorType**: `Object` #### Index signature @@ -13322,19 +13322,19 @@ ___ ### UpsertTagsInput -Ƭ **UpsertTagsInput**: [`Partial`](admin_discounts.internal.mdx#partial)<[`ProductTag`](../../internal/classes/admin_collections.internal.ProductTag.mdx)\> & { `value`: `string` }[] + **UpsertTagsInput**: [`Partial`](admin_discounts.internal.mdx#partial)<[`ProductTag`](../../internal/classes/admin_collections.internal.ProductTag.mdx)\> & { `value`: `string` }[] ___ ### UpsertTypeInput -Ƭ **UpsertTypeInput**: [`Partial`](admin_discounts.internal.mdx#partial)<[`ProductType`](../../internal/classes/admin_collections.internal.ProductType.mdx)\> & { `value`: `string` } + **UpsertTypeInput**: [`Partial`](admin_discounts.internal.mdx#partial)<[`ProductType`](../../internal/classes/admin_collections.internal.ProductType.mdx)\> & { `value`: `string` } ___ ### UserServiceProps -Ƭ **UserServiceProps**: `Object` + **UserServiceProps**: `Object` #### Type declaration @@ -13385,7 +13385,7 @@ ___ ### WithImplicitCoercion -Ƭ **WithImplicitCoercion**<`T`\>: `T` \| { `valueOf`: Method valueOf } + **WithImplicitCoercion**<`T`\>: `T` \| { `valueOf`: Method valueOf } #### Type parameters @@ -13404,11 +13404,11 @@ ___ ### handler -Ƭ **handler**: (`req`: `Request`, `res`: `Response`) => `Promise`<`void`\> + **handler**: (`req`: `Request`, `res`: `Response`) => `Promise`<`void`\> #### Type declaration -▸ (`req`, `res`): `Promise`<`void`\> +(`req`, `res`): `Promise`<`void`\> ##### Parameters @@ -13450,11 +13450,11 @@ ___ ### middlewareHandlerType -Ƭ **middlewareHandlerType**: (`options`: Record<`string`, `unknown`\>) => `RequestHandler` + **middlewareHandlerType**: (`options`: Record<`string`, `unknown`\>) => `RequestHandler` #### Type declaration -▸ (`options`): `RequestHandler` +(`options`): `RequestHandler` ##### Parameters @@ -13479,7 +13479,7 @@ ___ ### middlewareType -Ƭ **middlewareType**: `Object` + **middlewareType**: `Object` #### Type declaration @@ -13506,169 +13506,169 @@ ___ ### AddressRepository -• `Const` **AddressRepository**: `Repository` + `Const` **AddressRepository**: `Repository` ___ ### AdminGetDiscountsParams\_base -• `Const` **AdminGetDiscountsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + `Const` **AdminGetDiscountsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) ___ ### AdminGetInventoryItemsParams\_base -• `Const` **AdminGetInventoryItemsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + `Const` **AdminGetInventoryItemsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) ___ ### AdminGetPriceListsPriceListProductsParams\_base -• `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) ___ ### AdminGetProductCategoriesParams\_base -• `Const` **AdminGetProductCategoriesParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + `Const` **AdminGetProductCategoriesParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) ___ ### AdminGetReservationsParams\_base -• `Const` **AdminGetReservationsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + `Const` **AdminGetReservationsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) ___ ### AdminGetSalesChannelsParams\_base -• `Const` **AdminGetSalesChannelsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + `Const` **AdminGetSalesChannelsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) ___ ### AdminGetStockLocationsParams\_base -• `Const` **AdminGetStockLocationsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + `Const` **AdminGetStockLocationsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) ___ ### AnalyticsConfigRepository -• `Const` **AnalyticsConfigRepository**: `Repository` + `Const` **AnalyticsConfigRepository**: `Repository` ___ ### BatchJobRepository -• `Const` **BatchJobRepository**: `Repository` + `Const` **BatchJobRepository**: `Repository` ___ ### Buffer -• **Buffer**: [`BufferConstructor`](../../internal/interfaces/admin_discounts.internal.BufferConstructor.mdx) + **Buffer**: [`BufferConstructor`](../../internal/interfaces/admin_discounts.internal.BufferConstructor.mdx) ___ ### CartRepository -• `Const` **CartRepository**: `Repository` & { `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations } + `Const` **CartRepository**: `Repository` & { `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations } ___ ### ClaimRepository -• `Const` **ClaimRepository**: `Repository` + `Const` **ClaimRepository**: `Repository` ___ ### CountryRepository -• `Const` **CountryRepository**: `Repository` + `Const` **CountryRepository**: `Repository` ___ ### CurrencyRepository -• `Const` **CurrencyRepository**: `Repository` + `Const` **CurrencyRepository**: `Repository` ___ ### CustomShippingOptionRepository -• `Const` **CustomShippingOptionRepository**: `Repository` + `Const` **CustomShippingOptionRepository**: `Repository` ___ ### CustomerGroupRepository -• `Const` **CustomerGroupRepository**: `Repository` & { `addCustomers`: Method addCustomers ; `findWithRelationsAndCount`: Method findWithRelationsAndCount ; `removeCustomers`: Method removeCustomers } + `Const` **CustomerGroupRepository**: `Repository` & { `addCustomers`: Method addCustomers ; `findWithRelationsAndCount`: Method findWithRelationsAndCount ; `removeCustomers`: Method removeCustomers } ___ ### CustomerRepository -• `Const` **CustomerRepository**: `Repository` & { `listAndCount`: Method listAndCount } + `Const` **CustomerRepository**: `Repository` & { `listAndCount`: Method listAndCount } ___ ### DiscountConditionRepository -• `Const` **DiscountConditionRepository**: `Repository` & { `addConditionResources`: Method addConditionResources ; `canApplyForCustomer`: Method canApplyForCustomer ; `findOneWithDiscount`: Method findOneWithDiscount ; `getJoinTableResourceIdentifiers`: Method getJoinTableResourceIdentifiers ; `isValidForProduct`: Method isValidForProduct ; `queryConditionTable`: Method queryConditionTable ; `removeConditionResources`: Method removeConditionResources } + `Const` **DiscountConditionRepository**: `Repository` & { `addConditionResources`: Method addConditionResources ; `canApplyForCustomer`: Method canApplyForCustomer ; `findOneWithDiscount`: Method findOneWithDiscount ; `getJoinTableResourceIdentifiers`: Method getJoinTableResourceIdentifiers ; `isValidForProduct`: Method isValidForProduct ; `queryConditionTable`: Method queryConditionTable ; `removeConditionResources`: Method removeConditionResources } ___ ### DraftOrderRepository -• `Const` **DraftOrderRepository**: `Repository` + `Const` **DraftOrderRepository**: `Repository` ___ ### FulfillmentProviderRepository -• `Const` **FulfillmentProviderRepository**: `Repository` + `Const` **FulfillmentProviderRepository**: `Repository` ___ ### FulfillmentRepository -• `Const` **FulfillmentRepository**: `Repository` + `Const` **FulfillmentRepository**: `Repository` ___ ### GetOrderEditsParams\_base -• `Const` **GetOrderEditsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + `Const` **GetOrderEditsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) ___ ### GetPublishableApiKeySalesChannelsParams\_base -• `Const` **GetPublishableApiKeySalesChannelsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + `Const` **GetPublishableApiKeySalesChannelsParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) ___ ### GetPublishableApiKeysParams\_base -• `Const` **GetPublishableApiKeysParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) + `Const` **GetPublishableApiKeysParams\_base**: [`internal`](../../internal/modules/admin_discounts.internal.internal.mdx) ___ ### GiftCardRepository -• `Const` **GiftCardRepository**: `Repository` & { `listGiftCardsAndCount`: Method listGiftCardsAndCount } + `Const` **GiftCardRepository**: `Repository` & { `listGiftCardsAndCount`: Method listGiftCardsAndCount } ___ ### GiftCardTransactionRepository -• `Const` **GiftCardTransactionRepository**: `Repository` + `Const` **GiftCardTransactionRepository**: `Repository` ___ ### HTTP\_METHODS -• `Const` **HTTP\_METHODS**: readonly [``"GET"``, ``"POST"``, ``"PUT"``, ``"PATCH"``, ``"DELETE"``, ``"OPTIONS"``, ``"HEAD"``] + `Const` **HTTP\_METHODS**: readonly [``"GET"``, ``"POST"``, ``"PUT"``, ``"PATCH"``, ``"DELETE"``, ``"OPTIONS"``, ``"HEAD"``] List of all the supported HTTP methods @@ -13676,161 +13676,161 @@ ___ ### IdempotencyKeyRepository -• `Const` **IdempotencyKeyRepository**: `Repository` + `Const` **IdempotencyKeyRepository**: `Repository` ___ ### ImageRepository -• `Const` **ImageRepository**: `Repository` & { `insertBulk`: Method insertBulk ; `upsertImages`: Method upsertImages } + `Const` **ImageRepository**: `Repository` & { `insertBulk`: Method insertBulk ; `upsertImages`: Method upsertImages } ___ ### LineItemAdjustmentRepository -• `Const` **LineItemAdjustmentRepository**: `Repository` + `Const` **LineItemAdjustmentRepository**: `Repository` ___ ### LineItemRepository -• `Const` **LineItemRepository**: `Repository` & { `findByReturn`: Method findByReturn } + `Const` **LineItemRepository**: `Repository` & { `findByReturn`: Method findByReturn } ___ ### LineItemTaxLineRepository -• `Const` **LineItemTaxLineRepository**: `Repository` & { `deleteForCart`: Method deleteForCart ; `upsertLines`: Method upsertLines } + `Const` **LineItemTaxLineRepository**: `Repository` & { `deleteForCart`: Method deleteForCart ; `upsertLines`: Method upsertLines } ___ ### MoneyAmountRepository -• `Const` **MoneyAmountRepository**: `Repository` & { `addPriceListPrices`: Method addPriceListPrices ; `createProductVariantMoneyAmounts`: Method createProductVariantMoneyAmounts ; `deletePriceListPrices`: Method deletePriceListPrices ; `deleteVariantPricesNotIn`: Method deleteVariantPricesNotIn ; `findCurrencyMoneyAmounts`: Method findCurrencyMoneyAmounts ; `findManyForVariantInPriceList`: Method findManyForVariantInPriceList ; `findManyForVariantInRegion`: Method findManyForVariantInRegion ; `findManyForVariantsInRegion`: Method findManyForVariantsInRegion ; `findRegionMoneyAmounts`: Method findRegionMoneyAmounts ; `findVariantPricesNotIn`: Method findVariantPricesNotIn ; `getPricesForVariantInRegion`: Method getPricesForVariantInRegion ; `insertBulk`: Method insertBulk ; `updatePriceListPrices`: Method updatePriceListPrices ; `upsertVariantCurrencyPrice`: Method upsertVariantCurrencyPrice } + `Const` **MoneyAmountRepository**: `Repository` & { `addPriceListPrices`: Method addPriceListPrices ; `createProductVariantMoneyAmounts`: Method createProductVariantMoneyAmounts ; `deletePriceListPrices`: Method deletePriceListPrices ; `deleteVariantPricesNotIn`: Method deleteVariantPricesNotIn ; `findCurrencyMoneyAmounts`: Method findCurrencyMoneyAmounts ; `findManyForVariantInPriceList`: Method findManyForVariantInPriceList ; `findManyForVariantInRegion`: Method findManyForVariantInRegion ; `findManyForVariantsInRegion`: Method findManyForVariantsInRegion ; `findRegionMoneyAmounts`: Method findRegionMoneyAmounts ; `findVariantPricesNotIn`: Method findVariantPricesNotIn ; `getPricesForVariantInRegion`: Method getPricesForVariantInRegion ; `insertBulk`: Method insertBulk ; `updatePriceListPrices`: Method updatePriceListPrices ; `upsertVariantCurrencyPrice`: Method upsertVariantCurrencyPrice } ___ ### NoteRepository -• `Const` **NoteRepository**: `Repository` + `Const` **NoteRepository**: `Repository` ___ ### NotificationProviderRepository -• `Const` **NotificationProviderRepository**: `Repository` + `Const` **NotificationProviderRepository**: `Repository` ___ ### NotificationRepository -• `Const` **NotificationRepository**: `Repository` + `Const` **NotificationRepository**: `Repository` ___ ### OauthRepository -• `Const` **OauthRepository**: `Repository` + `Const` **OauthRepository**: `Repository` ___ ### OrderEditRepository -• `Const` **OrderEditRepository**: `Repository` + `Const` **OrderEditRepository**: `Repository` ___ ### OrderItemChangeRepository -• `Const` **OrderItemChangeRepository**: `Repository` + `Const` **OrderItemChangeRepository**: `Repository` ___ ### OrderRepository -• `Const` **OrderRepository**: `Repository` & { `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations } + `Const` **OrderRepository**: `Repository` & { `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations } ___ ### PaymentCollectionRepository -• `Const` **PaymentCollectionRepository**: `Repository` & { `getPaymentCollectionIdByPaymentId`: Method getPaymentCollectionIdByPaymentId ; `getPaymentCollectionIdBySessionId`: Method getPaymentCollectionIdBySessionId } + `Const` **PaymentCollectionRepository**: `Repository` & { `getPaymentCollectionIdByPaymentId`: Method getPaymentCollectionIdByPaymentId ; `getPaymentCollectionIdBySessionId`: Method getPaymentCollectionIdBySessionId } ___ ### PaymentProviderRepository -• `Const` **PaymentProviderRepository**: `Repository` + `Const` **PaymentProviderRepository**: `Repository` ___ ### PaymentRepository -• `Const` **PaymentRepository**: `Repository` + `Const` **PaymentRepository**: `Repository` ___ ### PaymentSessionRepository -• `Const` **PaymentSessionRepository**: `Repository` + `Const` **PaymentSessionRepository**: `Repository` ___ ### PriceListRepository -• `Const` **PriceListRepository**: `Repository` & { `listAndCount`: Method listAndCount ; `listPriceListsVariantIdsMap`: Method listPriceListsVariantIdsMap } + `Const` **PriceListRepository**: `Repository` & { `listAndCount`: Method listAndCount ; `listPriceListsVariantIdsMap`: Method listPriceListsVariantIdsMap } ___ ### ProductCategoryRepository -• `Const` **ProductCategoryRepository**: `TreeRepository` & { `addProducts`: Method addProducts ; `findOneWithDescendants`: Method findOneWithDescendants ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `removeProducts`: Method removeProducts } + `Const` **ProductCategoryRepository**: `TreeRepository` & { `addProducts`: Method addProducts ; `findOneWithDescendants`: Method findOneWithDescendants ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `removeProducts`: Method removeProducts } ___ ### ProductCollectionRepository -• `Const` **ProductCollectionRepository**: `Repository` & { `findAndCountByDiscountConditionId`: Method findAndCountByDiscountConditionId } + `Const` **ProductCollectionRepository**: `Repository` & { `findAndCountByDiscountConditionId`: Method findAndCountByDiscountConditionId } ___ ### ProductOptionRepository -• `Const` **ProductOptionRepository**: `Repository` + `Const` **ProductOptionRepository**: `Repository` ___ ### ProductRepository -• `Const` **ProductRepository**: `Repository` & { `_applyCategoriesQuery`: Method \_applyCategoriesQuery ; `_findWithRelations`: Method \_findWithRelations ; `bulkAddToCollection`: Method bulkAddToCollection ; `bulkRemoveFromCollection`: Method bulkRemoveFromCollection ; `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations ; `findWithRelationsAndCount`: Method findWithRelationsAndCount ; `getCategoryIdsFromInput`: Method getCategoryIdsFromInput ; `getCategoryIdsRecursively`: Method getCategoryIdsRecursively ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `isProductInSalesChannels`: Method isProductInSalesChannels ; `queryProducts`: Method queryProducts ; `queryProductsWithIds`: Method queryProductsWithIds } + `Const` **ProductRepository**: `Repository` & { `_applyCategoriesQuery`: Method \_applyCategoriesQuery ; `_findWithRelations`: Method \_findWithRelations ; `bulkAddToCollection`: Method bulkAddToCollection ; `bulkRemoveFromCollection`: Method bulkRemoveFromCollection ; `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations ; `findWithRelationsAndCount`: Method findWithRelationsAndCount ; `getCategoryIdsFromInput`: Method getCategoryIdsFromInput ; `getCategoryIdsRecursively`: Method getCategoryIdsRecursively ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `isProductInSalesChannels`: Method isProductInSalesChannels ; `queryProducts`: Method queryProducts ; `queryProductsWithIds`: Method queryProductsWithIds } ___ ### ProductTagRepository -• `Const` **ProductTagRepository**: `Repository` & { `findAndCountByDiscountConditionId`: Method findAndCountByDiscountConditionId ; `insertBulk`: Method insertBulk ; `listTagsByUsage`: Method listTagsByUsage ; `upsertTags`: Method upsertTags } + `Const` **ProductTagRepository**: `Repository` & { `findAndCountByDiscountConditionId`: Method findAndCountByDiscountConditionId ; `insertBulk`: Method insertBulk ; `listTagsByUsage`: Method listTagsByUsage ; `upsertTags`: Method upsertTags } ___ ### ProductTypeRepository -• `Const` **ProductTypeRepository**: `Repository` & { `findAndCountByDiscountConditionId`: Method findAndCountByDiscountConditionId ; `upsertType`: Method upsertType } + `Const` **ProductTypeRepository**: `Repository` & { `findAndCountByDiscountConditionId`: Method findAndCountByDiscountConditionId ; `upsertType`: Method upsertType } ___ ### ProductVariantRepository -• `Const` **ProductVariantRepository**: `Repository` + `Const` **ProductVariantRepository**: `Repository` ___ ### ReadableByteStreamController -• **ReadableByteStreamController**: `Object` + **ReadableByteStreamController**: `Object` #### Call signature -• **new ReadableByteStreamController**(): [`ReadableByteStreamController`](admin_discounts.internal.mdx#readablebytestreamcontroller) +**new ReadableByteStreamController**(): [`ReadableByteStreamController`](admin_discounts.internal.mdx#readablebytestreamcontroller) ##### Returns @@ -13864,11 +13864,11 @@ ___ ### ReadableStream -• **ReadableStream**: `Object` + **ReadableStream**: `Object` #### Call signature -• **new ReadableStream**(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_discounts.internal.mdx#readablestream)<`Uint8Array`\> +**new ReadableStream**(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_discounts.internal.mdx#readablestream)<`Uint8Array`\> ##### Parameters @@ -13915,7 +13915,7 @@ ___ } ]} /> -• **new ReadableStream**<`R`\>(`underlyingSource?`, `strategy?`): [`ReadableStream`](admin_discounts.internal.mdx#readablestream)<`R`\> +**new ReadableStream**<`R`\>(`underlyingSource?`, `strategy?`): [`ReadableStream`](admin_discounts.internal.mdx#readablestream)<`R`\> +**new ReadableStreamDefaultController**(): [`ReadableStreamDefaultController`](admin_discounts.internal.mdx#readablestreamdefaultcontroller)<`any`\> ##### Returns @@ -14028,11 +14028,11 @@ ___ ### ReadableStreamDefaultReader -• **ReadableStreamDefaultReader**: `Object` + **ReadableStreamDefaultReader**: `Object` #### Call signature -• **new ReadableStreamDefaultReader**<`R`\>(`stream`): [`ReadableStreamDefaultReader`](admin_discounts.internal.mdx#readablestreamdefaultreader)<`R`\> +**new ReadableStreamDefaultReader**<`R`\>(`stream`): [`ReadableStreamDefaultReader`](admin_discounts.internal.mdx#readablestreamdefaultreader)<`R`\> (`underlyingSink?`, `strategy?`): [`WritableStream`](admin_discounts.internal.mdx#writablestream)<`W`\> +**new WritableStream**<`W`\>(`underlyingSink?`, `strategy?`): [`WritableStream`](admin_discounts.internal.mdx#writablestream)<`W`\> (`stream`): [`WritableStreamDefaultWriter`](admin_discounts.internal.mdx#writablestreamdefaultwriter)<`W`\> +**new WritableStreamDefaultWriter**<`W`\>(`stream`): [`WritableStreamDefaultWriter`](admin_discounts.internal.mdx#writablestreamdefaultwriter)<`W`\> -▸ **Object**(`value`): `any` +**Object**(`value`): `any` Provides functionality common to all JavaScript objects. diff --git a/www/apps/docs/content/references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx b/www/apps/docs/content/references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx index 2c2554f65f..1b6ccf2919 100644 --- a/www/apps/docs/content/references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_draft_orders/classes/admin_draft_orders.AdminDraftOrdersResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addLineItem -▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> +**addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> #### Parameters @@ -75,7 +75,7 @@ ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> #### Parameters @@ -130,7 +130,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -185,7 +185,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftorderslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftorderslistres)\> #### Parameters @@ -240,7 +240,7 @@ ___ ### markPaid -▸ **markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpostdraftordersdraftorderregisterpaymentres)\> +**markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpostdraftordersdraftorderregisterpaymentres)\> #### Parameters @@ -295,7 +295,7 @@ ___ ### removeLineItem -▸ **removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> +**removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> #### Parameters @@ -358,7 +358,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> #### Parameters @@ -413,7 +413,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> #### Parameters @@ -476,7 +476,7 @@ ___ ### updateLineItem -▸ **updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> +**updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminDraftOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admindraftordersres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx b/www/apps/docs/content/references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx index 658daf26c2..dadbdeb20f 100644 --- a/www/apps/docs/content/references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_gift_cards/classes/admin_gift_cards.AdminGiftCardsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\> #### Parameters @@ -67,7 +67,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -122,7 +122,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardslistres)\> #### Parameters @@ -177,7 +177,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\> #### Parameters @@ -232,7 +232,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingiftcardsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx b/www/apps/docs/content/references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx index 59cbe9ba20..b48619161b 100644 --- a/www/apps/docs/content/references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_inventory_item/classes/admin_inventory_item.AdminInventoryItemsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### create -▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> +**create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> Create an Inventory Item This feature is under development and may change in the future. @@ -79,7 +79,7 @@ ___ ### createLocationLevel -▸ **createLocationLevel**(`inventoryItemId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> +**createLocationLevel**(`inventoryItemId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> Create stock for an Inventory Item at a Stock Location This feature is under development and may change in the future. @@ -154,7 +154,7 @@ ___ ### delete -▸ **delete**(`inventoryItemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`inventoryItemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> Delete an Inventory Item This feature is under development and may change in the future. @@ -213,7 +213,7 @@ ___ ### deleteLocationLevel -▸ **deleteLocationLevel**(`inventoryItemId`, `locationId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> +**deleteLocationLevel**(`inventoryItemId`, `locationId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> Removes an Inventory Item from a Stock Location. This erases trace of any quantity currently at the location. This feature is under development and may change in the future. @@ -288,7 +288,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsListWithVariantsAndLocationLevelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemslistwithvariantsandlocationlevelsres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsListWithVariantsAndLocationLevelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemslistwithvariantsandlocationlevelsres)\> Retrieve a list of Inventory Items This feature is under development and may change in the future. @@ -347,7 +347,7 @@ ___ ### listLocationLevels -▸ **listLocationLevels**(`inventoryItemId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsLocationLevelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemslocationlevelsres)\> +**listLocationLevels**(`inventoryItemId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsLocationLevelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemslocationlevelsres)\> Retrieve a list of Inventory Levels related to an Inventory Item across Stock Locations This feature is under development and may change in the future. @@ -414,7 +414,7 @@ ___ ### retrieve -▸ **retrieve**(`inventoryItemId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> +**retrieve**(`inventoryItemId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> Retrieve an Inventory Item This feature is under development and may change in the future. @@ -481,7 +481,7 @@ ___ ### update -▸ **update**(`inventoryItemId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> +**update**(`inventoryItemId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> Update an Inventory Item This feature is under development and may change in the future. @@ -556,7 +556,7 @@ ___ ### updateLocationLevel -▸ **updateLocationLevel**(`inventoryItemId`, `locationId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> +**updateLocationLevel**(`inventoryItemId`, `locationId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminInventoryItemsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admininventoryitemsres)\> Update an Inventory Item's stock level at a Stock Location This feature is under development and may change in the future. diff --git a/www/apps/docs/content/references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource.mdx b/www/apps/docs/content/references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource.mdx index 5ae4620642..8e79c7a6a0 100644 --- a/www/apps/docs/content/references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_invites/classes/admin_invites.AdminInvitesResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### accept -▸ **accept**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) +**accept**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) #### Parameters @@ -54,7 +54,7 @@ ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) #### Parameters @@ -96,7 +96,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -147,7 +147,7 @@ ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminListInvitesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminlistinvitesres)\> +**list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminListInvitesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminlistinvitesres)\> #### Parameters @@ -190,7 +190,7 @@ ___ ### resend -▸ **resend**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) +**resend**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_invites/modules/admin_invites.internal.mdx b/www/apps/docs/content/references/js-client/admin_invites/modules/admin_invites.internal.mdx index 3849a6538f..253f2c6d8e 100644 --- a/www/apps/docs/content/references/js-client/admin_invites/modules/admin_invites.internal.mdx +++ b/www/apps/docs/content/references/js-client/admin_invites/modules/admin_invites.internal.mdx @@ -10,10 +10,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AdminPostInvitesPayload -Ƭ **AdminPostInvitesPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminPostInvitesReq`](../../internal/classes/admin_discounts.internal.internal.AdminPostInvitesReq.mdx), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](admin_invites.internal.mdx#inviteuserrolesenum) } + **AdminPostInvitesPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminPostInvitesReq`](../../internal/classes/admin_discounts.internal.internal.AdminPostInvitesReq.mdx), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](admin_invites.internal.mdx#inviteuserrolesenum) } ___ ### InviteUserRolesEnum -Ƭ **InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\` + **InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\` diff --git a/www/apps/docs/content/references/js-client/admin_notes/classes/admin_notes.AdminNotesResource.mdx b/www/apps/docs/content/references/js-client/admin_notes/classes/admin_notes.AdminNotesResource.mdx index 66a73a4379..391842b96e 100644 --- a/www/apps/docs/content/references/js-client/admin_notes/classes/admin_notes.AdminNotesResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_notes/classes/admin_notes.AdminNotesResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\> #### Parameters @@ -63,7 +63,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -114,7 +114,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnoteslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnoteslistres)\> #### Parameters @@ -165,7 +165,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\> #### Parameters @@ -216,7 +216,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotesres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx b/www/apps/docs/content/references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx index 9da51d9a67..893fdca601 100644 --- a/www/apps/docs/content/references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_notifications/classes/admin_notifications.AdminNotificationsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotificationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotificationslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotificationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotificationslistres)\> #### Parameters @@ -63,7 +63,7 @@ ___ ### resend -▸ **resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotificationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotificationsres)\> +**resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminNotificationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminnotificationsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx b/www/apps/docs/content/references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx index b6454a9056..cd32aa234c 100644 --- a/www/apps/docs/content/references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_order_edits/classes/admin_order_edits.AdminOrderEditsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addLineItem -▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> +**addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> #### Parameters @@ -71,7 +71,7 @@ ___ ### cancel -▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> +**cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> #### Parameters @@ -122,7 +122,7 @@ ___ ### confirm -▸ **confirm**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> +**confirm**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> #### Parameters @@ -173,7 +173,7 @@ ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> #### Parameters @@ -224,7 +224,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -275,7 +275,7 @@ ___ ### deleteItemChange -▸ **deleteItemChange**(`orderEditId`, `itemChangeId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminorderedititemchangedeleteres)\> +**deleteItemChange**(`orderEditId`, `itemChangeId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditItemChangeDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminorderedititemchangedeleteres)\> #### Parameters @@ -334,7 +334,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditslistres)\> #### Parameters @@ -385,7 +385,7 @@ ___ ### removeLineItem -▸ **removeLineItem**(`orderEditId`, `itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> +**removeLineItem**(`orderEditId`, `itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> #### Parameters @@ -444,7 +444,7 @@ ___ ### requestConfirmation -▸ **requestConfirmation**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> +**requestConfirmation**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> #### Parameters @@ -495,7 +495,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> +**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> #### Parameters @@ -554,7 +554,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> #### Parameters @@ -613,7 +613,7 @@ ___ ### updateLineItem -▸ **updateLineItem**(`orderEditId`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> +**updateLineItem**(`orderEditId`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordereditsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource.mdx b/www/apps/docs/content/references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource.mdx index 730f62de3f..b635e739cb 100644 --- a/www/apps/docs/content/references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_orders/classes/admin_orders.AdminOrdersResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addShippingMethod -▸ **addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -71,7 +71,7 @@ ___ ### archive -▸ **archive**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**archive**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -122,7 +122,7 @@ ___ ### cancel -▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -173,7 +173,7 @@ ___ ### cancelClaim -▸ **cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -232,7 +232,7 @@ ___ ### cancelClaimFulfillment -▸ **cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -299,7 +299,7 @@ ___ ### cancelFulfillment -▸ **cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -358,7 +358,7 @@ ___ ### cancelSwap -▸ **cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -417,7 +417,7 @@ ___ ### cancelSwapFulfillment -▸ **cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -484,7 +484,7 @@ ___ ### capturePayment -▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -535,7 +535,7 @@ ___ ### complete -▸ **complete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**complete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -586,7 +586,7 @@ ___ ### createClaim -▸ **createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -645,7 +645,7 @@ ___ ### createClaimShipment -▸ **createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -712,7 +712,7 @@ ___ ### createFulfillment -▸ **createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -771,7 +771,7 @@ ___ ### createShipment -▸ **createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -830,7 +830,7 @@ ___ ### createSwap -▸ **createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -889,7 +889,7 @@ ___ ### createSwapShipment -▸ **createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -956,7 +956,7 @@ ___ ### fulfillClaim -▸ **fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -1023,7 +1023,7 @@ ___ ### fulfillSwap -▸ **fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -1090,7 +1090,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminorderslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminorderslistres)\> #### Parameters @@ -1141,7 +1141,7 @@ ___ ### processSwapPayment -▸ **processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -1200,7 +1200,7 @@ ___ ### refundPayment -▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -1259,7 +1259,7 @@ ___ ### requestReturn -▸ **requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -1318,7 +1318,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -1377,7 +1377,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters @@ -1436,7 +1436,7 @@ ___ ### updateClaim -▸ **updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> +**updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminordersres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx b/www/apps/docs/content/references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx index ef0e32138d..bbb16e9491 100644 --- a/www/apps/docs/content/references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_payment_collections/classes/admin_payment_collections.AdminPaymentCollectionsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectiondeleteres)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectiondeleteres)\> #### Parameters @@ -63,7 +63,7 @@ ___ ### markAsAuthorized -▸ **markAsAuthorized**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\> +**markAsAuthorized**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\> #### Parameters @@ -114,7 +114,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\> +**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\> #### Parameters @@ -173,7 +173,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentcollectionsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource.mdx b/www/apps/docs/content/references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource.mdx index f9c80c7695..95c33c6f2d 100644 --- a/www/apps/docs/content/references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_payments/classes/admin_payments.AdminPaymentsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### capturePayment -▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentres)\> +**capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentres)\> #### Parameters @@ -63,7 +63,7 @@ ___ ### refundPayment -▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRefundRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminrefundres)\> +**refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRefundRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminrefundres)\> #### Parameters @@ -122,7 +122,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentres)\> +**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx b/www/apps/docs/content/references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx index 16ad1eece3..dc3a4fbf85 100644 --- a/www/apps/docs/content/references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_price_lists/classes/admin_price_lists.AdminPriceListResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addPrices -▸ **addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> +**addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> #### Parameters @@ -71,7 +71,7 @@ ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> #### Parameters @@ -122,7 +122,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -173,7 +173,7 @@ ___ ### deletePrices -▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> +**deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> #### Parameters @@ -232,7 +232,7 @@ ___ ### deleteProductPrices -▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> +**deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> #### Parameters @@ -291,7 +291,7 @@ ___ ### deleteProductsPrices -▸ **deleteProductsPrices**(`priceListId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> +**deleteProductsPrices**(`priceListId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> #### Parameters @@ -350,7 +350,7 @@ ___ ### deleteVariantPrices -▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> +**deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListDeleteBatchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres)\> #### Parameters @@ -409,7 +409,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistslistres)\> #### Parameters @@ -460,7 +460,7 @@ ___ ### listProducts -▸ **listProducts**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`any`\> +**listProducts**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`any`\> #### Parameters @@ -519,7 +519,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> #### Parameters @@ -570,7 +570,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPriceListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpricelistres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx b/www/apps/docs/content/references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx index 1ccf7fd245..cf3031f32a 100644 --- a/www/apps/docs/content/references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_product_categories/classes/admin_product_categories.AdminProductCategoriesResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addProducts -▸ **addProducts**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> +**addProducts**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> Add products to a product category This feature is under development and may change in the future. @@ -79,7 +79,7 @@ ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> #### Parameters @@ -130,7 +130,7 @@ ___ ### delete -▸ **delete**(`productCategoryId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`productCategoryId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> Delete a product category This feature is under development and may change in the future. @@ -189,7 +189,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategorieslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategorieslistres)\> Retrieve a list of product categories This feature is under development and may change in the future. @@ -248,7 +248,7 @@ ___ ### removeProducts -▸ **removeProducts**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> +**removeProducts**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> Remove products from a product category This feature is under development and may change in the future. @@ -315,7 +315,7 @@ ___ ### retrieve -▸ **retrieve**(`productCategoryId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> +**retrieve**(`productCategoryId`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> retrieve a product category This feature is under development and may change in the future. @@ -382,7 +382,7 @@ ___ ### update -▸ **update**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> +**update**(`productCategoryId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductcategoriescategoryres)\> update a product category This feature is under development and may change in the future. diff --git a/www/apps/docs/content/references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx b/www/apps/docs/content/references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx index 7297b30b59..b7072a1c89 100644 --- a/www/apps/docs/content/references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_product_tags/classes/admin_product_tags.AdminProductTagsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### list -▸ **list**(`query?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductTagsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproducttagslistres)\> +**list**(`query?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductTagsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproducttagslistres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx b/www/apps/docs/content/references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx index 28e558641b..ed74e18128 100644 --- a/www/apps/docs/content/references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_product_types/classes/admin_product_types.AdminProductTypesResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductTypesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproducttypeslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductTypesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproducttypeslistres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_products/classes/admin_products.AdminProductsResource.mdx b/www/apps/docs/content/references/js-client/admin_products/classes/admin_products.AdminProductsResource.mdx index 99753c332c..524e0bcd23 100644 --- a/www/apps/docs/content/references/js-client/admin_products/classes/admin_products.AdminProductsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_products/classes/admin_products.AdminProductsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addOption -▸ **addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> +**addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> #### Parameters @@ -71,7 +71,7 @@ ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> #### Parameters @@ -122,7 +122,7 @@ ___ ### createVariant -▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> +**createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> #### Parameters @@ -181,7 +181,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeleteres)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeleteres)\> #### Parameters @@ -232,7 +232,7 @@ ___ ### deleteOption -▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteOptionRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeleteoptionres)\> +**deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteOptionRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeleteoptionres)\> #### Parameters @@ -291,7 +291,7 @@ ___ ### deleteVariant -▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteVariantRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeletevariantres)\> +**deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsDeleteVariantRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsdeletevariantres)\> #### Parameters @@ -350,7 +350,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslistres)\> #### Parameters @@ -401,7 +401,7 @@ ___ ### listTags -▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListTagsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslisttagsres)\> +**listTags**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListTagsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslisttagsres)\> #### Parameters @@ -444,7 +444,7 @@ ___ ### listTypes -▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListTypesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslisttypesres)\> +**listTypes**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsListTypesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductslisttypesres)\> #### Parameters @@ -491,7 +491,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> #### Parameters @@ -542,7 +542,7 @@ ___ ### setMetadata -▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> +**setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> #### Parameters @@ -601,7 +601,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> #### Parameters @@ -660,7 +660,7 @@ ___ ### updateOption -▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> +**updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> #### Parameters @@ -727,7 +727,7 @@ ___ ### updateVariant -▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> +**updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminproductsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx b/www/apps/docs/content/references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx index 76ffd3be1b..8b3fff974e 100644 --- a/www/apps/docs/content/references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_publishable_api_keys/classes/admin_publishable_api_keys.AdminPublishableApiKeyResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addSalesChannelsBatch -▸ **addSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> +**addSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> #### Parameters @@ -71,7 +71,7 @@ ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> #### Parameters @@ -122,7 +122,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -173,7 +173,7 @@ ___ ### deleteSalesChannelsBatch -▸ **deleteSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> +**deleteSalesChannelsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> #### Parameters @@ -232,7 +232,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeyslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeyslistres)\> #### Parameters @@ -283,7 +283,7 @@ ___ ### listSalesChannels -▸ **listSalesChannels**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelslistres)\> +**listSalesChannels**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelslistres)\> #### Parameters @@ -342,7 +342,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> +**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> #### Parameters @@ -401,7 +401,7 @@ ___ ### revoke -▸ **revoke**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> +**revoke**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPublishableApiKeysRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpublishableapikeysres)\> #### Parameters @@ -452,7 +452,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): `Promise`<`any`\> +**update**(`id`, `payload`, `customHeaders?`): `Promise`<`any`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource.mdx b/www/apps/docs/content/references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource.mdx index d1c16bbe6c..6a8f285db5 100644 --- a/www/apps/docs/content/references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_regions/classes/admin_regions.AdminRegionsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addCountry -▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> +**addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> #### Parameters @@ -75,7 +75,7 @@ ___ ### addFulfillmentProvider -▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> +**addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> #### Parameters @@ -138,7 +138,7 @@ ___ ### addPaymentProvider -▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> +**addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> #### Parameters @@ -201,7 +201,7 @@ ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> #### Parameters @@ -256,7 +256,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -311,7 +311,7 @@ ___ ### deleteCountry -▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> +**deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> #### Parameters @@ -374,7 +374,7 @@ ___ ### deleteFulfillmentProvider -▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> +**deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> #### Parameters @@ -437,7 +437,7 @@ ___ ### deletePaymentProvider -▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> +**deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> #### Parameters @@ -500,7 +500,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminregionslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminregionslistres)\> #### Parameters @@ -555,7 +555,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> #### Parameters @@ -610,7 +610,7 @@ ___ ### retrieveFulfillmentOptions -▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminGetRegionsRegionFulfillmentOptionsRes.mdx)\> +**retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminGetRegionsRegionFulfillmentOptionsRes.mdx)\> #### Parameters @@ -665,7 +665,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminRegionsRes`](../../internal/classes/admin_discounts.internal.internal.AdminRegionsRes.mdx)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx b/www/apps/docs/content/references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx index 7bf74b09c0..4f3ce92f94 100644 --- a/www/apps/docs/content/references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_reservations/classes/admin_reservations.AdminReservationsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\> create a reservation @@ -71,7 +71,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> remove a reservation @@ -130,7 +130,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationslistres)\> List reservations This feature is under development and may change in the future. @@ -189,7 +189,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\> Get a reservation This feature is under development and may change in the future. @@ -248,7 +248,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReservationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreservationsres)\> update a reservation diff --git a/www/apps/docs/content/references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx b/www/apps/docs/content/references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx index a6e2bf5ee1..58244f22bb 100644 --- a/www/apps/docs/content/references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_return_reasons/classes/admin_return_reasons.AdminReturnReasonsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\> #### Parameters @@ -67,7 +67,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -122,7 +122,7 @@ ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonslistres)\> +**list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonslistres)\> #### Parameters @@ -169,7 +169,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\> #### Parameters @@ -224,7 +224,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnreasonsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource.mdx b/www/apps/docs/content/references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource.mdx index 7604f1e5a0..799968606e 100644 --- a/www/apps/docs/content/references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_returns/classes/admin_returns.AdminReturnsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### cancel -▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsCancelRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnscancelres)\> +**cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsCancelRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnscancelres)\> #### Parameters @@ -67,7 +67,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnslistres)\> #### Parameters @@ -122,7 +122,7 @@ ___ ### receive -▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnsres)\> +**receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminReturnsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminreturnsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx b/www/apps/docs/content/references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx index 44cdb21b60..c9b4ed0356 100644 --- a/www/apps/docs/content/references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_sales_channels/classes/admin_sales_channels.AdminSalesChannelsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addLocation -▸ **addLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> +**addLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> Add a location to a sales channel This feature is under development and may change in the future. @@ -79,7 +79,7 @@ ___ ### addProducts -▸ **addProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> +**addProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> Add products to a sales channel This feature is under development and may change in the future. @@ -146,7 +146,7 @@ ___ ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> #### Parameters @@ -197,7 +197,7 @@ ___ ### delete -▸ **delete**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> Delete a sales channel This feature is under development and may change in the future. @@ -256,7 +256,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelslistres)\> Retrieve a list of sales channels This feature is under development and may change in the future. @@ -315,7 +315,7 @@ ___ ### removeLocation -▸ **removeLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> +**removeLocation**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> remove a location from a sales channel This feature is under development and may change in the future. @@ -382,7 +382,7 @@ ___ ### removeProducts -▸ **removeProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> +**removeProducts**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> Remove products from a sales channel This feature is under development and may change in the future. @@ -449,7 +449,7 @@ ___ ### retrieve -▸ **retrieve**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> +**retrieve**(`salesChannelId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> retrieve a sales channel This feature is under development and may change in the future. @@ -508,7 +508,7 @@ ___ ### update -▸ **update**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> +**update**(`salesChannelId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSalesChannelsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminsaleschannelsres)\> update a sales channel This feature is under development and may change in the future. diff --git a/www/apps/docs/content/references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx b/www/apps/docs/content/references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx index 6de3f8e96c..a30aa523e1 100644 --- a/www/apps/docs/content/references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_shipping_options/classes/admin_shipping_options.AdminShippingOptionsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\> #### Parameters @@ -67,7 +67,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -122,7 +122,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionslistres)\> #### Parameters @@ -177,7 +177,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\> #### Parameters @@ -232,7 +232,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingOptionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingoptionsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx b/www/apps/docs/content/references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx index c2ed78d616..4daef7fe38 100644 --- a/www/apps/docs/content/references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_shipping_profiles/classes/admin_shipping_profiles.AdminShippingProfilesResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\> #### Parameters @@ -63,7 +63,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -114,7 +114,7 @@ ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofileslistres)\> +**list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofileslistres)\> #### Parameters @@ -157,7 +157,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\> #### Parameters @@ -208,7 +208,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminShippingProfilesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminshippingprofilesres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx b/www/apps/docs/content/references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx index c5120dd03c..94cfd2fa85 100644 --- a/www/apps/docs/content/references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_stock_locations/classes/admin_stock_locations.AdminStockLocationsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\> Create a Stock Location This feature is under development and may change in the future. @@ -71,7 +71,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#deleteresponse)\> Delete a Stock Location This feature is under development and may change in the future. @@ -130,7 +130,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationslistres)\> Retrieve a list of Stock Locations This feature is under development and may change in the future. @@ -189,7 +189,7 @@ ___ ### retrieve -▸ **retrieve**(`itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\> +**retrieve**(`itemId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\> Retrieve a Stock Location This feature is under development and may change in the future. @@ -248,7 +248,7 @@ ___ ### update -▸ **update**(`stockLocationId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\> +**update**(`stockLocationId`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStockLocationsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstocklocationsres)\> Update a Stock Location This feature is under development and may change in the future. diff --git a/www/apps/docs/content/references/js-client/admin_store/classes/admin_store.AdminStoresResource.mdx b/www/apps/docs/content/references/js-client/admin_store/classes/admin_store.AdminStoresResource.mdx index 19b979351a..6f8bfbbf05 100644 --- a/www/apps/docs/content/references/js-client/admin_store/classes/admin_store.AdminStoresResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_store/classes/admin_store.AdminStoresResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addCurrency -▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\> +**addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\> #### Parameters @@ -67,7 +67,7 @@ ___ ### deleteCurrency -▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\> +**deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\> #### Parameters @@ -122,7 +122,7 @@ ___ ### listPaymentProviders -▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentProvidersList`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentproviderslist)\> +**listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminPaymentProvidersList`](../../internal/modules/admin_discounts.internal.internal.mdx#adminpaymentproviderslist)\> #### Parameters @@ -169,7 +169,7 @@ ___ ### listTaxProviders -▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxProvidersList`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxproviderslist)\> +**listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxProvidersList`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxproviderslist)\> #### Parameters @@ -216,7 +216,7 @@ ___ ### retrieve -▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminExtendedStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminextendedstoresres)\> +**retrieve**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminExtendedStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminextendedstoresres)\> #### Parameters @@ -263,7 +263,7 @@ ___ ### update -▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\> +**update**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminStoresRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminstoresres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx b/www/apps/docs/content/references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx index afa7cb5f85..567a52f395 100644 --- a/www/apps/docs/content/references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_swaps/classes/admin_swaps.AdminSwapsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSwapsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminswapslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSwapsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminswapslistres)\> #### Parameters @@ -63,7 +63,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminswapsres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminswapsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx b/www/apps/docs/content/references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx index b0fcb7a292..1ca8190f53 100644 --- a/www/apps/docs/content/references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_tax_rates/classes/admin_tax_rates.AdminTaxRatesResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addProductTypes -▸ **addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> +**addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> #### Parameters @@ -79,7 +79,7 @@ ___ ### addProducts -▸ **addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> +**addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> #### Parameters @@ -146,7 +146,7 @@ ___ ### addShippingOptions -▸ **addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> +**addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> #### Parameters @@ -213,7 +213,7 @@ ___ ### create -▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> +**create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> #### Parameters @@ -272,7 +272,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -323,7 +323,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxrateslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxrateslistres)\> #### Parameters @@ -374,7 +374,7 @@ ___ ### removeProductTypes -▸ **removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> +**removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> #### Parameters @@ -441,7 +441,7 @@ ___ ### removeProducts -▸ **removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> +**removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> #### Parameters @@ -508,7 +508,7 @@ ___ ### removeShippingOptions -▸ **removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> +**removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> #### Parameters @@ -575,7 +575,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> +**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> #### Parameters @@ -634,7 +634,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> +**update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminTaxRatesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admintaxratesres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx b/www/apps/docs/content/references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx index e0ffdacd20..fdd99a88f9 100644 --- a/www/apps/docs/content/references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_uploads/classes/admin_uploads.AdminUploadsResource.mdx @@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### \_createPayload -▸ `Private` **_createPayload**(`file`): `FormData` +`Private` **_createPayload**(`file`): `FormData` #### Parameters @@ -58,7 +58,7 @@ ___ ### create -▸ **create**(`file`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\> +**create**(`file`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\> #### Parameters @@ -105,7 +105,7 @@ ___ ### createProtected -▸ **createProtected**(`file`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\> +**createProtected**(`file`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsres)\> #### Parameters @@ -152,7 +152,7 @@ ___ ### delete -▸ **delete**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -203,7 +203,7 @@ ___ ### getPresignedDownloadUrl -▸ **getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsDownloadUrlRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsdownloadurlres)\> +**getPresignedDownloadUrl**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUploadsDownloadUrlRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuploadsdownloadurlres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_uploads/modules/admin_uploads.internal.mdx b/www/apps/docs/content/references/js-client/admin_uploads/modules/admin_uploads.internal.mdx index 4bd2b93620..eb91db9ae1 100644 --- a/www/apps/docs/content/references/js-client/admin_uploads/modules/admin_uploads.internal.mdx +++ b/www/apps/docs/content/references/js-client/admin_uploads/modules/admin_uploads.internal.mdx @@ -44,31 +44,31 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AdminCreateUploadPayload -Ƭ **AdminCreateUploadPayload**: [`File`](admin_uploads.internal.mdx#file) \| [`File`](admin_uploads.internal.mdx#file)[] + **AdminCreateUploadPayload**: [`File`](admin_uploads.internal.mdx#file) \| [`File`](admin_uploads.internal.mdx#file)[] ___ ### BlobPart -Ƭ **BlobPart**: [`BufferSource`](admin_uploads.internal.mdx#buffersource) \| `Blob` \| `string` + **BlobPart**: [`BufferSource`](admin_uploads.internal.mdx#buffersource) \| `Blob` \| `string` ___ ### BufferSource -Ƭ **BufferSource**: [`ArrayBufferView`](../../internal/interfaces/admin_discounts.internal.ArrayBufferView.mdx) \| `ArrayBuffer` + **BufferSource**: [`ArrayBufferView`](../../internal/interfaces/admin_discounts.internal.ArrayBufferView.mdx) \| `ArrayBuffer` ___ ### EndingType -Ƭ **EndingType**: ``"native"`` \| ``"transparent"`` + **EndingType**: ``"native"`` \| ``"transparent"`` ___ ### ReadableStreamController -Ƭ **ReadableStreamController**<`T`\>: [`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`T`\> \| [`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller) + **ReadableStreamController**<`T`\>: [`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`T`\> \| [`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller) #### Type parameters @@ -87,7 +87,7 @@ ___ ### ReadableStreamReadResult -Ƭ **ReadableStreamReadResult**<`T`\>: [`ReadableStreamReadValueResult`](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadValueResult.mdx)<`T`\> \| [`ReadableStreamReadDoneResult`](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadDoneResult.mdx)<`T`\> + **ReadableStreamReadResult**<`T`\>: [`ReadableStreamReadValueResult`](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadValueResult.mdx)<`T`\> \| [`ReadableStreamReadDoneResult`](../../internal/interfaces/admin_uploads.internal.ReadableStreamReadDoneResult.mdx)<`T`\> #### Type parameters @@ -106,7 +106,7 @@ ___ ### ReadableStreamReader -Ƭ **ReadableStreamReader**<`T`\>: [`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`T`\> \| [`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader) + **ReadableStreamReader**<`T`\>: [`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`T`\> \| [`ReadableStreamBYOBReader`](admin_uploads.internal.mdx#readablestreambyobreader) #### Type parameters @@ -125,11 +125,11 @@ ___ ### File -• **File**: `Object` + **File**: `Object` #### Call signature -• **new File**(`fileBits`, `fileName`, `options?`): [`File`](admin_uploads.internal.mdx#file) +**new File**(`fileBits`, `fileName`, `options?`): [`File`](admin_uploads.internal.mdx#file) ##### Parameters @@ -192,11 +192,11 @@ ___ ### ReadableByteStreamController -• **ReadableByteStreamController**: `Object` + **ReadableByteStreamController**: `Object` #### Call signature -• **new ReadableByteStreamController**(): [`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller) +**new ReadableByteStreamController**(): [`ReadableByteStreamController`](admin_uploads.internal.mdx#readablebytestreamcontroller) ##### Returns @@ -230,11 +230,11 @@ ___ ### ReadableStream -• **ReadableStream**: `Object` + **ReadableStream**: `Object` #### Call signature -• **new ReadableStream**(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`Uint8Array`\> +**new ReadableStream**(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`Uint8Array`\> ##### Parameters @@ -289,7 +289,7 @@ ___ } ]} /> -• **new ReadableStream**<`R`\>(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\> +**new ReadableStream**<`R`\>(`underlyingSource`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\> -• **new ReadableStream**<`R`\>(`underlyingSource?`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\> +**new ReadableStream**<`R`\>(`underlyingSource?`, `strategy?`): [`ReadableStream`](admin_uploads.internal.mdx#readablestream)<`R`\> +**new ReadableStreamDefaultController**(): [`ReadableStreamDefaultController`](admin_uploads.internal.mdx#readablestreamdefaultcontroller)<`any`\> ##### Returns @@ -540,11 +540,11 @@ ___ ### ReadableStreamDefaultReader -• **ReadableStreamDefaultReader**: `Object` + **ReadableStreamDefaultReader**: `Object` #### Call signature -• **new ReadableStreamDefaultReader**<`R`\>(`stream`): [`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\> +**new ReadableStreamDefaultReader**<`R`\>(`stream`): [`ReadableStreamDefaultReader`](admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\> (`underlyingSink?`, `strategy?`): [`WritableStream`](admin_uploads.internal.mdx#writablestream)<`W`\> +**new WritableStream**<`W`\>(`underlyingSink?`, `strategy?`): [`WritableStream`](admin_uploads.internal.mdx#writablestream)<`W`\> (`stream`): [`WritableStreamDefaultWriter`](admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\> +**new WritableStreamDefaultWriter**<`W`\>(`stream`): [`WritableStreamDefaultWriter`](admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> #### Parameters @@ -67,7 +67,7 @@ ___ ### delete -▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> +**delete**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`DeleteResponse`](../../internal/modules/admin_discounts.internal.internal.mdx#deleteresponse)\> #### Parameters @@ -122,7 +122,7 @@ ___ ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUsersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserslistres)\> +**list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUsersListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserslistres)\> #### Parameters @@ -169,7 +169,7 @@ ___ ### resetPassword -▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> +**resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> #### Parameters @@ -224,7 +224,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> Retrieves a given user @@ -277,7 +277,7 @@ ___ ### sendResetPasswordToken -▸ **sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\> +**sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\> #### Parameters @@ -323,7 +323,7 @@ ___ ### update -▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> +**update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminUserRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminuserres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/admin_users/modules/admin_users.internal.mdx b/www/apps/docs/content/references/js-client/admin_users/modules/admin_users.internal.mdx index 011fd4b363..bcd4f0a4a6 100644 --- a/www/apps/docs/content/references/js-client/admin_users/modules/admin_users.internal.mdx +++ b/www/apps/docs/content/references/js-client/admin_users/modules/admin_users.internal.mdx @@ -10,31 +10,31 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AdminCreateUserPayload -Ƭ **AdminCreateUserPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminCreateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx), ``"role"``\> \| { `role?`: [`CreateUserRoles`](admin_users.internal.mdx#createuserroles) } + **AdminCreateUserPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminCreateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx), ``"role"``\> \| { `role?`: [`CreateUserRoles`](admin_users.internal.mdx#createuserroles) } ___ ### AdminUpdateUserPayload -Ƭ **AdminUpdateUserPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminUpdateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx), ``"role"``\> & { `role?`: [`UpdateUserRoles`](admin_users.internal.mdx#updateuserroles) } + **AdminUpdateUserPayload**: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`AdminUpdateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx), ``"role"``\> & { `role?`: [`UpdateUserRoles`](admin_users.internal.mdx#updateuserroles) } ___ ### CreateUserRoles -Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\` + **CreateUserRoles**: \`${CreateUserRolesEnum}\` ___ ### CreateUserRolesEnum -Ƭ **CreateUserRolesEnum**: [`NoUndefined`](admin_users.internal.mdx#noundefined)<[`AdminCreateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx)[``"role"``]\> + **CreateUserRolesEnum**: [`NoUndefined`](admin_users.internal.mdx#noundefined)<[`AdminCreateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminCreateUserRequest.mdx)[``"role"``]\> ___ ### NoUndefined -Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T` + **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T` #### Type parameters @@ -53,10 +53,10 @@ ___ ### UpdateUserRoles -Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\` + **UpdateUserRoles**: \`${UpdateUserRolesEnum}\` ___ ### UpdateUserRolesEnum -Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](admin_users.internal.mdx#noundefined)<[`AdminUpdateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx)[``"role"``]\> + **UpdateUserRolesEnum**: [`NoUndefined`](admin_users.internal.mdx#noundefined)<[`AdminUpdateUserRequest`](../../internal/classes/admin_discounts.internal.internal.AdminUpdateUserRequest.mdx)[``"role"``]\> diff --git a/www/apps/docs/content/references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource.mdx b/www/apps/docs/content/references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource.mdx index bb7663dd9a..9eab5bf4c6 100644 --- a/www/apps/docs/content/references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource.mdx +++ b/www/apps/docs/content/references/js-client/admin_variants/classes/admin_variants.AdminVariantsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### getInventory -▸ **getInventory**(`variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGetVariantsVariantInventoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingetvariantsvariantinventoryres)\> +**getInventory**(`variantId`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminGetVariantsVariantInventoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#admingetvariantsvariantinventoryres)\> #### Parameters @@ -63,7 +63,7 @@ ___ ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminVariantsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminvariantslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminVariantsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminvariantslistres)\> List product variants @@ -116,7 +116,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminVariantsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminvariantsres)\> +**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`AdminVariantsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#adminvariantsres)\> Get a product variant diff --git a/www/apps/docs/content/references/js-client/auth/classes/auth.AuthResource.mdx b/www/apps/docs/content/references/js-client/auth/classes/auth.AuthResource.mdx index ff9a1215af..3ed1a0a58b 100644 --- a/www/apps/docs/content/references/js-client/auth/classes/auth.AuthResource.mdx +++ b/www/apps/docs/content/references/js-client/auth/classes/auth.AuthResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### authenticate -▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeauthres)\> +**authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeauthres)\> #### Parameters @@ -67,7 +67,7 @@ ___ ### deleteSession -▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\> +**deleteSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<`void`\> #### Parameters @@ -105,7 +105,7 @@ ___ ### exists -▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGetAuthEmailRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegetauthemailres)\> +**exists**(`email`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGetAuthEmailRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegetauthemailres)\> #### Parameters @@ -160,7 +160,7 @@ ___ ### getSession -▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeauthres)\> +**getSession**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeauthres)\> #### Parameters @@ -208,7 +208,7 @@ ___ ### getToken -▸ **getToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreBearerAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storebearerauthres)\> +**getToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreBearerAuthRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storebearerauthres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/carts/classes/carts.CartsResource.mdx b/www/apps/docs/content/references/js-client/carts/classes/carts.CartsResource.mdx index 316623d91c..44da812bcc 100644 --- a/www/apps/docs/content/references/js-client/carts/classes/carts.CartsResource.mdx +++ b/www/apps/docs/content/references/js-client/carts/classes/carts.CartsResource.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addShippingMethod -▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> +**addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> Adds a shipping method to cart @@ -86,7 +86,7 @@ ___ ### complete -▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCompleteCartRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecompletecartres)\> +**complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCompleteCartRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecompletecartres)\> Completes a cart. Payment authorization is attempted and if more work is required, we simply return the cart for further updates. @@ -143,7 +143,7 @@ ___ ### create -▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> +**create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> Creates a cart @@ -196,7 +196,7 @@ ___ ### createPaymentSessions -▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> +**createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> Creates payment sessions. Initializes the payment sessions that can be used to pay for the items of the cart. @@ -251,7 +251,7 @@ ___ ### deleteDiscount -▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> +**deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> Removes a discount from cart. @@ -312,7 +312,7 @@ ___ ### deletePaymentSession -▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> +**deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> Removes a payment session from a cart. Can be useful in case a payment has failed @@ -374,7 +374,7 @@ ___ ### refreshPaymentSession -▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> +**refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> Refreshes a payment session. @@ -435,7 +435,7 @@ ___ ### retrieve -▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> +**retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> Retrieves a cart @@ -488,7 +488,7 @@ ___ ### setPaymentSession -▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> +**setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> Refreshes a payment session. @@ -549,7 +549,7 @@ ___ ### update -▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> +**update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> Updates a cart @@ -610,7 +610,7 @@ ___ ### updatePaymentSession -▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> +**updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> Updates the payment method diff --git a/www/apps/docs/content/references/js-client/collections/classes/collections.CollectionsResource.mdx b/www/apps/docs/content/references/js-client/collections/classes/collections.CollectionsResource.mdx index 8b19265a26..5bf673eed0 100644 --- a/www/apps/docs/content/references/js-client/collections/classes/collections.CollectionsResource.mdx +++ b/www/apps/docs/content/references/js-client/collections/classes/collections.CollectionsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionslistres)\> #### Parameters @@ -67,7 +67,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionsres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecollectionsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx b/www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx index 286fb2d40f..958789f9ed 100644 --- a/www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx +++ b/www/apps/docs/content/references/js-client/customers/classes/customers.CustomerResource.mdx @@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> Creates a customer @@ -86,7 +86,7 @@ ___ ### generatePasswordToken -▸ **generatePasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) +**generatePasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) Generates a reset password token, which can be used to reset the password. The token is not returned but should be sent out to the customer in an email. @@ -131,7 +131,7 @@ ___ ### listOrders -▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersListOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomerslistordersres)\> +**listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersListOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomerslistordersres)\> Retrieve customer orders @@ -184,7 +184,7 @@ ___ ### resetPassword -▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> +**resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> Resets customer password @@ -237,7 +237,7 @@ ___ ### retrieve -▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> +**retrieve**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> Retrieves the customer that is currently logged @@ -282,7 +282,7 @@ ___ ### update -▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> +**update**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomersres)\> Updates a customer diff --git a/www/apps/docs/content/references/js-client/gift_cards/classes/gift_cards.GiftCardsResource.mdx b/www/apps/docs/content/references/js-client/gift_cards/classes/gift_cards.GiftCardsResource.mdx index f5955786fb..033a4149b3 100644 --- a/www/apps/docs/content/references/js-client/gift_cards/classes/gift_cards.GiftCardsResource.mdx +++ b/www/apps/docs/content/references/js-client/gift_cards/classes/gift_cards.GiftCardsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### retrieve -▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegiftcardsres)\> +**retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGiftCardsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegiftcardsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx b/www/apps/docs/content/references/js-client/internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx index 3f38179e03..7f38f19a59 100644 --- a/www/apps/docs/content/references/js-client/internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx +++ b/www/apps/docs/content/references/js-client/internal-2/classes/admin_discounts.internal.internal-2.Writable.mdx @@ -141,7 +141,7 @@ v0.9.4 ### \_construct -▸ `Optional` **_construct**(`callback`): `void` +`Optional` **_construct**(`callback`): `void` #### Parameters @@ -179,7 +179,7 @@ ___ ### \_destroy -▸ **_destroy**(`error`, `callback`): `void` +**_destroy**(`error`, `callback`): `void` #### Parameters @@ -225,7 +225,7 @@ ___ ### \_final -▸ **_final**(`callback`): `void` +**_final**(`callback`): `void` #### Parameters @@ -263,7 +263,7 @@ ___ ### \_write -▸ **_write**(`chunk`, `encoding`, `callback`): `void` +**_write**(`chunk`, `encoding`, `callback`): `void` #### Parameters @@ -317,7 +317,7 @@ ___ ### \_writev -▸ `Optional` **_writev**(`chunks`, `callback`): `void` +`Optional` **_writev**(`chunks`, `callback`): `void` #### Parameters @@ -363,7 +363,7 @@ ___ ### addListener -▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) Event emitter The defined events on documents including: @@ -414,7 +414,7 @@ The defined events on documents including: [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -456,7 +456,7 @@ The defined events on documents including: [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -498,7 +498,7 @@ The defined events on documents including: [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -540,7 +540,7 @@ The defined events on documents including: [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -582,7 +582,7 @@ The defined events on documents including: [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -624,7 +624,7 @@ The defined events on documents including: [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[addListener](../../internal/classes/admin_discounts.internal.WritableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**addListener**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -670,7 +670,7 @@ ___ ### cork -▸ **cork**(): `void` +**cork**(): `void` The `writable.cork()` method forces all written data to be buffered in memory. The buffered data will be flushed when either the [uncork](../../internal/classes/admin_discounts.internal.WritableBase.mdx#uncork) or [end](../../internal/classes/admin_discounts.internal.WritableBase.mdx#end) methods are called. @@ -711,7 +711,7 @@ ___ ### destroy -▸ **destroy**(`error?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**destroy**(`error?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the writable stream has ended and subsequent calls to `write()` or `end()` will result in @@ -766,7 +766,7 @@ ___ ### emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -842,7 +842,7 @@ v0.1.26 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -876,7 +876,7 @@ v0.1.26 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit) -▸ **emit**(`event`, `err`): `boolean` +**emit**(`event`, `err`): `boolean` #### Parameters @@ -918,7 +918,7 @@ v0.1.26 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -952,7 +952,7 @@ v0.1.26 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit) -▸ **emit**(`event`, `src`): `boolean` +**emit**(`event`, `src`): `boolean` #### Parameters @@ -994,7 +994,7 @@ v0.1.26 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit) -▸ **emit**(`event`, `src`): `boolean` +**emit**(`event`, `src`): `boolean` #### Parameters @@ -1036,7 +1036,7 @@ v0.1.26 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[emit](../../internal/classes/admin_discounts.internal.WritableBase.mdx#emit) -▸ **emit**(`event`, `...args`): `boolean` +**emit**(`event`, `...args`): `boolean` #### Parameters @@ -1082,7 +1082,7 @@ ___ ### end -▸ **end**(`cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**end**(`cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) Calling the `writable.end()` method signals that no more data will be written to the `Writable`. The optional `chunk` and `encoding` arguments allow one @@ -1136,7 +1136,7 @@ v0.9.4 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[end](../../internal/classes/admin_discounts.internal.WritableBase.mdx#end) -▸ **end**(`chunk`, `cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**end**(`chunk`, `cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -1178,7 +1178,7 @@ v0.9.4 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[end](../../internal/classes/admin_discounts.internal.WritableBase.mdx#end) -▸ **end**(`chunk`, `encoding`, `cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**end**(`chunk`, `encoding`, `cb?`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -1232,7 +1232,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -1287,7 +1287,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.internal-2.Writable.mdx#defaultmaxlisteners). @@ -1319,7 +1319,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -1373,7 +1373,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -1425,7 +1425,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**off**(`eventName`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) Alias for `emitter.removeListener()`. @@ -1477,7 +1477,7 @@ ___ ### on -▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -1550,7 +1550,7 @@ v0.1.101 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -1592,7 +1592,7 @@ v0.1.101 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -1634,7 +1634,7 @@ v0.1.101 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -1676,7 +1676,7 @@ v0.1.101 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -1718,7 +1718,7 @@ v0.1.101 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -1760,7 +1760,7 @@ v0.1.101 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[on](../../internal/classes/admin_discounts.internal.WritableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**on**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -1806,7 +1806,7 @@ ___ ### once -▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1877,7 +1877,7 @@ v0.3.0 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -1919,7 +1919,7 @@ v0.3.0 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -1961,7 +1961,7 @@ v0.3.0 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -2003,7 +2003,7 @@ v0.3.0 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -2045,7 +2045,7 @@ v0.3.0 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -2087,7 +2087,7 @@ v0.3.0 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) +**once**(`event`, `listener`): [`Writable`](admin_discounts.internal.internal-2.Writable.mdx) #### Parameters @@ -2133,7 +2133,7 @@ ___ ### pipe -▸ **pipe**<`T`\>(`destination`, `options?`): `T` +**pipe**<`T`\>(`destination`, `options?`): `T` +`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../../internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> ```js import { on, EventEmitter } from 'node:events'; @@ -3932,7 +3932,7 @@ ___ ### once -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. @@ -4081,7 +4081,7 @@ v11.13.0, v10.16.0 [WritableBase](../../internal/classes/admin_discounts.internal.WritableBase.mdx).[once](../../internal/classes/admin_discounts.internal.WritableBase.mdx#once-1) -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> #### Parameters @@ -4153,7 +4153,7 @@ ___ ### setMaxListeners -▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` +`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` ```js import { setMaxListeners, EventEmitter } from 'node:events'; @@ -4212,7 +4212,7 @@ ___ ### toWeb -▸ `Static` **toWeb**(`streamWritable`): [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> +`Static` **toWeb**(`streamWritable`): [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> A utility method for creating a web `WritableStream` from a `Writable`. diff --git a/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.Pipe.mdx b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.Pipe.mdx index bfe598a059..bbbf885811 100644 --- a/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.Pipe.mdx +++ b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.Pipe.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### close -▸ **close**(): `void` +**close**(): `void` #### Returns @@ -33,7 +33,7 @@ ___ ### hasRef -▸ **hasRef**(): `boolean` +**hasRef**(): `boolean` #### Returns @@ -54,7 +54,7 @@ ___ ### ref -▸ **ref**(): `void` +**ref**(): `void` #### Returns @@ -75,7 +75,7 @@ ___ ### unref -▸ **unref**(): `void` +**unref**(): `void` #### Returns diff --git a/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx index 291545b101..4f75457c21 100644 --- a/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx +++ b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.ReadableOptions.mdx @@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### construct -▸ `Optional` **construct**(`this`, `callback`): `void` +`Optional` **construct**(`this`, `callback`): `void` #### Parameters @@ -111,7 +111,7 @@ ___ ### destroy -▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` +`Optional` **destroy**(`this`, `error`, `callback`): `void` #### Parameters @@ -165,7 +165,7 @@ ___ ### read -▸ `Optional` **read**(`this`, `size`): `void` +`Optional` **read**(`this`, `size`): `void` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.StreamOptions.mdx b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.StreamOptions.mdx index 114dea23cc..2b71d8415c 100644 --- a/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.StreamOptions.mdx +++ b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.StreamOptions.mdx @@ -70,7 +70,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### construct -▸ `Optional` **construct**(`this`, `callback`): `void` +`Optional` **construct**(`this`, `callback`): `void` #### Parameters @@ -112,7 +112,7 @@ ___ ### destroy -▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` +`Optional` **destroy**(`this`, `error`, `callback`): `void` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx index 332c076960..3ca4da0e5b 100644 --- a/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx +++ b/www/apps/docs/content/references/js-client/internal-2/interfaces/admin_discounts.internal.internal-2.WritableOptions.mdx @@ -73,7 +73,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### construct -▸ `Optional` **construct**(`this`, `callback`): `void` +`Optional` **construct**(`this`, `callback`): `void` #### Parameters @@ -119,7 +119,7 @@ ___ ### destroy -▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` +`Optional` **destroy**(`this`, `error`, `callback`): `void` #### Parameters @@ -173,7 +173,7 @@ ___ ### final -▸ `Optional` **final**(`this`, `callback`): `void` +`Optional` **final**(`this`, `callback`): `void` #### Parameters @@ -215,7 +215,7 @@ ___ ### write -▸ `Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void` +`Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void` #### Parameters @@ -273,7 +273,7 @@ ___ ### writev -▸ `Optional` **writev**(`this`, `chunks`, `callback`): `void` +`Optional` **writev**(`this`, `chunks`, `callback`): `void` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.finished.mdx b/www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.finished.mdx index 4cb5712695..5638ed9ebc 100644 --- a/www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.finished.mdx +++ b/www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.finished.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### \_\_promisify\_\_ -▸ **__promisify__**(`stream`, `options?`): `Promise`<`void`\> +**__promisify__**(`stream`, `options?`): `Promise`<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.pipeline.mdx b/www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.pipeline.mdx index 9526d42f87..b645ea273e 100644 --- a/www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.pipeline.mdx +++ b/www/apps/docs/content/references/js-client/internal-2/modules/admin_discounts.internal.internal-2.pipeline.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### \_\_promisify\_\_ -▸ **__promisify__**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> +**__promisify__**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> -▸ **__promisify__**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> +**__promisify__**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> -▸ **__promisify__**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> +**__promisify__**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> -▸ **__promisify__**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> +**__promisify__**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> -▸ **__promisify__**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> +**__promisify__**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](../../internal/modules/admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> -▸ **__promisify__**(`streams`, `options?`): `Promise`<`void`\> +**__promisify__**(`streams`, `options?`): `Promise`<`void`\> #### Parameters @@ -535,7 +535,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" } ]} /> -▸ **__promisify__**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\> +**__promisify__**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.BatchJob.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.BatchJob.mdx index 4b087d41bc..0dfa6657bb 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.BatchJob.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_batch_jobs.internal.BatchJob.mdx @@ -163,7 +163,7 @@ Base abstract entity for all entities ### loadStatus -▸ **loadStatus**(): `void` +**loadStatus**(): `void` #### Returns @@ -184,7 +184,7 @@ ___ ### toJSON -▸ **toJSON**(): [`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx) +**toJSON**(): [`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx) #### Returns diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItem.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItem.mdx index ca2d24b37b..5a80b46844 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItem.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.LineItem.mdx @@ -371,7 +371,7 @@ Base abstract entity for all entities ### afterUpdateOrLoad -▸ **afterUpdateOrLoad**(): `void` +**afterUpdateOrLoad**(): `void` #### Returns @@ -392,7 +392,7 @@ ___ ### beforeUpdate -▸ **beforeUpdate**(): `void` +**beforeUpdate**(): `void` #### Returns diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.OrderEdit.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.OrderEdit.mdx index 46ce05bb2b..94ce72293b 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.OrderEdit.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_collections.internal.OrderEdit.mdx @@ -259,7 +259,7 @@ Base abstract entity for all entities ### loadStatus -▸ **loadStatus**(): `void` +**loadStatus**(): `void` #### Returns diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AbstractEventBusModuleService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AbstractEventBusModuleService.mdx index dbaf5e4675..d2afb2f8cc 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AbstractEventBusModuleService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.AbstractEventBusModuleService.mdx @@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### eventToSubscribersMap -• `get` **eventToSubscribersMap**(): `Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscriberdescriptor)[]\> +`get` **eventToSubscribersMap**(): `Map`<`string` \| `symbol`, [`SubscriberDescriptor`](../../admin_discounts/modules/admin_discounts.internal.mdx#subscriberdescriptor)[]\> #### Returns @@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### emit -▸ `Abstract` **emit**<`T`\>(`eventName`, `data`, `options`): `Promise`<`void`\> +`Abstract` **emit**<`T`\>(`eventName`, `data`, `options`): `Promise`<`void`\> (`data`): `Promise`<`void`\> +`Abstract` **emit**<`T`\>(`data`): `Promise`<`void`\> +`get` **options**(): Record<`string`, `unknown`\> #### Returns @@ -79,7 +79,7 @@ Record<`string`, `unknown`\> ### addDocuments -▸ `Abstract` **addDocuments**(`indexName`, `documents`, `type`): `unknown` +`Abstract` **addDocuments**(`indexName`, `documents`, `type`): `unknown` Used to index documents by the search engine provider @@ -135,7 +135,7 @@ ___ ### createIndex -▸ `Abstract` **createIndex**(`indexName`, `options`): `unknown` +`Abstract` **createIndex**(`indexName`, `options`): `unknown` Used to create an index @@ -183,7 +183,7 @@ ___ ### deleteAllDocuments -▸ `Abstract` **deleteAllDocuments**(`indexName`): `unknown` +`Abstract` **deleteAllDocuments**(`indexName`): `unknown` Used to delete all documents @@ -223,7 +223,7 @@ ___ ### deleteDocument -▸ `Abstract` **deleteDocument**(`indexName`, `document_id`): `unknown` +`Abstract` **deleteDocument**(`indexName`, `document_id`): `unknown` Used to delete document @@ -271,7 +271,7 @@ ___ ### getIndex -▸ `Abstract` **getIndex**(`indexName`): `unknown` +`Abstract` **getIndex**(`indexName`): `unknown` Used to get an index @@ -311,7 +311,7 @@ ___ ### replaceDocuments -▸ `Abstract` **replaceDocuments**(`indexName`, `documents`, `type`): `unknown` +`Abstract` **replaceDocuments**(`indexName`, `documents`, `type`): `unknown` Used to replace documents @@ -367,7 +367,7 @@ ___ ### search -▸ `Abstract` **search**(`indexName`, `query`, `options`): `unknown` +`Abstract` **search**(`indexName`, `query`, `options`): `unknown` Used to search for a document in an index @@ -423,7 +423,7 @@ ___ ### updateSettings -▸ `Abstract` **updateSettings**(`indexName`, `settings`): `unknown` +`Abstract` **updateSettings**(`indexName`, `settings`): `unknown` Used to update the settings of an index diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Blob.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Blob.mdx index 3d8aa61a50..3713eae76b 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Blob.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Blob.mdx @@ -40,7 +40,7 @@ v15.7.0, v14.18.0 ### arrayBuffer -▸ **arrayBuffer**(): `Promise`<`ArrayBuffer`\> +**arrayBuffer**(): `Promise`<`ArrayBuffer`\> Returns a promise that fulfills with an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) containing a copy of the `Blob` data. @@ -68,7 +68,7 @@ ___ ### slice -▸ **slice**(`start?`, `end?`, `type?`): [`Blob`](admin_discounts.internal.Blob.mdx) +**slice**(`start?`, `end?`, `type?`): [`Blob`](admin_discounts.internal.Blob.mdx) Creates and returns a new `Blob` containing a subset of this `Blob` objects data. The original `Blob` is not altered. @@ -125,7 +125,7 @@ ___ ### stream -▸ **stream**(): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> +**stream**(): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> Returns a new `ReadableStream` that allows the content of the `Blob` to be read. @@ -161,7 +161,7 @@ ___ ### text -▸ **text**(): `Promise`<`string`\> +**text**(): `Promise`<`string`\> Returns a promise that fulfills with the contents of the `Blob` decoded as a UTF-8 string. diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Duplex.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Duplex.mdx index 659011c85d..12545e687f 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Duplex.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Duplex.mdx @@ -233,7 +233,7 @@ v0.9.4 ### [asyncIterator] -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> +**[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> #### Returns @@ -267,7 +267,7 @@ ___ ### \_construct -▸ `Optional` **_construct**(`callback`): `void` +`Optional` **_construct**(`callback`): `void` #### Parameters @@ -309,7 +309,7 @@ ___ ### \_destroy -▸ **_destroy**(`error`, `callback`): `void` +**_destroy**(`error`, `callback`): `void` #### Parameters @@ -359,7 +359,7 @@ ___ ### \_final -▸ **_final**(`callback`): `void` +**_final**(`callback`): `void` #### Parameters @@ -397,7 +397,7 @@ ___ ### \_read -▸ **_read**(`size`): `void` +**_read**(`size`): `void` #### Parameters @@ -435,7 +435,7 @@ ___ ### \_write -▸ **_write**(`chunk`, `encoding`, `callback`): `void` +**_write**(`chunk`, `encoding`, `callback`): `void` #### Parameters @@ -489,7 +489,7 @@ ___ ### \_writev -▸ `Optional` **_writev**(`chunks`, `callback`): `void` +`Optional` **_writev**(`chunks`, `callback`): `void` #### Parameters @@ -535,7 +535,7 @@ ___ ### addListener -▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) Event emitter The defined events on documents including: @@ -595,7 +595,7 @@ The defined events on documents including: [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -641,7 +641,7 @@ The defined events on documents including: [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -687,7 +687,7 @@ The defined events on documents including: [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -733,7 +733,7 @@ The defined events on documents including: [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -779,7 +779,7 @@ The defined events on documents including: [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -825,7 +825,7 @@ The defined events on documents including: [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -871,7 +871,7 @@ The defined events on documents including: [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -917,7 +917,7 @@ WritableBase.addListener [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -963,7 +963,7 @@ WritableBase.addListener ReadableBase.addListener -▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -1009,7 +1009,7 @@ WritableBase.addListener ReadableBase.addListener -▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -1055,7 +1055,7 @@ WritableBase.addListener ReadableBase.addListener -▸ **addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**addListener**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -1105,7 +1105,7 @@ ___ ### cork -▸ **cork**(): `void` +**cork**(): `void` The `writable.cork()` method forces all written data to be buffered in memory. The buffered data will be flushed when either the [uncork](admin_discounts.internal.WritableBase.mdx#uncork) or [end](admin_discounts.internal.WritableBase.mdx#end) methods are called. @@ -1146,7 +1146,7 @@ ___ ### destroy -▸ **destroy**(`error?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**destroy**(`error?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable stream will release any internal resources and subsequent calls to `push()`will be ignored. @@ -1200,7 +1200,7 @@ ___ ### emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -1280,7 +1280,7 @@ v0.1.26 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`, `chunk`): `boolean` +**emit**(`event`, `chunk`): `boolean` #### Parameters @@ -1326,7 +1326,7 @@ v0.1.26 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1364,7 +1364,7 @@ v0.1.26 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1402,7 +1402,7 @@ v0.1.26 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`, `err`): `boolean` +**emit**(`event`, `err`): `boolean` #### Parameters @@ -1448,7 +1448,7 @@ v0.1.26 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1486,7 +1486,7 @@ v0.1.26 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1524,7 +1524,7 @@ v0.1.26 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`, `src`): `boolean` +**emit**(`event`, `src`): `boolean` #### Parameters @@ -1570,7 +1570,7 @@ WritableBase.emit [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1608,7 +1608,7 @@ WritableBase.emit ReadableBase.emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1646,7 +1646,7 @@ WritableBase.emit ReadableBase.emit -▸ **emit**(`event`, `src`): `boolean` +**emit**(`event`, `src`): `boolean` #### Parameters @@ -1692,7 +1692,7 @@ WritableBase.emit ReadableBase.emit -▸ **emit**(`event`, `...args`): `boolean` +**emit**(`event`, `...args`): `boolean` #### Parameters @@ -1742,7 +1742,7 @@ ___ ### end -▸ **end**(`cb?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**end**(`cb?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) Calling the `writable.end()` method signals that no more data will be written to the `Writable`. The optional `chunk` and `encoding` arguments allow one @@ -1796,7 +1796,7 @@ v0.9.4 [WritableBase](admin_discounts.internal.WritableBase.mdx).[end](admin_discounts.internal.WritableBase.mdx#end) -▸ **end**(`chunk`, `cb?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**end**(`chunk`, `cb?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -1838,7 +1838,7 @@ v0.9.4 [WritableBase](admin_discounts.internal.WritableBase.mdx).[end](admin_discounts.internal.WritableBase.mdx#end) -▸ **end**(`chunk`, `encoding?`, `cb?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**end**(`chunk`, `encoding?`, `cb?`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -1892,7 +1892,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -1951,7 +1951,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.Duplex.mdx#defaultmaxlisteners). @@ -1987,7 +1987,7 @@ ___ ### isPaused -▸ **isPaused**(): `boolean` +**isPaused**(): `boolean` The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most typical cases, there will be no reason to @@ -2030,7 +2030,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -2088,7 +2088,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -2144,7 +2144,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**off**(`eventName`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) Alias for `emitter.removeListener()`. @@ -2200,7 +2200,7 @@ ___ ### on -▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -2277,7 +2277,7 @@ v0.1.101 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -2323,7 +2323,7 @@ v0.1.101 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -2369,7 +2369,7 @@ v0.1.101 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -2415,7 +2415,7 @@ v0.1.101 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -2461,7 +2461,7 @@ v0.1.101 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -2507,7 +2507,7 @@ v0.1.101 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -2553,7 +2553,7 @@ v0.1.101 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -2599,7 +2599,7 @@ WritableBase.on [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -2645,7 +2645,7 @@ WritableBase.on ReadableBase.on -▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -2691,7 +2691,7 @@ WritableBase.on ReadableBase.on -▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -2737,7 +2737,7 @@ WritableBase.on ReadableBase.on -▸ **on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**on**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -2787,7 +2787,7 @@ ___ ### once -▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -2862,7 +2862,7 @@ v0.3.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -2908,7 +2908,7 @@ v0.3.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -2954,7 +2954,7 @@ v0.3.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -3000,7 +3000,7 @@ v0.3.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -3046,7 +3046,7 @@ v0.3.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -3092,7 +3092,7 @@ v0.3.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -3138,7 +3138,7 @@ v0.3.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -3184,7 +3184,7 @@ WritableBase.once [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -3230,7 +3230,7 @@ WritableBase.once ReadableBase.once -▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -3276,7 +3276,7 @@ WritableBase.once ReadableBase.once -▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -3322,7 +3322,7 @@ WritableBase.once ReadableBase.once -▸ **once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**once**(`event`, `listener`): [`Duplex`](admin_discounts.internal.Duplex.mdx) #### Parameters @@ -3372,7 +3372,7 @@ ___ ### pause -▸ **pause**(): [`Duplex`](admin_discounts.internal.Duplex.mdx) +**pause**(): [`Duplex`](admin_discounts.internal.Duplex.mdx) The `readable.pause()` method will cause a stream in flowing mode to stop emitting `'data'` events, switching out of flowing mode. Any data that @@ -3420,7 +3420,7 @@ ___ ### pipe -▸ **pipe**<`T`\>(`destination`, `options?`): `T` +**pipe**<`T`\>(`destination`, `options?`): `T` +`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> ```js import { on, EventEmitter } from 'node:events'; @@ -6637,7 +6637,7 @@ ___ ### once -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. @@ -6786,7 +6786,7 @@ v11.13.0, v10.16.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once-1) -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> #### Parameters @@ -6858,7 +6858,7 @@ ___ ### setMaxListeners -▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` +`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` ```js import { setMaxListeners, EventEmitter } from 'node:events'; @@ -6917,7 +6917,7 @@ ___ ### toWeb -▸ `Static` **toWeb**(`streamDuplex`): { `readable`: [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> ; `writable`: [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> } +`Static` **toWeb**(`streamDuplex`): { `readable`: [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> ; `writable`: [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> } A utility method for creating a web `ReadableStream` and `WritableStream` from a `Duplex`. diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.EventEmitter-1.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.EventEmitter-1.mdx index 37152e333a..d23f301240 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.EventEmitter-1.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.EventEmitter-1.mdx @@ -64,7 +64,7 @@ v0.1.26 ### addListener -▸ **addListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) +**addListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) Alias for `emitter.on(eventName, listener)`. @@ -116,7 +116,7 @@ ___ ### emit -▸ **emit**(`eventName`, `...args`): `boolean` +**emit**(`eventName`, `...args`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -204,7 +204,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -259,7 +259,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.EventEmitter-1.mdx#defaultmaxlisteners). @@ -291,7 +291,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -345,7 +345,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -397,7 +397,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) +**off**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) Alias for `emitter.removeListener()`. @@ -449,7 +449,7 @@ ___ ### on -▸ **on**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) +**on**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -526,7 +526,7 @@ ___ ### once -▸ **once**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) +**once**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -601,7 +601,7 @@ ___ ### prependListener -▸ **prependListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) +**prependListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) Adds the `listener` function to the _beginning_ of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -664,7 +664,7 @@ ___ ### prependOnceListener -▸ **prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) +**prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this listener is removed, and then invoked. @@ -725,7 +725,7 @@ ___ ### rawListeners -▸ **rawListeners**(`eventName`): `Function`[] +**rawListeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`, including any wrappers (such as those created by `.once()`). @@ -795,7 +795,7 @@ ___ ### removeAllListeners -▸ **removeAllListeners**(`event?`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) +**removeAllListeners**(`event?`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) Removes all listeners, or those of the specified `eventName`. @@ -845,7 +845,7 @@ ___ ### removeListener -▸ **removeListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) +**removeListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) Removes the specified `listener` from the listener array for the event named`eventName`. @@ -975,7 +975,7 @@ ___ ### setMaxListeners -▸ **setMaxListeners**(`n`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) +**setMaxListeners**(`n`): [`EventEmitter`](admin_discounts.internal.EventEmitter-1.mdx) By default `EventEmitter`s will print a warning if more than `10` listeners are added for a particular event. This is a useful default that helps finding @@ -1024,7 +1024,7 @@ ___ ### getEventListeners -▸ `Static` **getEventListeners**(`emitter`, `name`): `Function`[] +`Static` **getEventListeners**(`emitter`, `name`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -1095,7 +1095,7 @@ ___ ### listenerCount -▸ `Static` **listenerCount**(`emitter`, `eventName`): `number` +`Static` **listenerCount**(`emitter`, `eventName`): `number` A class method that returns the number of listeners for the given `eventName`registered on the given `emitter`. @@ -1161,7 +1161,7 @@ ___ ### on -▸ `Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> +`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> ```js import { on, EventEmitter } from 'node:events'; @@ -1283,7 +1283,7 @@ ___ ### once -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. @@ -1432,7 +1432,7 @@ v11.13.0, v10.16.0 NodeJS.EventEmitter.once -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> #### Parameters @@ -1504,7 +1504,7 @@ ___ ### setMaxListeners -▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` +`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` ```js import { setMaxListeners, EventEmitter } from 'node:events'; diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FlagRouter.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FlagRouter.mdx index e1eb2af5ca..edeb32102d 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FlagRouter.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FlagRouter.mdx @@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### isFeatureEnabled -▸ **isFeatureEnabled**(`flag`): `boolean` +**isFeatureEnabled**(`flag`): `boolean` Check if a feature flag is enabled. There are two ways of using this method: @@ -75,7 +75,7 @@ ___ ### listFlags -▸ **listFlags**(): [`FeatureFlagsResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#featureflagsresponse-1) +**listFlags**(): [`FeatureFlagsResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#featureflagsresponse-1) #### Returns @@ -100,7 +100,7 @@ ___ ### setFlag -▸ **setFlag**(`key`, `value`): `void` +**setFlag**(`key`, `value`): `void` Sets a feature flag. Flags take two shapes: diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FulfillmentService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FulfillmentService.mdx index d48d1cefc9..e214687544 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FulfillmentService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.FulfillmentService.mdx @@ -123,7 +123,7 @@ Handles Fulfillments ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -148,7 +148,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -225,7 +225,7 @@ ___ ### cancelFulfillment -▸ **cancelFulfillment**(`fulfillmentOrId`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> +**cancelFulfillment**(`fulfillmentOrId`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> Cancels a fulfillment with the fulfillment provider. Will decrement the fulfillment_quantity on the line items associated with the fulfillment. @@ -272,7 +272,7 @@ ___ ### createFulfillment -▸ **createFulfillment**(`order`, `itemsToFulfill`, `custom?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)[]\> +**createFulfillment**(`order`, `itemsToFulfill`, `custom?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)[]\> Creates an order fulfillment If items needs to be fulfilled by different provider, we make @@ -345,7 +345,7 @@ ___ ### createShipment -▸ **createShipment**(`fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> +**createShipment**(`fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> Creates a shipment by marking a fulfillment as shipped. Adds tracking links and potentially more metadata. @@ -407,7 +407,7 @@ ___ ### getFulfillmentItems\_ -▸ **getFulfillmentItems_**(`order`, `items`): `Promise`<(``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx))[]\> +**getFulfillmentItems_**(`order`, `items`): `Promise`<(``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx))[]\> Retrieves the order line items, given an array of items. @@ -469,7 +469,7 @@ ___ ### partitionItems\_ -▸ **partitionItems_**(`shippingMethods`, `items`): [`FulfillmentItemPartition`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentitempartition)[] +**partitionItems_**(`shippingMethods`, `items`): [`FulfillmentItemPartition`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentitempartition)[] #### Parameters @@ -520,7 +520,7 @@ ___ ### retrieve -▸ **retrieve**(`fulfillmentId`, `config?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> +**retrieve**(`fulfillmentId`, `config?`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> Retrieves a fulfillment by its id. @@ -573,7 +573,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -611,7 +611,7 @@ ___ ### validateFulfillmentLineItem\_ -▸ **validateFulfillmentLineItem_**(`item`, `quantity`): ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx) +**validateFulfillmentLineItem_**(`item`, `quantity`): ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx) Checks that a given quantity of a line item can be fulfilled. Fails if the fulfillable quantity is lower than the requested fulfillment quantity. @@ -658,7 +658,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`FulfillmentService`](admin_discounts.internal.FulfillmentService.mdx) +**withTransaction**(`transactionManager?`): [`FulfillmentService`](admin_discounts.internal.FulfillmentService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.MedusaError.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.MedusaError.mdx index 007af05900..166db7f924 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.MedusaError.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.MedusaError.mdx @@ -195,7 +195,7 @@ Standardized error to be used across Medusa project. ### captureStackTrace -▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` +`Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` Create .stack property on a target object diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PassThrough.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PassThrough.mdx index c8d7f22571..67a7b06248 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PassThrough.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PassThrough.mdx @@ -220,7 +220,7 @@ primarily for examples and testing, but there are some use cases where`stream.Pa ### [asyncIterator] -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> +**[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> #### Returns @@ -254,7 +254,7 @@ ___ ### \_construct -▸ `Optional` **_construct**(`callback`): `void` +`Optional` **_construct**(`callback`): `void` #### Parameters @@ -292,7 +292,7 @@ ___ ### \_destroy -▸ **_destroy**(`error`, `callback`): `void` +**_destroy**(`error`, `callback`): `void` #### Parameters @@ -338,7 +338,7 @@ ___ ### \_final -▸ **_final**(`callback`): `void` +**_final**(`callback`): `void` #### Parameters @@ -376,7 +376,7 @@ ___ ### \_flush -▸ **_flush**(`callback`): `void` +**_flush**(`callback`): `void` #### Parameters @@ -414,7 +414,7 @@ ___ ### \_read -▸ **_read**(`size`): `void` +**_read**(`size`): `void` #### Parameters @@ -452,7 +452,7 @@ ___ ### \_transform -▸ **_transform**(`chunk`, `encoding`, `callback`): `void` +**_transform**(`chunk`, `encoding`, `callback`): `void` #### Parameters @@ -506,7 +506,7 @@ ___ ### \_write -▸ **_write**(`chunk`, `encoding`, `callback`): `void` +**_write**(`chunk`, `encoding`, `callback`): `void` #### Parameters @@ -560,7 +560,7 @@ ___ ### \_writev -▸ `Optional` **_writev**(`chunks`, `callback`): `void` +`Optional` **_writev**(`chunks`, `callback`): `void` #### Parameters @@ -606,7 +606,7 @@ ___ ### addListener -▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) Event emitter The defined events on documents including: @@ -662,7 +662,7 @@ The defined events on documents including: [Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -704,7 +704,7 @@ The defined events on documents including: [Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -746,7 +746,7 @@ The defined events on documents including: [Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -788,7 +788,7 @@ The defined events on documents including: [Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -830,7 +830,7 @@ The defined events on documents including: [Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -872,7 +872,7 @@ The defined events on documents including: [Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -914,7 +914,7 @@ The defined events on documents including: [Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -956,7 +956,7 @@ The defined events on documents including: [Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -998,7 +998,7 @@ The defined events on documents including: [Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -1040,7 +1040,7 @@ The defined events on documents including: [Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -1082,7 +1082,7 @@ The defined events on documents including: [Transform](admin_discounts.internal.Transform.mdx).[addListener](admin_discounts.internal.Transform.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**addListener**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -1128,7 +1128,7 @@ ___ ### cork -▸ **cork**(): `void` +**cork**(): `void` The `writable.cork()` method forces all written data to be buffered in memory. The buffered data will be flushed when either the [uncork](admin_discounts.internal.WritableBase.mdx#uncork) or [end](admin_discounts.internal.WritableBase.mdx#end) methods are called. @@ -1169,7 +1169,7 @@ ___ ### destroy -▸ **destroy**(`error?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**destroy**(`error?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable stream will release any internal resources and subsequent calls to `push()`will be ignored. @@ -1219,7 +1219,7 @@ ___ ### emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -1295,7 +1295,7 @@ v0.1.26 [Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) -▸ **emit**(`event`, `chunk`): `boolean` +**emit**(`event`, `chunk`): `boolean` #### Parameters @@ -1337,7 +1337,7 @@ v0.1.26 [Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1371,7 +1371,7 @@ v0.1.26 [Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1405,7 +1405,7 @@ v0.1.26 [Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) -▸ **emit**(`event`, `err`): `boolean` +**emit**(`event`, `err`): `boolean` #### Parameters @@ -1447,7 +1447,7 @@ v0.1.26 [Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1481,7 +1481,7 @@ v0.1.26 [Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1515,7 +1515,7 @@ v0.1.26 [Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) -▸ **emit**(`event`, `src`): `boolean` +**emit**(`event`, `src`): `boolean` #### Parameters @@ -1557,7 +1557,7 @@ v0.1.26 [Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1591,7 +1591,7 @@ v0.1.26 [Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1625,7 +1625,7 @@ v0.1.26 [Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) -▸ **emit**(`event`, `src`): `boolean` +**emit**(`event`, `src`): `boolean` #### Parameters @@ -1667,7 +1667,7 @@ v0.1.26 [Transform](admin_discounts.internal.Transform.mdx).[emit](admin_discounts.internal.Transform.mdx#emit) -▸ **emit**(`event`, `...args`): `boolean` +**emit**(`event`, `...args`): `boolean` #### Parameters @@ -1713,7 +1713,7 @@ ___ ### end -▸ **end**(`cb?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**end**(`cb?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) Calling the `writable.end()` method signals that no more data will be written to the `Writable`. The optional `chunk` and `encoding` arguments allow one @@ -1767,7 +1767,7 @@ v0.9.4 [Transform](admin_discounts.internal.Transform.mdx).[end](admin_discounts.internal.Transform.mdx#end) -▸ **end**(`chunk`, `cb?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**end**(`chunk`, `cb?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -1809,7 +1809,7 @@ v0.9.4 [Transform](admin_discounts.internal.Transform.mdx).[end](admin_discounts.internal.Transform.mdx#end) -▸ **end**(`chunk`, `encoding?`, `cb?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**end**(`chunk`, `encoding?`, `cb?`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -1863,7 +1863,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -1918,7 +1918,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.PassThrough.mdx#defaultmaxlisteners). @@ -1950,7 +1950,7 @@ ___ ### isPaused -▸ **isPaused**(): `boolean` +**isPaused**(): `boolean` The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most typical cases, there will be no reason to @@ -1993,7 +1993,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -2047,7 +2047,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -2099,7 +2099,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**off**(`eventName`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) Alias for `emitter.removeListener()`. @@ -2151,7 +2151,7 @@ ___ ### on -▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -2224,7 +2224,7 @@ v0.1.101 [Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) -▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2266,7 +2266,7 @@ v0.1.101 [Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) -▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2308,7 +2308,7 @@ v0.1.101 [Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) -▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2350,7 +2350,7 @@ v0.1.101 [Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) -▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2392,7 +2392,7 @@ v0.1.101 [Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) -▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2434,7 +2434,7 @@ v0.1.101 [Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) -▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2476,7 +2476,7 @@ v0.1.101 [Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) -▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2518,7 +2518,7 @@ v0.1.101 [Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) -▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2560,7 +2560,7 @@ v0.1.101 [Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) -▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2602,7 +2602,7 @@ v0.1.101 [Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) -▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2644,7 +2644,7 @@ v0.1.101 [Transform](admin_discounts.internal.Transform.mdx).[on](admin_discounts.internal.Transform.mdx#on) -▸ **on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**on**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2690,7 +2690,7 @@ ___ ### once -▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -2761,7 +2761,7 @@ v0.3.0 [Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) -▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2803,7 +2803,7 @@ v0.3.0 [Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) -▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2845,7 +2845,7 @@ v0.3.0 [Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) -▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2887,7 +2887,7 @@ v0.3.0 [Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) -▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2929,7 +2929,7 @@ v0.3.0 [Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) -▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -2971,7 +2971,7 @@ v0.3.0 [Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) -▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -3013,7 +3013,7 @@ v0.3.0 [Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) -▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -3055,7 +3055,7 @@ v0.3.0 [Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) -▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -3097,7 +3097,7 @@ v0.3.0 [Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) -▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -3139,7 +3139,7 @@ v0.3.0 [Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) -▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -3181,7 +3181,7 @@ v0.3.0 [Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once) -▸ **once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**once**(`event`, `listener`): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) #### Parameters @@ -3227,7 +3227,7 @@ ___ ### pause -▸ **pause**(): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) +**pause**(): [`PassThrough`](admin_discounts.internal.PassThrough.mdx) The `readable.pause()` method will cause a stream in flowing mode to stop emitting `'data'` events, switching out of flowing mode. Any data that @@ -3275,7 +3275,7 @@ ___ ### pipe -▸ **pipe**<`T`\>(`destination`, `options?`): `T` +**pipe**<`T`\>(`destination`, `options?`): `T` +`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> ```js import { on, EventEmitter } from 'node:events'; @@ -6336,7 +6336,7 @@ ___ ### once -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. @@ -6485,7 +6485,7 @@ v11.13.0, v10.16.0 [Transform](admin_discounts.internal.Transform.mdx).[once](admin_discounts.internal.Transform.mdx#once-1) -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> #### Parameters @@ -6557,7 +6557,7 @@ ___ ### setMaxListeners -▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` +`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` ```js import { setMaxListeners, EventEmitter } from 'node:events'; @@ -6616,7 +6616,7 @@ ___ ### toWeb -▸ `Static` **toWeb**(`streamDuplex`): { `readable`: [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> ; `writable`: [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> } +`Static` **toWeb**(`streamDuplex`): { `readable`: [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> ; `writable`: [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> } A utility method for creating a web `ReadableStream` and `WritableStream` from a `Duplex`. diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PaymentService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PaymentService.mdx index a1e7358528..9b5444f0db 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PaymentService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.PaymentService.mdx @@ -137,7 +137,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -162,7 +162,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -239,7 +239,7 @@ ___ ### capture -▸ **capture**(`paymentOrId`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> +**capture**(`paymentOrId`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> Captures a payment. @@ -284,7 +284,7 @@ ___ ### create -▸ **create**(`paymentInput`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> +**create**(`paymentInput`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> Created a new payment. @@ -329,7 +329,7 @@ ___ ### refund -▸ **refund**(`paymentOrId`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> +**refund**(`paymentOrId`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> refunds a payment. @@ -398,7 +398,7 @@ ___ ### retrieve -▸ **retrieve**(`paymentId`, `config?`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> +**retrieve**(`paymentId`, `config?`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> Retrieves a payment by id. @@ -451,7 +451,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -489,7 +489,7 @@ ___ ### update -▸ **update**(`paymentId`, `data`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> +**update**(`paymentId`, `data`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> Updates a payment in order to link it to an order or a swap. @@ -558,7 +558,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`PaymentService`](admin_discounts.internal.PaymentService.mdx) +**withTransaction**(`transactionManager?`): [`PaymentService`](admin_discounts.internal.PaymentService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Readable.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Readable.mdx index 096eeb8f5b..6f725a4138 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Readable.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Readable.mdx @@ -149,7 +149,7 @@ v0.9.4 ### [asyncIterator] -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> +**[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> #### Returns @@ -183,7 +183,7 @@ ___ ### \_construct -▸ `Optional` **_construct**(`callback`): `void` +`Optional` **_construct**(`callback`): `void` #### Parameters @@ -221,7 +221,7 @@ ___ ### \_destroy -▸ **_destroy**(`error`, `callback`): `void` +**_destroy**(`error`, `callback`): `void` #### Parameters @@ -267,7 +267,7 @@ ___ ### \_read -▸ **_read**(`size`): `void` +**_read**(`size`): `void` #### Parameters @@ -305,7 +305,7 @@ ___ ### addListener -▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) Event emitter The defined events on documents including: @@ -357,7 +357,7 @@ The defined events on documents including: [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -399,7 +399,7 @@ The defined events on documents including: [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -441,7 +441,7 @@ The defined events on documents including: [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -483,7 +483,7 @@ The defined events on documents including: [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -525,7 +525,7 @@ The defined events on documents including: [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -567,7 +567,7 @@ The defined events on documents including: [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -609,7 +609,7 @@ The defined events on documents including: [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[addListener](admin_discounts.internal.ReadableBase.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**addListener**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -655,7 +655,7 @@ ___ ### destroy -▸ **destroy**(`error?`): [`Readable`](admin_discounts.internal.Readable.mdx) +**destroy**(`error?`): [`Readable`](admin_discounts.internal.Readable.mdx) Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable stream will release any internal resources and subsequent calls to `push()`will be ignored. @@ -705,7 +705,7 @@ ___ ### emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -781,7 +781,7 @@ v0.1.26 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`, `chunk`): `boolean` +**emit**(`event`, `chunk`): `boolean` #### Parameters @@ -823,7 +823,7 @@ v0.1.26 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -857,7 +857,7 @@ v0.1.26 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`, `err`): `boolean` +**emit**(`event`, `err`): `boolean` #### Parameters @@ -899,7 +899,7 @@ v0.1.26 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -933,7 +933,7 @@ v0.1.26 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -967,7 +967,7 @@ v0.1.26 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1001,7 +1001,7 @@ v0.1.26 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[emit](admin_discounts.internal.ReadableBase.mdx#emit) -▸ **emit**(`event`, `...args`): `boolean` +**emit**(`event`, `...args`): `boolean` #### Parameters @@ -1047,7 +1047,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -1102,7 +1102,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.Readable.mdx#defaultmaxlisteners). @@ -1134,7 +1134,7 @@ ___ ### isPaused -▸ **isPaused**(): `boolean` +**isPaused**(): `boolean` The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most typical cases, there will be no reason to @@ -1177,7 +1177,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -1231,7 +1231,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -1283,7 +1283,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**off**(`eventName`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) Alias for `emitter.removeListener()`. @@ -1335,7 +1335,7 @@ ___ ### on -▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -1408,7 +1408,7 @@ v0.1.101 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -1450,7 +1450,7 @@ v0.1.101 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -1492,7 +1492,7 @@ v0.1.101 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -1534,7 +1534,7 @@ v0.1.101 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -1576,7 +1576,7 @@ v0.1.101 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -1618,7 +1618,7 @@ v0.1.101 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -1660,7 +1660,7 @@ v0.1.101 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[on](admin_discounts.internal.ReadableBase.mdx#on) -▸ **on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**on**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -1706,7 +1706,7 @@ ___ ### once -▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1777,7 +1777,7 @@ v0.3.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -1819,7 +1819,7 @@ v0.3.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -1861,7 +1861,7 @@ v0.3.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -1903,7 +1903,7 @@ v0.3.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -1945,7 +1945,7 @@ v0.3.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -1987,7 +1987,7 @@ v0.3.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -2029,7 +2029,7 @@ v0.3.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once) -▸ **once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) +**once**(`event`, `listener`): [`Readable`](admin_discounts.internal.Readable.mdx) #### Parameters @@ -2075,7 +2075,7 @@ ___ ### pause -▸ **pause**(): [`Readable`](admin_discounts.internal.Readable.mdx) +**pause**(): [`Readable`](admin_discounts.internal.Readable.mdx) The `readable.pause()` method will cause a stream in flowing mode to stop emitting `'data'` events, switching out of flowing mode. Any data that @@ -2123,7 +2123,7 @@ ___ ### pipe -▸ **pipe**<`T`\>(`destination`, `options?`): `T` +**pipe**<`T`\>(`destination`, `options?`): `T` +`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> ```js import { on, EventEmitter } from 'node:events'; @@ -4395,7 +4395,7 @@ ___ ### once -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. @@ -4544,7 +4544,7 @@ v11.13.0, v10.16.0 [ReadableBase](admin_discounts.internal.ReadableBase.mdx).[once](admin_discounts.internal.ReadableBase.mdx#once-1) -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> #### Parameters @@ -4616,7 +4616,7 @@ ___ ### setMaxListeners -▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` +`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` ```js import { setMaxListeners, EventEmitter } from 'node:events'; @@ -4675,7 +4675,7 @@ ___ ### toWeb -▸ `Static` **toWeb**(`streamReadable`): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> +`Static` **toWeb**(`streamReadable`): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> A utility method for creating a web `ReadableStream` from a `Readable`. diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReadableBase.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReadableBase.mdx index 18acd656c7..7d5d8eebd0 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReadableBase.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.ReadableBase.mdx @@ -164,7 +164,7 @@ v0.1.26 ### [asyncIterator] -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> +**[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> #### Returns @@ -198,7 +198,7 @@ ___ ### \_construct -▸ `Optional` **_construct**(`callback`): `void` +`Optional` **_construct**(`callback`): `void` #### Parameters @@ -232,7 +232,7 @@ ___ ### \_destroy -▸ **_destroy**(`error`, `callback`): `void` +**_destroy**(`error`, `callback`): `void` #### Parameters @@ -274,7 +274,7 @@ ___ ### \_read -▸ **_read**(`size`): `void` +**_read**(`size`): `void` #### Parameters @@ -308,7 +308,7 @@ ___ ### addListener -▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) Event emitter The defined events on documents including: @@ -364,7 +364,7 @@ The defined events on documents including: [Stream](admin_discounts.internal.Stream.mdx).[addListener](admin_discounts.internal.Stream.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -410,7 +410,7 @@ NodeJS.ReadableStream.addListener Stream.addListener -▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -456,7 +456,7 @@ NodeJS.ReadableStream.addListener Stream.addListener -▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -502,7 +502,7 @@ NodeJS.ReadableStream.addListener Stream.addListener -▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -548,7 +548,7 @@ NodeJS.ReadableStream.addListener Stream.addListener -▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -594,7 +594,7 @@ NodeJS.ReadableStream.addListener Stream.addListener -▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -640,7 +640,7 @@ NodeJS.ReadableStream.addListener Stream.addListener -▸ **addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**addListener**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -690,7 +690,7 @@ ___ ### destroy -▸ **destroy**(`error?`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**destroy**(`error?`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable stream will release any internal resources and subsequent calls to `push()`will be ignored. @@ -736,7 +736,7 @@ ___ ### emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -816,7 +816,7 @@ v0.1.26 [Stream](admin_discounts.internal.Stream.mdx).[emit](admin_discounts.internal.Stream.mdx#emit) -▸ **emit**(`event`, `chunk`): `boolean` +**emit**(`event`, `chunk`): `boolean` #### Parameters @@ -862,7 +862,7 @@ NodeJS.ReadableStream.emit Stream.emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -900,7 +900,7 @@ NodeJS.ReadableStream.emit Stream.emit -▸ **emit**(`event`, `err`): `boolean` +**emit**(`event`, `err`): `boolean` #### Parameters @@ -946,7 +946,7 @@ NodeJS.ReadableStream.emit Stream.emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -984,7 +984,7 @@ NodeJS.ReadableStream.emit Stream.emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1022,7 +1022,7 @@ NodeJS.ReadableStream.emit Stream.emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1060,7 +1060,7 @@ NodeJS.ReadableStream.emit Stream.emit -▸ **emit**(`event`, `...args`): `boolean` +**emit**(`event`, `...args`): `boolean` #### Parameters @@ -1110,7 +1110,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -1169,7 +1169,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.ReadableBase.mdx#defaultmaxlisteners). @@ -1205,7 +1205,7 @@ ___ ### isPaused -▸ **isPaused**(): `boolean` +**isPaused**(): `boolean` The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most typical cases, there will be no reason to @@ -1248,7 +1248,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -1306,7 +1306,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -1362,7 +1362,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**off**(`eventName`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) Alias for `emitter.removeListener()`. @@ -1418,7 +1418,7 @@ ___ ### on -▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -1495,7 +1495,7 @@ v0.1.101 [Stream](admin_discounts.internal.Stream.mdx).[on](admin_discounts.internal.Stream.mdx#on) -▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -1541,7 +1541,7 @@ NodeJS.ReadableStream.on Stream.on -▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -1587,7 +1587,7 @@ NodeJS.ReadableStream.on Stream.on -▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -1633,7 +1633,7 @@ NodeJS.ReadableStream.on Stream.on -▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -1679,7 +1679,7 @@ NodeJS.ReadableStream.on Stream.on -▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -1725,7 +1725,7 @@ NodeJS.ReadableStream.on Stream.on -▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -1771,7 +1771,7 @@ NodeJS.ReadableStream.on Stream.on -▸ **on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**on**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -1821,7 +1821,7 @@ ___ ### once -▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1896,7 +1896,7 @@ v0.3.0 [Stream](admin_discounts.internal.Stream.mdx).[once](admin_discounts.internal.Stream.mdx#once) -▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -1942,7 +1942,7 @@ NodeJS.ReadableStream.once Stream.once -▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -1988,7 +1988,7 @@ NodeJS.ReadableStream.once Stream.once -▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -2034,7 +2034,7 @@ NodeJS.ReadableStream.once Stream.once -▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -2080,7 +2080,7 @@ NodeJS.ReadableStream.once Stream.once -▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -2126,7 +2126,7 @@ NodeJS.ReadableStream.once Stream.once -▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -2172,7 +2172,7 @@ NodeJS.ReadableStream.once Stream.once -▸ **once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**once**(`event`, `listener`): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) #### Parameters @@ -2222,7 +2222,7 @@ ___ ### pause -▸ **pause**(): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) +**pause**(): [`ReadableBase`](admin_discounts.internal.ReadableBase.mdx) The `readable.pause()` method will cause a stream in flowing mode to stop emitting `'data'` events, switching out of flowing mode. Any data that @@ -2270,7 +2270,7 @@ ___ ### pipe -▸ **pipe**<`T`\>(`destination`, `options?`): `T` +**pipe**<`T`\>(`destination`, `options?`): `T` +`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> ```js import { on, EventEmitter } from 'node:events'; @@ -4594,7 +4594,7 @@ ___ ### once -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. @@ -4743,7 +4743,7 @@ v11.13.0, v10.16.0 [Stream](admin_discounts.internal.Stream.mdx).[once](admin_discounts.internal.Stream.mdx#once-1) -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> #### Parameters @@ -4815,7 +4815,7 @@ ___ ### setMaxListeners -▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` +`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` ```js import { setMaxListeners, EventEmitter } from 'node:events'; diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Socket.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Socket.mdx index 90a9d464f7..89fe51505a 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Socket.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Socket.mdx @@ -337,7 +337,7 @@ v0.3.4 ### [asyncIterator] -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> +**[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> #### Returns @@ -371,7 +371,7 @@ ___ ### \_construct -▸ `Optional` **_construct**(`callback`): `void` +`Optional` **_construct**(`callback`): `void` #### Parameters @@ -409,7 +409,7 @@ ___ ### \_destroy -▸ **_destroy**(`error`, `callback`): `void` +**_destroy**(`error`, `callback`): `void` #### Parameters @@ -455,7 +455,7 @@ ___ ### \_final -▸ **_final**(`callback`): `void` +**_final**(`callback`): `void` #### Parameters @@ -493,7 +493,7 @@ ___ ### \_read -▸ **_read**(`size`): `void` +**_read**(`size`): `void` #### Parameters @@ -531,7 +531,7 @@ ___ ### \_write -▸ **_write**(`chunk`, `encoding`, `callback`): `void` +**_write**(`chunk`, `encoding`, `callback`): `void` #### Parameters @@ -585,7 +585,7 @@ ___ ### \_writev -▸ `Optional` **_writev**(`chunks`, `callback`): `void` +`Optional` **_writev**(`chunks`, `callback`): `void` #### Parameters @@ -631,7 +631,7 @@ ___ ### addListener -▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) events.EventEmitter 1. close @@ -684,7 +684,7 @@ events.EventEmitter [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -726,7 +726,7 @@ events.EventEmitter [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -768,7 +768,7 @@ events.EventEmitter [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -810,7 +810,7 @@ events.EventEmitter [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -852,7 +852,7 @@ events.EventEmitter [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -894,7 +894,7 @@ events.EventEmitter [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -936,7 +936,7 @@ events.EventEmitter [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -978,7 +978,7 @@ events.EventEmitter [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -1020,7 +1020,7 @@ events.EventEmitter [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**addListener**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -1066,7 +1066,7 @@ ___ ### address -▸ **address**(): {} \| [`AddressInfo`](../interfaces/admin_discounts.internal.AddressInfo.mdx) +**address**(): {} \| [`AddressInfo`](../interfaces/admin_discounts.internal.AddressInfo.mdx) Returns the bound `address`, the address `family` name and `port` of the socket as reported by the operating system:`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }` @@ -1094,7 +1094,7 @@ ___ ### connect -▸ **connect**(`options`, `connectionListener?`): [`Socket`](admin_discounts.internal.Socket.mdx) +**connect**(`options`, `connectionListener?`): [`Socket`](admin_discounts.internal.Socket.mdx) Initiate a connection on a given socket. @@ -1150,7 +1150,7 @@ behavior. } ]} /> -▸ **connect**(`port`, `host`, `connectionListener?`): [`Socket`](admin_discounts.internal.Socket.mdx) +**connect**(`port`, `host`, `connectionListener?`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -1196,7 +1196,7 @@ behavior. } ]} /> -▸ **connect**(`port`, `connectionListener?`): [`Socket`](admin_discounts.internal.Socket.mdx) +**connect**(`port`, `connectionListener?`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -1234,7 +1234,7 @@ behavior. } ]} /> -▸ **connect**(`path`, `connectionListener?`): [`Socket`](admin_discounts.internal.Socket.mdx) +**connect**(`path`, `connectionListener?`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -1276,7 +1276,7 @@ ___ ### cork -▸ **cork**(): `void` +**cork**(): `void` The `writable.cork()` method forces all written data to be buffered in memory. The buffered data will be flushed when either the [uncork](admin_discounts.internal.WritableBase.mdx#uncork) or [end](admin_discounts.internal.WritableBase.mdx#end) methods are called. @@ -1317,7 +1317,7 @@ ___ ### destroy -▸ **destroy**(`error?`): [`Socket`](admin_discounts.internal.Socket.mdx) +**destroy**(`error?`): [`Socket`](admin_discounts.internal.Socket.mdx) Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable stream will release any internal resources and subsequent calls to `push()`will be ignored. @@ -1367,7 +1367,7 @@ ___ ### emit -▸ **emit**(`event`, `...args`): `boolean` +**emit**(`event`, `...args`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -1451,7 +1451,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`, `hadError`): `boolean` +**emit**(`event`, `hadError`): `boolean` #### Parameters @@ -1493,7 +1493,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1527,7 +1527,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`, `data`): `boolean` +**emit**(`event`, `data`): `boolean` #### Parameters @@ -1569,7 +1569,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1603,7 +1603,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1637,7 +1637,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`, `err`): `boolean` +**emit**(`event`, `err`): `boolean` #### Parameters @@ -1679,7 +1679,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`, `err`, `address`, `family`, `host`): `boolean` +**emit**(`event`, `err`, `address`, `family`, `host`): `boolean` #### Parameters @@ -1745,7 +1745,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1779,7 +1779,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1817,7 +1817,7 @@ ___ ### end -▸ **end**(`callback?`): [`Socket`](admin_discounts.internal.Socket.mdx) +**end**(`callback?`): [`Socket`](admin_discounts.internal.Socket.mdx) Half-closes the socket. i.e., it sends a FIN packet. It is possible the server will still send some data. @@ -1860,7 +1860,7 @@ v0.1.90 [Duplex](admin_discounts.internal.Duplex.mdx).[end](admin_discounts.internal.Duplex.mdx#end) -▸ **end**(`buffer`, `callback?`): [`Socket`](admin_discounts.internal.Socket.mdx) +**end**(`buffer`, `callback?`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -1902,7 +1902,7 @@ v0.1.90 [Duplex](admin_discounts.internal.Duplex.mdx).[end](admin_discounts.internal.Duplex.mdx#end) -▸ **end**(`str`, `encoding?`, `callback?`): [`Socket`](admin_discounts.internal.Socket.mdx) +**end**(`str`, `encoding?`, `callback?`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -1956,7 +1956,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -2011,7 +2011,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.Socket.mdx#defaultmaxlisteners). @@ -2043,7 +2043,7 @@ ___ ### isPaused -▸ **isPaused**(): `boolean` +**isPaused**(): `boolean` The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most typical cases, there will be no reason to @@ -2086,7 +2086,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -2140,7 +2140,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -2192,7 +2192,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**off**(`eventName`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) Alias for `emitter.removeListener()`. @@ -2244,7 +2244,7 @@ ___ ### on -▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -2317,7 +2317,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -2359,7 +2359,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -2401,7 +2401,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -2443,7 +2443,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -2485,7 +2485,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -2527,7 +2527,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -2569,7 +2569,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -2611,7 +2611,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -2653,7 +2653,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**on**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -2699,7 +2699,7 @@ ___ ### once -▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -2770,7 +2770,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -2812,7 +2812,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -2854,7 +2854,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -2896,7 +2896,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -2938,7 +2938,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -2980,7 +2980,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -3022,7 +3022,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -3064,7 +3064,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -3106,7 +3106,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) +**once**(`event`, `listener`): [`Socket`](admin_discounts.internal.Socket.mdx) #### Parameters @@ -3152,7 +3152,7 @@ ___ ### pause -▸ **pause**(): [`Socket`](admin_discounts.internal.Socket.mdx) +**pause**(): [`Socket`](admin_discounts.internal.Socket.mdx) Pauses the reading of data. That is, `'data'` events will not be emitted. Useful to throttle back an upload. @@ -3180,7 +3180,7 @@ ___ ### pipe -▸ **pipe**<`T`\>(`destination`, `options?`): `T` +**pipe**<`T`\>(`destination`, `options?`): `T` +`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> ```js import { on, EventEmitter } from 'node:events'; @@ -6258,7 +6258,7 @@ ___ ### once -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. @@ -6407,7 +6407,7 @@ v11.13.0, v10.16.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once-1) -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> #### Parameters @@ -6479,7 +6479,7 @@ ___ ### setMaxListeners -▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` +`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` ```js import { setMaxListeners, EventEmitter } from 'node:events'; @@ -6538,7 +6538,7 @@ ___ ### toWeb -▸ `Static` **toWeb**(`streamDuplex`): { `readable`: [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> ; `writable`: [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> } +`Static` **toWeb**(`streamDuplex`): { `readable`: [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> ; `writable`: [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> } A utility method for creating a web `ReadableStream` and `WritableStream` from a `Duplex`. diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Stream.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Stream.mdx index 056874142e..518ca20ebe 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Stream.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Stream.mdx @@ -64,7 +64,7 @@ v0.1.26 ### addListener -▸ **addListener**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) +**addListener**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) Alias for `emitter.on(eventName, listener)`. @@ -116,7 +116,7 @@ ___ ### emit -▸ **emit**(`eventName`, `...args`): `boolean` +**emit**(`eventName`, `...args`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -204,7 +204,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -259,7 +259,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.Stream.mdx#defaultmaxlisteners). @@ -291,7 +291,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -345,7 +345,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -397,7 +397,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) +**off**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) Alias for `emitter.removeListener()`. @@ -449,7 +449,7 @@ ___ ### on -▸ **on**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) +**on**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -526,7 +526,7 @@ ___ ### once -▸ **once**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) +**once**(`eventName`, `listener`): [`Stream`](admin_discounts.internal.Stream.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -601,7 +601,7 @@ ___ ### pipe -▸ **pipe**<`T`\>(`destination`, `options?`): `T` +**pipe**<`T`\>(`destination`, `options?`): `T` +`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> ```js import { on, EventEmitter } from 'node:events'; @@ -1343,7 +1343,7 @@ ___ ### once -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. @@ -1492,7 +1492,7 @@ v11.13.0, v10.16.0 [internal](admin_discounts.internal.internal-5.mdx).[once](admin_discounts.internal.internal-5.mdx#once-1) -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> #### Parameters @@ -1564,7 +1564,7 @@ ___ ### setMaxListeners -▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` +`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` ```js import { setMaxListeners, EventEmitter } from 'node:events'; diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Transform.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Transform.mdx index ed17274f0b..793431904a 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Transform.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.Transform.mdx @@ -230,7 +230,7 @@ v0.9.4 ### [asyncIterator] -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> +**[asyncIterator]**(): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> #### Returns @@ -264,7 +264,7 @@ ___ ### \_construct -▸ `Optional` **_construct**(`callback`): `void` +`Optional` **_construct**(`callback`): `void` #### Parameters @@ -302,7 +302,7 @@ ___ ### \_destroy -▸ **_destroy**(`error`, `callback`): `void` +**_destroy**(`error`, `callback`): `void` #### Parameters @@ -348,7 +348,7 @@ ___ ### \_final -▸ **_final**(`callback`): `void` +**_final**(`callback`): `void` #### Parameters @@ -386,7 +386,7 @@ ___ ### \_flush -▸ **_flush**(`callback`): `void` +**_flush**(`callback`): `void` #### Parameters @@ -420,7 +420,7 @@ ___ ### \_read -▸ **_read**(`size`): `void` +**_read**(`size`): `void` #### Parameters @@ -458,7 +458,7 @@ ___ ### \_transform -▸ **_transform**(`chunk`, `encoding`, `callback`): `void` +**_transform**(`chunk`, `encoding`, `callback`): `void` #### Parameters @@ -508,7 +508,7 @@ ___ ### \_write -▸ **_write**(`chunk`, `encoding`, `callback`): `void` +**_write**(`chunk`, `encoding`, `callback`): `void` #### Parameters @@ -562,7 +562,7 @@ ___ ### \_writev -▸ `Optional` **_writev**(`chunks`, `callback`): `void` +`Optional` **_writev**(`chunks`, `callback`): `void` #### Parameters @@ -608,7 +608,7 @@ ___ ### addListener -▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) Event emitter The defined events on documents including: @@ -664,7 +664,7 @@ The defined events on documents including: [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -706,7 +706,7 @@ The defined events on documents including: [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -748,7 +748,7 @@ The defined events on documents including: [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -790,7 +790,7 @@ The defined events on documents including: [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -832,7 +832,7 @@ The defined events on documents including: [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -874,7 +874,7 @@ The defined events on documents including: [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -916,7 +916,7 @@ The defined events on documents including: [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -958,7 +958,7 @@ The defined events on documents including: [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -1000,7 +1000,7 @@ The defined events on documents including: [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -1042,7 +1042,7 @@ The defined events on documents including: [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -1084,7 +1084,7 @@ The defined events on documents including: [Duplex](admin_discounts.internal.Duplex.mdx).[addListener](admin_discounts.internal.Duplex.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**addListener**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -1130,7 +1130,7 @@ ___ ### cork -▸ **cork**(): `void` +**cork**(): `void` The `writable.cork()` method forces all written data to be buffered in memory. The buffered data will be flushed when either the [uncork](admin_discounts.internal.WritableBase.mdx#uncork) or [end](admin_discounts.internal.WritableBase.mdx#end) methods are called. @@ -1171,7 +1171,7 @@ ___ ### destroy -▸ **destroy**(`error?`): [`Transform`](admin_discounts.internal.Transform.mdx) +**destroy**(`error?`): [`Transform`](admin_discounts.internal.Transform.mdx) Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable stream will release any internal resources and subsequent calls to `push()`will be ignored. @@ -1221,7 +1221,7 @@ ___ ### emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -1297,7 +1297,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`, `chunk`): `boolean` +**emit**(`event`, `chunk`): `boolean` #### Parameters @@ -1339,7 +1339,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1373,7 +1373,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1407,7 +1407,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`, `err`): `boolean` +**emit**(`event`, `err`): `boolean` #### Parameters @@ -1449,7 +1449,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1483,7 +1483,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1517,7 +1517,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`, `src`): `boolean` +**emit**(`event`, `src`): `boolean` #### Parameters @@ -1559,7 +1559,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1593,7 +1593,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1627,7 +1627,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`, `src`): `boolean` +**emit**(`event`, `src`): `boolean` #### Parameters @@ -1669,7 +1669,7 @@ v0.1.26 [Duplex](admin_discounts.internal.Duplex.mdx).[emit](admin_discounts.internal.Duplex.mdx#emit) -▸ **emit**(`event`, `...args`): `boolean` +**emit**(`event`, `...args`): `boolean` #### Parameters @@ -1715,7 +1715,7 @@ ___ ### end -▸ **end**(`cb?`): [`Transform`](admin_discounts.internal.Transform.mdx) +**end**(`cb?`): [`Transform`](admin_discounts.internal.Transform.mdx) Calling the `writable.end()` method signals that no more data will be written to the `Writable`. The optional `chunk` and `encoding` arguments allow one @@ -1769,7 +1769,7 @@ v0.9.4 [Duplex](admin_discounts.internal.Duplex.mdx).[end](admin_discounts.internal.Duplex.mdx#end) -▸ **end**(`chunk`, `cb?`): [`Transform`](admin_discounts.internal.Transform.mdx) +**end**(`chunk`, `cb?`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -1811,7 +1811,7 @@ v0.9.4 [Duplex](admin_discounts.internal.Duplex.mdx).[end](admin_discounts.internal.Duplex.mdx#end) -▸ **end**(`chunk`, `encoding?`, `cb?`): [`Transform`](admin_discounts.internal.Transform.mdx) +**end**(`chunk`, `encoding?`, `cb?`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -1865,7 +1865,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -1920,7 +1920,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.Transform.mdx#defaultmaxlisteners). @@ -1952,7 +1952,7 @@ ___ ### isPaused -▸ **isPaused**(): `boolean` +**isPaused**(): `boolean` The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most typical cases, there will be no reason to @@ -1995,7 +1995,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -2049,7 +2049,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -2101,7 +2101,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**off**(`eventName`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) Alias for `emitter.removeListener()`. @@ -2153,7 +2153,7 @@ ___ ### on -▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -2226,7 +2226,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2268,7 +2268,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2310,7 +2310,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2352,7 +2352,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2394,7 +2394,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2436,7 +2436,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2478,7 +2478,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2520,7 +2520,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2562,7 +2562,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2604,7 +2604,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2646,7 +2646,7 @@ v0.1.101 [Duplex](admin_discounts.internal.Duplex.mdx).[on](admin_discounts.internal.Duplex.mdx#on) -▸ **on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**on**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2692,7 +2692,7 @@ ___ ### once -▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -2763,7 +2763,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2805,7 +2805,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2847,7 +2847,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2889,7 +2889,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2931,7 +2931,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -2973,7 +2973,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -3015,7 +3015,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -3057,7 +3057,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -3099,7 +3099,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -3141,7 +3141,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -3183,7 +3183,7 @@ v0.3.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once) -▸ **once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) +**once**(`event`, `listener`): [`Transform`](admin_discounts.internal.Transform.mdx) #### Parameters @@ -3229,7 +3229,7 @@ ___ ### pause -▸ **pause**(): [`Transform`](admin_discounts.internal.Transform.mdx) +**pause**(): [`Transform`](admin_discounts.internal.Transform.mdx) The `readable.pause()` method will cause a stream in flowing mode to stop emitting `'data'` events, switching out of flowing mode. Any data that @@ -3277,7 +3277,7 @@ ___ ### pipe -▸ **pipe**<`T`\>(`destination`, `options?`): `T` +**pipe**<`T`\>(`destination`, `options?`): `T` +`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> ```js import { on, EventEmitter } from 'node:events'; @@ -6338,7 +6338,7 @@ ___ ### once -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. @@ -6487,7 +6487,7 @@ v11.13.0, v10.16.0 [Duplex](admin_discounts.internal.Duplex.mdx).[once](admin_discounts.internal.Duplex.mdx#once-1) -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> #### Parameters @@ -6559,7 +6559,7 @@ ___ ### setMaxListeners -▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` +`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` ```js import { setMaxListeners, EventEmitter } from 'node:events'; @@ -6618,7 +6618,7 @@ ___ ### toWeb -▸ `Static` **toWeb**(`streamDuplex`): { `readable`: [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> ; `writable`: [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> } +`Static` **toWeb**(`streamDuplex`): { `readable`: [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`any`\> ; `writable`: [`WritableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestream)<`any`\> } A utility method for creating a web `ReadableStream` and `WritableStream` from a `Duplex`. diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.WritableBase.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.WritableBase.mdx index 9241f35ebb..3405af0fe1 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.WritableBase.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.WritableBase.mdx @@ -160,7 +160,7 @@ v0.1.26 ### \_construct -▸ `Optional` **_construct**(`callback`): `void` +`Optional` **_construct**(`callback`): `void` #### Parameters @@ -194,7 +194,7 @@ ___ ### \_destroy -▸ **_destroy**(`error`, `callback`): `void` +**_destroy**(`error`, `callback`): `void` #### Parameters @@ -236,7 +236,7 @@ ___ ### \_final -▸ **_final**(`callback`): `void` +**_final**(`callback`): `void` #### Parameters @@ -270,7 +270,7 @@ ___ ### \_write -▸ **_write**(`chunk`, `encoding`, `callback`): `void` +**_write**(`chunk`, `encoding`, `callback`): `void` #### Parameters @@ -320,7 +320,7 @@ ___ ### \_writev -▸ `Optional` **_writev**(`chunks`, `callback`): `void` +`Optional` **_writev**(`chunks`, `callback`): `void` #### Parameters @@ -362,7 +362,7 @@ ___ ### addListener -▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) Event emitter The defined events on documents including: @@ -417,7 +417,7 @@ The defined events on documents including: [Stream](admin_discounts.internal.Stream.mdx).[addListener](admin_discounts.internal.Stream.mdx#addlistener) -▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -463,7 +463,7 @@ NodeJS.WritableStream.addListener Stream.addListener -▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -509,7 +509,7 @@ NodeJS.WritableStream.addListener Stream.addListener -▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -555,7 +555,7 @@ NodeJS.WritableStream.addListener Stream.addListener -▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -601,7 +601,7 @@ NodeJS.WritableStream.addListener Stream.addListener -▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -647,7 +647,7 @@ NodeJS.WritableStream.addListener Stream.addListener -▸ **addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**addListener**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -697,7 +697,7 @@ ___ ### cork -▸ **cork**(): `void` +**cork**(): `void` The `writable.cork()` method forces all written data to be buffered in memory. The buffered data will be flushed when either the [uncork](admin_discounts.internal.WritableBase.mdx#uncork) or [end](admin_discounts.internal.WritableBase.mdx#end) methods are called. @@ -734,7 +734,7 @@ ___ ### destroy -▸ **destroy**(`error?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**destroy**(`error?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the writable stream has ended and subsequent calls to `write()` or `end()` will result in @@ -785,7 +785,7 @@ ___ ### emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -865,7 +865,7 @@ v0.1.26 [Stream](admin_discounts.internal.Stream.mdx).[emit](admin_discounts.internal.Stream.mdx#emit) -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -903,7 +903,7 @@ NodeJS.WritableStream.emit Stream.emit -▸ **emit**(`event`, `err`): `boolean` +**emit**(`event`, `err`): `boolean` #### Parameters @@ -949,7 +949,7 @@ NodeJS.WritableStream.emit Stream.emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -987,7 +987,7 @@ NodeJS.WritableStream.emit Stream.emit -▸ **emit**(`event`, `src`): `boolean` +**emit**(`event`, `src`): `boolean` #### Parameters @@ -1033,7 +1033,7 @@ NodeJS.WritableStream.emit Stream.emit -▸ **emit**(`event`, `src`): `boolean` +**emit**(`event`, `src`): `boolean` #### Parameters @@ -1079,7 +1079,7 @@ NodeJS.WritableStream.emit Stream.emit -▸ **emit**(`event`, `...args`): `boolean` +**emit**(`event`, `...args`): `boolean` #### Parameters @@ -1129,7 +1129,7 @@ ___ ### end -▸ **end**(`cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**end**(`cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) Calling the `writable.end()` method signals that no more data will be written to the `Writable`. The optional `chunk` and `encoding` arguments allow one @@ -1183,7 +1183,7 @@ v0.9.4 [WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[end](../interfaces/admin_discounts.internal.WritableStream.mdx#end) -▸ **end**(`chunk`, `cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**end**(`chunk`, `cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -1225,7 +1225,7 @@ v0.9.4 [WritableStream](../interfaces/admin_discounts.internal.WritableStream.mdx).[end](../interfaces/admin_discounts.internal.WritableStream.mdx#end) -▸ **end**(`chunk`, `encoding`, `cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**end**(`chunk`, `encoding`, `cb?`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -1279,7 +1279,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -1338,7 +1338,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.WritableBase.mdx#defaultmaxlisteners). @@ -1374,7 +1374,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -1432,7 +1432,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -1488,7 +1488,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**off**(`eventName`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) Alias for `emitter.removeListener()`. @@ -1544,7 +1544,7 @@ ___ ### on -▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -1621,7 +1621,7 @@ v0.1.101 [Stream](admin_discounts.internal.Stream.mdx).[on](admin_discounts.internal.Stream.mdx#on) -▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -1667,7 +1667,7 @@ NodeJS.WritableStream.on Stream.on -▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -1713,7 +1713,7 @@ NodeJS.WritableStream.on Stream.on -▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -1759,7 +1759,7 @@ NodeJS.WritableStream.on Stream.on -▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -1805,7 +1805,7 @@ NodeJS.WritableStream.on Stream.on -▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -1851,7 +1851,7 @@ NodeJS.WritableStream.on Stream.on -▸ **on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**on**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -1901,7 +1901,7 @@ ___ ### once -▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1976,7 +1976,7 @@ v0.3.0 [Stream](admin_discounts.internal.Stream.mdx).[once](admin_discounts.internal.Stream.mdx#once) -▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -2022,7 +2022,7 @@ NodeJS.WritableStream.once Stream.once -▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -2068,7 +2068,7 @@ NodeJS.WritableStream.once Stream.once -▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -2114,7 +2114,7 @@ NodeJS.WritableStream.once Stream.once -▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -2160,7 +2160,7 @@ NodeJS.WritableStream.once Stream.once -▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -2206,7 +2206,7 @@ NodeJS.WritableStream.once Stream.once -▸ **once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) +**once**(`event`, `listener`): [`WritableBase`](admin_discounts.internal.WritableBase.mdx) #### Parameters @@ -2256,7 +2256,7 @@ ___ ### pipe -▸ **pipe**<`T`\>(`destination`, `options?`): `T` +**pipe**<`T`\>(`destination`, `options?`): `T` +`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> ```js import { on, EventEmitter } from 'node:events'; @@ -4095,7 +4095,7 @@ ___ ### once -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. @@ -4244,7 +4244,7 @@ v11.13.0, v10.16.0 [Stream](admin_discounts.internal.Stream.mdx).[once](admin_discounts.internal.Stream.mdx#once-1) -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> #### Parameters @@ -4316,7 +4316,7 @@ ___ ### setMaxListeners -▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` +`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` ```js import { setMaxListeners, EventEmitter } from 'node:events'; diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal-5.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal-5.mdx index 5f67d34c5f..381269f70c 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal-5.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal-5.mdx @@ -64,7 +64,7 @@ v0.1.26 ### addListener -▸ **addListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) +**addListener**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) Alias for `emitter.on(eventName, listener)`. @@ -116,7 +116,7 @@ ___ ### emit -▸ **emit**(`eventName`, `...args`): `boolean` +**emit**(`eventName`, `...args`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -204,7 +204,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -259,7 +259,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to [defaultMaxListeners](admin_discounts.internal.internal-5.mdx#defaultmaxlisteners). @@ -291,7 +291,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -345,7 +345,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -397,7 +397,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) +**off**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) Alias for `emitter.removeListener()`. @@ -449,7 +449,7 @@ ___ ### on -▸ **on**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) +**on**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -526,7 +526,7 @@ ___ ### once -▸ **once**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) +**once**(`eventName`, `listener`): [`internal`](admin_discounts.internal.internal-5.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -601,7 +601,7 @@ ___ ### pipe -▸ **pipe**<`T`\>(`destination`, `options?`): `T` +**pipe**<`T`\>(`destination`, `options?`): `T` +`Static` **on**(`emitter`, `eventName`, `options?`): [`AsyncIterableIterator`](../interfaces/admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> ```js import { on, EventEmitter } from 'node:events'; @@ -1339,7 +1339,7 @@ ___ ### once -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> Creates a `Promise` that is fulfilled when the `EventEmitter` emits the given event or that is rejected if the `EventEmitter` emits `'error'` while waiting. @@ -1488,7 +1488,7 @@ v11.13.0, v10.16.0 [EventEmitter](admin_discounts.internal.EventEmitter-1.mdx).[once](admin_discounts.internal.EventEmitter-1.mdx#once-1) -▸ `Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> +`Static` **once**(`emitter`, `eventName`, `options?`): `Promise`<`any`[]\> #### Parameters @@ -1560,7 +1560,7 @@ ___ ### setMaxListeners -▸ `Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` +`Static` **setMaxListeners**(`n?`, `...eventTargets`): `void` ```js import { setMaxListeners, EventEmitter } from 'node:events'; diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx index ba99ea4f4a..0b81d8bac1 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx @@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -114,7 +114,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -195,7 +195,7 @@ ___ ### buildTemplate -▸ `Abstract` **buildTemplate**(): `Promise`<`string`\> +`Abstract` **buildTemplate**(): `Promise`<`string`\> Builds and returns a template file that can be downloaded and filled in @@ -231,7 +231,7 @@ ___ ### handleProcessingError -▸ `Protected` **handleProcessingError**<`T`\>(`batchJobId`, `err`, `result`): `Promise`<`void`\> +`Protected` **handleProcessingError**<`T`\>(`batchJobId`, `err`, `result`): `Promise`<`void`\> +**preProcessBatchJob**(`batchJobId`): `Promise`<`void`\> Method for pre-processing a batch job @@ -332,7 +332,7 @@ ___ ### prepareBatchJobForProcessing -▸ **prepareBatchJobForProcessing**(`batchJob`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\> +**prepareBatchJobForProcessing**(`batchJob`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\> Method for preparing a batch job for processing @@ -389,7 +389,7 @@ ___ ### processJob -▸ `Abstract` **processJob**(`batchJobId`): `Promise`<`void`\> +`Abstract` **processJob**(`batchJobId`): `Promise`<`void`\> Method does the actual processing of the job. Should report back on the progress of the operation. @@ -429,7 +429,7 @@ ___ ### shouldRetryOnProcessingError -▸ `Protected` **shouldRetryOnProcessingError**(`batchJob`, `err`): `Promise`<`boolean`\> +`Protected` **shouldRetryOnProcessingError**(`batchJob`, `err`): `Promise`<`boolean`\> #### Parameters @@ -480,7 +480,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -522,7 +522,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`AbstractBatchJobStrategy`](admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx) +**withTransaction**(`transactionManager?`): [`AbstractBatchJobStrategy`](admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx index cde2ff96ee..24785a9989 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx @@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -86,7 +86,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -163,7 +163,7 @@ ___ ### complete -▸ `Abstract` **complete**(`cartId`, `idempotencyKey`, `context`): `Promise`<[`CartCompletionResponse`](../modules/admin_discounts.internal.internal.mdx#cartcompletionresponse)\> +`Abstract` **complete**(`cartId`, `idempotencyKey`, `context`): `Promise`<[`CartCompletionResponse`](../modules/admin_discounts.internal.internal.mdx#cartcompletionresponse)\> Takes a cart id and completes the cart. This for example takes place when creating an order or confirming a swap. @@ -229,7 +229,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -267,7 +267,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`AbstractCartCompletionStrategy`](admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx) +**withTransaction**(`transactionManager?`): [`AbstractCartCompletionStrategy`](admin_discounts.internal.internal.AbstractCartCompletionStrategy.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFileService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFileService.mdx index b841207b93..b348b8e4a9 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFileService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFileService.mdx @@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -90,7 +90,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -171,7 +171,7 @@ ___ ### delete -▸ `Abstract` **delete**(`fileData`): `Promise`<`void`\> +`Abstract` **delete**(`fileData`): `Promise`<`void`\> remove file from fileservice @@ -211,7 +211,7 @@ ___ ### getDownloadStream -▸ `Abstract` **getDownloadStream**(`fileData`): `Promise`<[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx)\> +`Abstract` **getDownloadStream**(`fileData`): `Promise`<[`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx)\> download file from fileservice as stream @@ -260,7 +260,7 @@ ___ ### getPresignedDownloadUrl -▸ `Abstract` **getPresignedDownloadUrl**(`fileData`): `Promise`<`string`\> +`Abstract` **getPresignedDownloadUrl**(`fileData`): `Promise`<`string`\> Generate a presigned download url to obtain a file @@ -309,7 +309,7 @@ ___ ### getUploadStreamDescriptor -▸ `Abstract` **getUploadStreamDescriptor**(`fileData`): `Promise`<[`FileServiceGetUploadStreamResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileservicegetuploadstreamresult)\> +`Abstract` **getUploadStreamDescriptor**(`fileData`): `Promise`<[`FileServiceGetUploadStreamResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileservicegetuploadstreamresult)\> upload file to fileservice from stream @@ -358,7 +358,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -400,7 +400,7 @@ ___ ### upload -▸ `Abstract` **upload**(`fileData`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> +`Abstract` **upload**(`fileData`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> upload file to fileservice @@ -449,7 +449,7 @@ ___ ### uploadProtected -▸ `Abstract` **uploadProtected**(`fileData`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> +`Abstract` **uploadProtected**(`fileData`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> upload private file to fileservice @@ -498,7 +498,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`AbstractFileService`](admin_discounts.internal.internal.AbstractFileService.mdx) +**withTransaction**(`transactionManager?`): [`AbstractFileService`](admin_discounts.internal.internal.AbstractFileService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFulfillmentService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFulfillmentService.mdx index 9e5f6a43a7..9b3f701bae 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFulfillmentService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractFulfillmentService.mdx @@ -48,7 +48,7 @@ Fullfillment provider plugin services should extend the AbstractFulfillmentServi ### calculatePrice -▸ `Abstract` **calculatePrice**(`optionData`, `data`, `cart`): `Promise`<`number`\> +`Abstract` **calculatePrice**(`optionData`, `data`, `cart`): `Promise`<`number`\> Used to calculate a price for a given shipping option. @@ -113,7 +113,7 @@ ___ ### canCalculate -▸ `Abstract` **canCalculate**(`data`): `Promise`<`boolean`\> +`Abstract` **canCalculate**(`data`): `Promise`<`boolean`\> Used to determine if a shipping option can have a calculated price @@ -162,7 +162,7 @@ ___ ### cancelFulfillment -▸ `Abstract` **cancelFulfillment**(`fulfillment`): `Promise`<`any`\> +`Abstract` **cancelFulfillment**(`fulfillment`): `Promise`<`any`\> Cancel a fulfillment using data from the fulfillment @@ -211,7 +211,7 @@ ___ ### createFulfillment -▸ `Abstract` **createFulfillment**(`data`, `items`, `order`, `fulfillment`): `Promise`<[`FulfillmentProviderData`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentproviderdata)\> +`Abstract` **createFulfillment**(`data`, `items`, `order`, `fulfillment`): `Promise`<[`FulfillmentProviderData`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentproviderdata)\> Create a fulfillment using data from shipping method, line items, and fulfillment. All from the order. The returned value of this method will populate the `fulfillment.data` field. @@ -285,7 +285,7 @@ ___ ### createReturn -▸ `Abstract` **createReturn**(`returnOrder`): `Promise`\> +`Abstract` **createReturn**(`returnOrder`): `Promise`\> Used to create a return order. Should return the data necessary for future operations on the return; in particular the data may be used to receive @@ -353,7 +353,7 @@ ___ ### getFulfillmentDocuments -▸ `Abstract` **getFulfillmentDocuments**(`data`): `Promise`<`any`\> +`Abstract` **getFulfillmentDocuments**(`data`): `Promise`<`any`\> Used to retrieve documents associated with a fulfillment. @@ -402,7 +402,7 @@ ___ ### getFulfillmentOptions -▸ `Abstract` **getFulfillmentOptions**(): `Promise`<`any`[]\> +`Abstract` **getFulfillmentOptions**(): `Promise`<`any`[]\> Called before a shipping option is created in Admin. The method should return all of the options that the fulfillment provider can be used with, @@ -452,7 +452,7 @@ ___ ### getIdentifier -▸ **getIdentifier**(): `string` +**getIdentifier**(): `string` Return a unique identifier to retrieve the fulfillment plugin provider @@ -479,7 +479,7 @@ ___ ### getReturnDocuments -▸ `Abstract` **getReturnDocuments**(`data`): `Promise`<`any`\> +`Abstract` **getReturnDocuments**(`data`): `Promise`<`any`\> Used to retrieve documents related to a return order. @@ -528,7 +528,7 @@ ___ ### getShipmentDocuments -▸ `Abstract` **getShipmentDocuments**(`data`): `Promise`<`any`\> +`Abstract` **getShipmentDocuments**(`data`): `Promise`<`any`\> Used to retrieve documents related to a shipment. @@ -577,7 +577,7 @@ ___ ### retrieveDocuments -▸ `Abstract` **retrieveDocuments**(`fulfillmentData`, `documentType`): `Promise`<`any`\> +`Abstract` **retrieveDocuments**(`fulfillmentData`, `documentType`): `Promise`<`any`\> #### Parameters @@ -632,7 +632,7 @@ ___ ### validateFulfillmentData -▸ `Abstract` **validateFulfillmentData**(`optionData`, `data`, `cart`): `Promise`\> +`Abstract` **validateFulfillmentData**(`optionData`, `data`, `cart`): `Promise`\> Called before a shipping method is set on a cart to ensure that the data sent with the shipping method is valid. The data object may contain extra @@ -718,7 +718,7 @@ ___ ### validateOption -▸ `Abstract` **validateOption**(`data`): `Promise`<`boolean`\> +`Abstract` **validateOption**(`data`): `Promise`<`boolean`\> Called before a shipping option is created in Admin. Use this to ensure that a fulfillment option does in fact exist. diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractNotificationService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractNotificationService.mdx index b39aedec07..e61051bf82 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractNotificationService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractNotificationService.mdx @@ -69,7 +69,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -98,7 +98,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -179,7 +179,7 @@ ___ ### getIdentifier -▸ **getIdentifier**(): `string` +**getIdentifier**(): `string` #### Returns @@ -200,7 +200,7 @@ ___ ### resendNotification -▸ `Abstract` **resendNotification**(`notification`, `config`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> +`Abstract` **resendNotification**(`notification`, `config`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> #### Parameters @@ -263,7 +263,7 @@ ___ ### sendNotification -▸ `Abstract` **sendNotification**(`event`, `data`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> +`Abstract` **sendNotification**(`event`, `data`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> #### Parameters @@ -326,7 +326,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -368,7 +368,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`AbstractNotificationService`](admin_discounts.internal.internal.AbstractNotificationService.mdx) +**withTransaction**(`transactionManager?`): [`AbstractNotificationService`](admin_discounts.internal.internal.AbstractNotificationService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentProcessor.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentProcessor.mdx index 82707a87d4..161d6f629c 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentProcessor.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentProcessor.mdx @@ -47,7 +47,7 @@ Payment processor in charge of creating , managing and processing a payment ### authorizePayment -▸ `Abstract` **authorizePayment**(`paymentSessionData`, `context`): `Promise`<[`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| { `data`: Record<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> +`Abstract` **authorizePayment**(`paymentSessionData`, `context`): `Promise`<[`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| { `data`: Record<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> Authorize an existing session if it is not already authorized @@ -104,7 +104,7 @@ ___ ### cancelPayment -▸ `Abstract` **cancelPayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> +`Abstract` **cancelPayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> Cancel an existing session @@ -153,7 +153,7 @@ ___ ### capturePayment -▸ `Abstract` **capturePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> +`Abstract` **capturePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> Capture an existing session @@ -202,7 +202,7 @@ ___ ### deletePayment -▸ `Abstract` **deletePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> +`Abstract` **deletePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> Delete an existing session @@ -251,7 +251,7 @@ ___ ### getIdentifier -▸ **getIdentifier**(): `string` +**getIdentifier**(): `string` Return a unique identifier to retrieve the payment plugin provider @@ -278,7 +278,7 @@ ___ ### getPaymentStatus -▸ `Abstract` **getPaymentStatus**(`paymentSessionData`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> +`Abstract` **getPaymentStatus**(`paymentSessionData`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> Return the status of the session @@ -359,7 +359,7 @@ ___ ### initiatePayment -▸ `Abstract` **initiatePayment**(`context`): `Promise`<[`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> +`Abstract` **initiatePayment**(`context`): `Promise`<[`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> Initiate a payment session with the external provider @@ -408,7 +408,7 @@ ___ ### refundPayment -▸ `Abstract` **refundPayment**(`paymentSessionData`, `refundAmount`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> +`Abstract` **refundPayment**(`paymentSessionData`, `refundAmount`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> Refund an existing session @@ -465,7 +465,7 @@ ___ ### retrievePayment -▸ `Abstract` **retrievePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> +`Abstract` **retrievePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> Retrieve an existing session @@ -514,7 +514,7 @@ ___ ### updatePayment -▸ `Abstract` **updatePayment**(`context`): `Promise`<`void` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> +`Abstract` **updatePayment**(`context`): `Promise`<`void` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> Update an existing payment session @@ -563,7 +563,7 @@ ___ ### updatePaymentData -▸ `Abstract` **updatePaymentData**(`sessionId`, `data`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> +`Abstract` **updatePaymentData**(`sessionId`, `data`): `Promise` \| [`PaymentProcessorError`](../interfaces/admin_discounts.internal.internal.PaymentProcessorError.mdx)\> Update the session data for a payment session diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentService.mdx index b1e9a28b5e..b8ab324518 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPaymentService.mdx @@ -75,7 +75,7 @@ in the near future use the AbstractPaymentProcessor instead ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -104,7 +104,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -185,7 +185,7 @@ ___ ### authorizePayment -▸ `Abstract` **authorizePayment**(`paymentSession`, `context`): `Promise`<{ `data`: [`Data`](../modules/admin_discounts.internal.internal.mdx#data) ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> +`Abstract` **authorizePayment**(`paymentSession`, `context`): `Promise`<{ `data`: [`Data`](../modules/admin_discounts.internal.internal.mdx#data) ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> #### Parameters @@ -242,7 +242,7 @@ ___ ### cancelPayment -▸ `Abstract` **cancelPayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +`Abstract` **cancelPayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> This will be @@ -295,7 +295,7 @@ ___ ### capturePayment -▸ `Abstract` **capturePayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +`Abstract` **capturePayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> This will be @@ -348,7 +348,7 @@ ___ ### createPayment -▸ `Abstract` **createPayment**(`context`): `Promise`<[`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> +`Abstract` **createPayment**(`context`): `Promise`<[`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> #### Parameters @@ -391,7 +391,7 @@ ___ [PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[createPayment](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#createpayment) -▸ `Abstract` **createPayment**(`cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +`Abstract` **createPayment**(`cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> This will be @@ -444,7 +444,7 @@ ___ ### deletePayment -▸ `Abstract` **deletePayment**(`paymentSession`): `Promise`<`void`\> +`Abstract` **deletePayment**(`paymentSession`): `Promise`<`void`\> This will be @@ -488,7 +488,7 @@ ___ ### getIdentifier -▸ **getIdentifier**(): `string` +**getIdentifier**(): `string` #### Returns @@ -513,7 +513,7 @@ ___ ### getPaymentData -▸ `Abstract` **getPaymentData**(`paymentSession`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +`Abstract` **getPaymentData**(`paymentSession`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> #### Parameters @@ -562,7 +562,7 @@ ___ ### getStatus -▸ `Abstract` **getStatus**(`data`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> +`Abstract` **getStatus**(`data`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> This will be @@ -647,7 +647,7 @@ ___ ### refundPayment -▸ `Abstract` **refundPayment**(`payment`, `refundAmount`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +`Abstract` **refundPayment**(`payment`, `refundAmount`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> This will be @@ -708,7 +708,7 @@ ___ ### retrievePayment -▸ `Abstract` **retrievePayment**(`paymentData`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +`Abstract` **retrievePayment**(`paymentData`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> #### Parameters @@ -757,7 +757,7 @@ ___ ### retrieveSavedMethods -▸ **retrieveSavedMethods**(`customer`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)[]\> +**retrieveSavedMethods**(`customer`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)[]\> This will be @@ -819,7 +819,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -861,7 +861,7 @@ ___ ### updatePayment -▸ `Abstract` **updatePayment**(`paymentSessionData`, `context`): `Promise` \| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> +`Abstract` **updatePayment**(`paymentSessionData`, `context`): `Promise` \| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> #### Parameters @@ -912,7 +912,7 @@ ___ [PaymentService](../interfaces/admin_discounts.internal.internal.PaymentService.mdx).[updatePayment](../interfaces/admin_discounts.internal.internal.PaymentService.mdx#updatepayment) -▸ `Abstract` **updatePayment**(`paymentSessionData`, `cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +`Abstract` **updatePayment**(`paymentSessionData`, `cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> This will be @@ -973,7 +973,7 @@ ___ ### updatePaymentData -▸ `Abstract` **updatePaymentData**(`paymentSessionData`, `data`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +`Abstract` **updatePaymentData**(`paymentSessionData`, `data`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> #### Parameters @@ -1030,7 +1030,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`AbstractPaymentService`](admin_discounts.internal.internal.AbstractPaymentService.mdx) +**withTransaction**(`transactionManager?`): [`AbstractPaymentService`](admin_discounts.internal.internal.AbstractPaymentService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx index 58d2c802d7..c7203006da 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx @@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -86,7 +86,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -163,7 +163,7 @@ ___ ### calculateVariantPrice -▸ `Abstract` **calculateVariantPrice**(`data`, `context`): `Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/admin_discounts.internal.internal.mdx#priceselectionresult)\>\> +`Abstract` **calculateVariantPrice**(`data`, `context`): `Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/admin_discounts.internal.internal.mdx#priceselectionresult)\>\> Calculate the original and discount price for a given variant in a set of circumstances described in the context. @@ -238,7 +238,7 @@ ___ ### onVariantsPricesUpdate -▸ **onVariantsPricesUpdate**(`variantIds`): `Promise`<`void`\> +**onVariantsPricesUpdate**(`variantIds`): `Promise`<`void`\> Notify price selection strategy that variants prices have been updated. @@ -278,7 +278,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -316,7 +316,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`AbstractPriceSelectionStrategy`](admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx) +**withTransaction**(`transactionManager?`): [`AbstractPriceSelectionStrategy`](admin_discounts.internal.internal.AbstractPriceSelectionStrategy.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractTaxService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractTaxService.mdx index f734ac4291..8ec9313e78 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractTaxService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AbstractTaxService.mdx @@ -33,7 +33,7 @@ items and shipping methods. ### getIdentifier -▸ **getIdentifier**(): `string` +**getIdentifier**(): `string` #### Returns @@ -54,7 +54,7 @@ ___ ### getTaxLines -▸ `Abstract` **getTaxLines**(`itemLines`, `shippingLines`, `context`): `Promise`<[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]\> +`Abstract` **getTaxLines**(`itemLines`, `shippingLines`, `context`): `Promise`<[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]\> Retrieves the numerical tax lines for a calculation context. diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AnalyticsConfigService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AnalyticsConfigService.mdx index d38e400613..7c0e00d03c 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AnalyticsConfigService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AnalyticsConfigService.mdx @@ -73,7 +73,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -98,7 +98,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -175,7 +175,7 @@ ___ ### create -▸ **create**(`userId`, `data`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\> +**create**(`userId`, `data`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\> Creates an analytics config. @@ -228,7 +228,7 @@ ___ ### delete -▸ **delete**(`userId`): `Promise`<`void`\> +**delete**(`userId`): `Promise`<`void`\> Deletes an analytics config. @@ -264,7 +264,7 @@ ___ ### retrieve -▸ **retrieve**(`userId`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\> +**retrieve**(`userId`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\> #### Parameters @@ -307,7 +307,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -345,7 +345,7 @@ ___ ### update -▸ **update**(`userId`, `update`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\> +**update**(`userId`, `update`): `Promise`<[`AnalyticsConfig`](admin_discounts.internal.internal.AnalyticsConfig.mdx)\> Updates an analytics config. If the config does not exist, it will be created instead. @@ -398,7 +398,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`AnalyticsConfigService`](admin_discounts.internal.internal.AnalyticsConfigService.mdx) +**withTransaction**(`transactionManager?`): [`AnalyticsConfigService`](admin_discounts.internal.internal.AnalyticsConfigService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AuthService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AuthService.mdx index 9337fe22e4..5cc0278470 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AuthService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.AuthService.mdx @@ -75,7 +75,7 @@ Can authenticate a user based on email password combination ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -100,7 +100,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -177,7 +177,7 @@ ___ ### authenticate -▸ **authenticate**(`email`, `password`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\> +**authenticate**(`email`, `password`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\> Authenticates a given user based on an email, password combination. Uses scrypt to match password with hashed value. @@ -231,7 +231,7 @@ ___ ### authenticateAPIToken -▸ **authenticateAPIToken**(`token`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\> +**authenticateAPIToken**(`token`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\> Authenticates a given user with an API token @@ -276,7 +276,7 @@ ___ ### authenticateCustomer -▸ **authenticateCustomer**(`email`, `password`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\> +**authenticateCustomer**(`email`, `password`): `Promise`<[`AuthenticateResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#authenticateresult)\> Authenticates a customer based on an email, password combination. Uses scrypt to match password with hashed value. @@ -330,7 +330,7 @@ ___ ### comparePassword\_ -▸ `Protected` **comparePassword_**(`password`, `hash`): `Promise`<`boolean`\> +`Protected` **comparePassword_**(`password`, `hash`): `Promise`<`boolean`\> Verifies if a password is valid given the provided password hash @@ -383,7 +383,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -421,7 +421,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`AuthService`](admin_discounts.internal.internal.AuthService.mdx) +**withTransaction**(`transactionManager?`): [`AuthService`](admin_discounts.internal.internal.AuthService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.BatchJobService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.BatchJobService.mdx index bc481b6e67..fb1ab52cc0 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.BatchJobService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.BatchJobService.mdx @@ -161,7 +161,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -186,7 +186,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -263,7 +263,7 @@ ___ ### cancel -▸ **cancel**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> +**cancel**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> #### Parameters @@ -306,7 +306,7 @@ ___ ### complete -▸ **complete**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> +**complete**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> #### Parameters @@ -349,7 +349,7 @@ ___ ### confirm -▸ **confirm**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> +**confirm**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> #### Parameters @@ -392,7 +392,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> +**create**(`data`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> #### Parameters @@ -435,7 +435,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)[], `number`]\> +**listAndCount**(`selector?`, `config?`): `Promise`<[[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)[], `number`]\> #### Parameters @@ -494,7 +494,7 @@ ___ ### prepareBatchJobForProcessing -▸ **prepareBatchJobForProcessing**(`data`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\> +**prepareBatchJobForProcessing**(`data`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\> #### Parameters @@ -545,7 +545,7 @@ ___ ### retrieve -▸ **retrieve**(`batchJobId`, `config?`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> +**retrieve**(`batchJobId`, `config?`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> #### Parameters @@ -596,7 +596,7 @@ ___ ### setFailed -▸ **setFailed**(`batchJobOrId`, `error?`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> +**setFailed**(`batchJobOrId`, `error?`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> #### Parameters @@ -647,7 +647,7 @@ ___ ### setPreProcessingDone -▸ **setPreProcessingDone**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> +**setPreProcessingDone**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> #### Parameters @@ -690,7 +690,7 @@ ___ ### setProcessing -▸ **setProcessing**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> +**setProcessing**(`batchJobOrId`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> #### Parameters @@ -733,7 +733,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -771,7 +771,7 @@ ___ ### update -▸ **update**(`batchJobOrId`, `data`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> +**update**(`batchJobOrId`, `data`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> #### Parameters @@ -822,7 +822,7 @@ ___ ### updateStatus -▸ `Protected` **updateStatus**(`batchJobOrId`, `status`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> +`Protected` **updateStatus**(`batchJobOrId`, `status`): `Promise`<[`BatchJob`](admin_batch_jobs.internal.BatchJob.mdx)\> #### Parameters @@ -873,7 +873,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`BatchJobService`](admin_discounts.internal.internal.BatchJobService.mdx) +**withTransaction**(`transactionManager?`): [`BatchJobService`](admin_discounts.internal.internal.BatchJobService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CartService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CartService.mdx index 0c252dd98c..97faaca63e 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CartService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CartService.mdx @@ -313,7 +313,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -338,7 +338,7 @@ TransactionBaseService.activeManager\_ ### addLineItem -▸ **addLineItem**(`cartId`, `lineItem`, `config?`): `Promise`<`void`\> +**addLineItem**(`cartId`, `lineItem`, `config?`): `Promise`<`void`\> Adds a line item to the cart. @@ -402,7 +402,7 @@ ___ ### addOrUpdateLineItems -▸ **addOrUpdateLineItems**(`cartId`, `lineItems`, `config?`): `Promise`<`void`\> +**addOrUpdateLineItems**(`cartId`, `lineItems`, `config?`): `Promise`<`void`\> Adds or update one or multiple line items to the cart. It also update all existing items in the cart to have has_shipping to false. Finally, the adjustments will be updated. @@ -463,7 +463,7 @@ ___ ### addShippingMethod -▸ **addShippingMethod**(`cartOrId`, `optionId`, `data?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> +**addShippingMethod**(`cartOrId`, `optionId`, `data?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> Adds the shipping method to the list of shipping methods associated with the cart. Shipping Methods are the ways that an order is shipped, whereas a @@ -528,7 +528,7 @@ ___ ### adjustFreeShipping\_ -▸ `Protected` **adjustFreeShipping_**(`cart`, `shouldAdd`): `Promise`<`void`\> +`Protected` **adjustFreeShipping_**(`cart`, `shouldAdd`): `Promise`<`void`\> Ensures shipping total on cart is correct in regards to a potential free shipping discount @@ -575,7 +575,7 @@ ___ ### applyDiscount -▸ **applyDiscount**(`cart`, `discountCode`): `Promise`<`void`\> +**applyDiscount**(`cart`, `discountCode`): `Promise`<`void`\> Updates the cart's discounts. If discount besides free shipping is already applied, this @@ -622,7 +622,7 @@ ___ ### applyDiscounts -▸ **applyDiscounts**(`cart`, `discountCodes`): `Promise`<`void`\> +**applyDiscounts**(`cart`, `discountCodes`): `Promise`<`void`\> Updates the cart's discounts. If discount besides free shipping is already applied, this @@ -669,7 +669,7 @@ ___ ### applyGiftCard\_ -▸ `Protected` **applyGiftCard_**(`cart`, `code`): `Promise`<`void`\> +`Protected` **applyGiftCard_**(`cart`, `code`): `Promise`<`void`\> #### Parameters @@ -711,7 +711,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -788,7 +788,7 @@ ___ ### authorizePayment -▸ **authorizePayment**(`cartId`, `context?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> +**authorizePayment**(`cartId`, `context?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> Authorizes a payment for a cart. Will authorize with chosen payment provider. This will return @@ -845,7 +845,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> +**create**(`data`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> Creates a cart. @@ -890,7 +890,7 @@ ___ ### createOrFetchGuestCustomerFromEmail\_ -▸ `Protected` **createOrFetchGuestCustomerFromEmail_**(`email`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> +`Protected` **createOrFetchGuestCustomerFromEmail_**(`email`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> Creates or fetches a user based on an email. @@ -935,7 +935,7 @@ ___ ### createTaxLines -▸ **createTaxLines**(`cartOrId`): `Promise`<`void`\> +**createTaxLines**(`cartOrId`): `Promise`<`void`\> #### Parameters @@ -969,7 +969,7 @@ ___ ### decorateTotals -▸ **decorateTotals**(`cart`, `totalsConfig?`): `Promise`<[`WithRequiredProperty`](../modules/admin_discounts.internal.internal.mdx#withrequiredproperty)<[`Cart`](admin_collections.internal.Cart.mdx), ``"total"``\>\> +**decorateTotals**(`cart`, `totalsConfig?`): `Promise`<[`WithRequiredProperty`](../modules/admin_discounts.internal.internal.mdx#withrequiredproperty)<[`Cart`](admin_collections.internal.Cart.mdx), ``"total"``\>\> #### Parameters @@ -1037,7 +1037,7 @@ ___ ### decorateTotals\_ -▸ `Protected` **decorateTotals_**(`cart`, `totalsToSelect`, `options?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> +`Protected` **decorateTotals_**(`cart`, `totalsToSelect`, `options?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> #### Parameters @@ -1100,7 +1100,7 @@ ___ ### delete -▸ **delete**(`cartId`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> +**delete**(`cartId`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> Deletes a cart from the database. Completed carts cannot be deleted. @@ -1145,7 +1145,7 @@ ___ ### deletePaymentSession -▸ **deletePaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> +**deletePaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> Removes a payment session from the cart. @@ -1189,7 +1189,7 @@ ___ ### deleteTaxLines -▸ **deleteTaxLines**(`id`): `Promise`<`void`\> +**deleteTaxLines**(`id`): `Promise`<`void`\> #### Parameters @@ -1223,7 +1223,7 @@ ___ ### findCustomShippingOption -▸ **findCustomShippingOption**(`cartCustomShippingOptions`, `optionId`): `undefined` \| [`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx) +**findCustomShippingOption**(`cartCustomShippingOptions`, `optionId`): `undefined` \| [`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx) Finds the cart's custom shipping options based on the passed option id. throws if custom options is not empty and no shipping option corresponds to optionId @@ -1268,7 +1268,7 @@ ___ ### getValidatedSalesChannel -▸ `Protected` **getValidatedSalesChannel**(`salesChannelId?`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> +`Protected` **getValidatedSalesChannel**(`salesChannelId?`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> #### Parameters @@ -1311,7 +1311,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)[]\> #### Parameters @@ -1371,7 +1371,7 @@ ___ ### onSalesChannelChange -▸ `Protected` **onSalesChannelChange**(`cart`, `newSalesChannelId`): `Promise`<`void`\> +`Protected` **onSalesChannelChange**(`cart`, `newSalesChannelId`): `Promise`<`void`\> Remove the cart line item that does not belongs to the newly assigned sales channel @@ -1415,7 +1415,7 @@ ___ ### refreshAdjustments\_ -▸ `Protected` **refreshAdjustments_**(`cart`): `Promise`<`void`\> +`Protected` **refreshAdjustments_**(`cart`): `Promise`<`void`\> #### Parameters @@ -1449,7 +1449,7 @@ ___ ### refreshPaymentSession -▸ **refreshPaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> +**refreshPaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> Refreshes a payment session on a cart @@ -1493,7 +1493,7 @@ ___ ### removeDiscount -▸ **removeDiscount**(`cartId`, `discountCode`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> +**removeDiscount**(`cartId`, `discountCode`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> Removes a discount based on a discount code. @@ -1546,7 +1546,7 @@ ___ ### removeLineItem -▸ **removeLineItem**(`cartId`, `lineItemId`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> +**removeLineItem**(`cartId`, `lineItemId`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> Removes a line item from the cart. @@ -1599,7 +1599,7 @@ ___ ### retrieve -▸ **retrieve**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> +**retrieve**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> Gets a cart by id. @@ -1660,7 +1660,7 @@ ___ ### retrieveLegacy -▸ `Protected` **retrieveLegacy**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> +`Protected` **retrieveLegacy**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> #### Parameters @@ -1721,7 +1721,7 @@ ___ ### retrieveWithTotals -▸ **retrieveWithTotals**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`WithRequiredProperty`](../modules/admin_discounts.internal.internal.mdx#withrequiredproperty)<[`Cart`](admin_collections.internal.Cart.mdx), ``"total"``\>\> +**retrieveWithTotals**(`cartId`, `options?`, `totalsConfig?`): `Promise`<[`WithRequiredProperty`](../modules/admin_discounts.internal.internal.mdx#withrequiredproperty)<[`Cart`](admin_collections.internal.Cart.mdx), ``"total"``\>\> #### Parameters @@ -1797,7 +1797,7 @@ ___ ### setMetadata -▸ **setMetadata**(`cartId`, `key`, `value`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> +**setMetadata**(`cartId`, `key`, `value`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> Dedicated method to set metadata for a cart. To ensure that plugins does not overwrite each @@ -1860,7 +1860,7 @@ ___ ### setPaymentSession -▸ **setPaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> +**setPaymentSession**(`cartId`, `providerId`): `Promise`<`void`\> Selects a payment session for a cart and creates a payment object in the external provider system @@ -1904,7 +1904,7 @@ ___ ### setPaymentSessions -▸ **setPaymentSessions**(`cartOrCartId`): `Promise`<`void`\> +**setPaymentSessions**(`cartOrCartId`): `Promise`<`void`\> Creates, updates and sets payment sessions associated with the cart. The first time the method is called payment sessions will be created for each @@ -1944,7 +1944,7 @@ ___ ### setRegion\_ -▸ `Protected` **setRegion_**(`cart`, `regionId`, `countryCode`): `Promise`<`void`\> +`Protected` **setRegion_**(`cart`, `regionId`, `countryCode`): `Promise`<`void`\> Set's the region of a cart. @@ -1996,7 +1996,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -2034,7 +2034,7 @@ ___ ### transformQueryForTotals\_ -▸ `Protected` **transformQueryForTotals_**(`config`): [`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Cart`](admin_collections.internal.Cart.mdx)\> & { `totalsToSelect`: [`TotalField`](../modules/admin_discounts.internal.internal.mdx#totalfield)[] } +`Protected` **transformQueryForTotals_**(`config`): [`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Cart`](admin_collections.internal.Cart.mdx)\> & { `totalsToSelect`: [`TotalField`](../modules/admin_discounts.internal.internal.mdx#totalfield)[] } #### Parameters @@ -2068,7 +2068,7 @@ ___ ### update -▸ **update**(`cartOrId`, `data`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> +**update**(`cartOrId`, `data`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> #### Parameters @@ -2119,7 +2119,7 @@ ___ ### updateBillingAddress\_ -▸ `Protected` **updateBillingAddress_**(`cart`, `addressOrId`, `addrRepo`): `Promise`<`void`\> +`Protected` **updateBillingAddress_**(`cart`, `addressOrId`, `addrRepo`): `Promise`<`void`\> Updates the cart's billing address. @@ -2171,7 +2171,7 @@ ___ ### updateCustomerId\_ -▸ `Protected` **updateCustomerId_**(`cart`, `customerId`): `Promise`<`void`\> +`Protected` **updateCustomerId_**(`cart`, `customerId`): `Promise`<`void`\> Sets the customer id of a cart @@ -2215,7 +2215,7 @@ ___ ### updateLineItem -▸ **updateLineItem**(`cartId`, `lineItemId`, `update`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> +**updateLineItem**(`cartId`, `lineItemId`, `update`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> Updates a cart's existing line item. @@ -2276,7 +2276,7 @@ ___ ### updatePaymentSession -▸ **updatePaymentSession**(`cartId`, `update`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> +**updatePaymentSession**(`cartId`, `update`): `Promise`<[`Cart`](admin_collections.internal.Cart.mdx)\> Updates the currently selected payment session. @@ -2329,7 +2329,7 @@ ___ ### updateShippingAddress\_ -▸ `Protected` **updateShippingAddress_**(`cart`, `addressOrId`, `addrRepo`): `Promise`<`void`\> +`Protected` **updateShippingAddress_**(`cart`, `addressOrId`, `addrRepo`): `Promise`<`void`\> Updates the cart's shipping address. @@ -2381,7 +2381,7 @@ ___ ### updateUnitPrices\_ -▸ `Protected` **updateUnitPrices_**(`cart`, `regionId?`, `customer_id?`): `Promise`<`void`\> +`Protected` **updateUnitPrices_**(`cart`, `regionId?`, `customer_id?`): `Promise`<`void`\> #### Parameters @@ -2431,7 +2431,7 @@ ___ ### validateLineItem -▸ `Protected` **validateLineItem**(`sales_channel_id`, `lineItem`): `Promise`<`boolean`\> +`Protected` **validateLineItem**(`sales_channel_id`, `lineItem`): `Promise`<`boolean`\> Check if line item's variant belongs to the cart's sales channel. @@ -2492,7 +2492,7 @@ ___ ### validateLineItemShipping\_ -▸ `Protected` **validateLineItemShipping_**(`shippingMethods`, `lineItemShippingProfiledId`): `boolean` +`Protected` **validateLineItemShipping_**(`shippingMethods`, `lineItemShippingProfiledId`): `boolean` Checks if a given line item has a shipping method that can fulfill it. Returns true if all products in the cart can be fulfilled with the current @@ -2538,7 +2538,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`CartService`](admin_discounts.internal.internal.CartService.mdx) +**withTransaction**(`transactionManager?`): [`CartService`](admin_discounts.internal.internal.CartService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimItemService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimItemService.mdx index 2d50819622..a592cbd4ae 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimItemService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimItemService.mdx @@ -129,7 +129,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -154,7 +154,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -231,7 +231,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\> +**create**(`data`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\> #### Parameters @@ -274,7 +274,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)[]\> #### Parameters @@ -334,7 +334,7 @@ ___ ### retrieve -▸ **retrieve**(`claimItemId`, `config?`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\> +**retrieve**(`claimItemId`, `config?`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\> Gets a claim item by id. @@ -387,7 +387,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -425,7 +425,7 @@ ___ ### update -▸ **update**(`id`, `data`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\> +**update**(`id`, `data`): `Promise`<[`ClaimItem`](admin_collections.internal.ClaimItem.mdx)\> #### Parameters @@ -476,7 +476,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`ClaimItemService`](admin_discounts.internal.internal.ClaimItemService.mdx) +**withTransaction**(`transactionManager?`): [`ClaimItemService`](admin_discounts.internal.internal.ClaimItemService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimService.mdx index d3c35038d8..6af9a52961 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ClaimService.mdx @@ -241,7 +241,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -266,7 +266,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -343,7 +343,7 @@ ___ ### cancel -▸ **cancel**(`id`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> +**cancel**(`id`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> #### Parameters @@ -386,7 +386,7 @@ ___ ### cancelFulfillment -▸ **cancelFulfillment**(`fulfillmentId`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> +**cancelFulfillment**(`fulfillmentId`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> #### Parameters @@ -429,7 +429,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> +**create**(`data`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> Creates a Claim on an Order. Claims consists of items that are claimed and optionally items to be sent as replacement for the claimed items. The @@ -476,7 +476,7 @@ ___ ### createFulfillment -▸ **createFulfillment**(`id`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> +**createFulfillment**(`id`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> #### Parameters @@ -551,7 +551,7 @@ ___ ### createShipment -▸ **createShipment**(`id`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> +**createShipment**(`id`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> #### Parameters @@ -634,7 +634,7 @@ ___ ### getRefundTotalForClaimLinesOnOrder -▸ `Protected` **getRefundTotalForClaimLinesOnOrder**(`order`, `claimItems`): `Promise`<`number`\> +`Protected` **getRefundTotalForClaimLinesOnOrder**(`order`, `claimItems`): `Promise`<`number`\> Finds claim line items on an order and calculates the refund amount. There are three places too look: @@ -692,7 +692,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)[]\> #### Parameters @@ -752,7 +752,7 @@ ___ ### processRefund -▸ **processRefund**(`id`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> +**processRefund**(`id`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> #### Parameters @@ -795,7 +795,7 @@ ___ ### retrieve -▸ **retrieve**(`claimId`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> +**retrieve**(`claimId`, `config?`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> Gets an order by id. @@ -848,7 +848,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -886,7 +886,7 @@ ___ ### update -▸ **update**(`id`, `data`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> +**update**(`id`, `data`): `Promise`<[`ClaimOrder`](admin_collections.internal.ClaimOrder.mdx)\> #### Parameters @@ -937,7 +937,7 @@ ___ ### validateCreateClaimInput -▸ `Protected` **validateCreateClaimInput**(`data`): `Promise`<`void`\> +`Protected` **validateCreateClaimInput**(`data`): `Promise`<`void`\> #### Parameters @@ -971,7 +971,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`ClaimService`](admin_discounts.internal.internal.ClaimService.mdx) +**withTransaction**(`transactionManager?`): [`ClaimService`](admin_discounts.internal.internal.ClaimService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CurrencyService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CurrencyService.mdx index fb83bd7583..43bb61ba83 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CurrencyService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CurrencyService.mdx @@ -97,7 +97,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -122,7 +122,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -199,7 +199,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Currency`](admin_collections.internal.Currency.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`): `Promise`<[[`Currency`](admin_collections.internal.Currency.mdx)[], `number`]\> Lists currencies based on the provided parameters and includes the count of currencies that match the query. @@ -261,7 +261,7 @@ ___ ### retrieveByCode -▸ **retrieveByCode**(`code`): `Promise`<[`Currency`](admin_collections.internal.Currency.mdx)\> +**retrieveByCode**(`code`): `Promise`<[`Currency`](admin_collections.internal.Currency.mdx)\> Return the currency @@ -306,7 +306,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -344,7 +344,7 @@ ___ ### update -▸ **update**(`code`, `data`): `Promise`<`undefined` \| [`Currency`](admin_collections.internal.Currency.mdx)\> +**update**(`code`, `data`): `Promise`<`undefined` \| [`Currency`](admin_collections.internal.Currency.mdx)\> Update a currency @@ -397,7 +397,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`CurrencyService`](admin_discounts.internal.internal.CurrencyService.mdx) +**withTransaction**(`transactionManager?`): [`CurrencyService`](admin_discounts.internal.internal.CurrencyService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomShippingOptionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomShippingOptionService.mdx index b427f6017b..bdb5b712ec 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomShippingOptionService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomShippingOptionService.mdx @@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -90,7 +90,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -167,7 +167,7 @@ ___ ### create -▸ **create**<`T`, `TResult`\>(`data`): `Promise`<`TResult`\> +**create**<`T`, `TResult`\>(`data`): `Promise`<`TResult`\> Creates a custom shipping option @@ -222,7 +222,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)[]\> Fetches all custom shipping options based on the given selector @@ -284,7 +284,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `config?`): `Promise`<[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)\> +**retrieve**(`id`, `config?`): `Promise`<[`CustomShippingOption`](admin_discounts.internal.internal.CustomShippingOption.mdx)\> Retrieves a specific shipping option. @@ -337,7 +337,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -375,7 +375,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`CustomShippingOptionService`](admin_discounts.internal.internal.CustomShippingOptionService.mdx) +**withTransaction**(`transactionManager?`): [`CustomShippingOptionService`](admin_discounts.internal.internal.CustomShippingOptionService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerGroupService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerGroupService.mdx index 2668186158..75585851f3 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerGroupService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerGroupService.mdx @@ -81,7 +81,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -106,7 +106,7 @@ TransactionBaseService.activeManager\_ ### addCustomers -▸ **addCustomers**(`id`, `customerIds`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> +**addCustomers**(`id`, `customerIds`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> Add a batch of customers to a customer group at once @@ -159,7 +159,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -236,7 +236,7 @@ ___ ### create -▸ **create**(`group`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> +**create**(`group`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> Creates a customer group with the provided data. @@ -281,7 +281,7 @@ ___ ### delete -▸ **delete**(`groupId`): `Promise`<`void`\> +**delete**(`groupId`): `Promise`<`void`\> Remove customer group @@ -317,7 +317,7 @@ ___ ### list -▸ **list**(`selector`, `config`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)[]\> +**list**(`selector`, `config`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)[]\> List customer groups. @@ -379,7 +379,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config`): `Promise`<[[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)[], `number`]\> +**listAndCount**(`selector`, `config`): `Promise`<[[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)[], `number`]\> Retrieve a list of customer groups and total count of records that match the query. @@ -440,7 +440,7 @@ ___ ### removeCustomer -▸ **removeCustomer**(`id`, `customerIds`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> +**removeCustomer**(`id`, `customerIds`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> Remove list of customers from a customergroup @@ -493,7 +493,7 @@ ___ ### retrieve -▸ **retrieve**(`customerGroupId`, `config?`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> +**retrieve**(`customerGroupId`, `config?`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> #### Parameters @@ -544,7 +544,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -582,7 +582,7 @@ ___ ### update -▸ **update**(`customerGroupId`, `update`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> +**update**(`customerGroupId`, `update`): `Promise`<[`CustomerGroup`](admin_collections.internal.CustomerGroup.mdx)\> Update a customer group. @@ -635,7 +635,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`CustomerGroupService`](admin_discounts.internal.internal.CustomerGroupService.mdx) +**withTransaction**(`transactionManager?`): [`CustomerGroupService`](admin_discounts.internal.internal.CustomerGroupService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerService.mdx index 8e352051aa..75f964a1af 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.CustomerService.mdx @@ -123,7 +123,7 @@ Provides layer to manipulate customers. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -148,7 +148,7 @@ TransactionBaseService.activeManager\_ ### addAddress -▸ **addAddress**(`customerId`, `address`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx) \| [`Address`](admin_collections.internal.Address.mdx)\> +**addAddress**(`customerId`, `address`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx) \| [`Address`](admin_collections.internal.Address.mdx)\> #### Parameters @@ -199,7 +199,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -276,7 +276,7 @@ ___ ### count -▸ **count**(): `Promise`<`number`\> +**count**(): `Promise`<`number`\> Return the total number of documents in database @@ -308,7 +308,7 @@ ___ ### create -▸ **create**(`customer`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> +**create**(`customer`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> Creates a customer from an email - customers can have accounts associated, e.g. to login and view order history, etc. If a password is provided the @@ -356,7 +356,7 @@ ___ ### delete -▸ **delete**(`customerId`): `Promise`<`void` \| [`Customer`](admin_collections.internal.Customer.mdx)\> +**delete**(`customerId`): `Promise`<`void` \| [`Customer`](admin_collections.internal.Customer.mdx)\> Deletes a customer from a given customer id. @@ -401,7 +401,7 @@ ___ ### generateResetPasswordToken -▸ **generateResetPasswordToken**(`customerId`): `Promise`<`string`\> +**generateResetPasswordToken**(`customerId`): `Promise`<`string`\> Generate a JSON Web token, that will be sent to a customer, that wishes to reset password. @@ -450,7 +450,7 @@ ___ ### hashPassword\_ -▸ **hashPassword_**(`password`): `Promise`<`string`\> +**hashPassword_**(`password`): `Promise`<`string`\> Hashes a password @@ -495,7 +495,7 @@ ___ ### list -▸ **list**(`selector?`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)[]\> +**list**(`selector?`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)[]\> #### Parameters @@ -555,7 +555,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Customer`](admin_collections.internal.Customer.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`): `Promise`<[[`Customer`](admin_collections.internal.Customer.mdx)[], `number`]\> #### Parameters @@ -614,7 +614,7 @@ ___ ### listByEmail -▸ **listByEmail**(`email`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)[]\> +**listByEmail**(`email`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)[]\> #### Parameters @@ -674,7 +674,7 @@ ___ ### removeAddress -▸ **removeAddress**(`customerId`, `addressId`): `Promise`<`void`\> +**removeAddress**(`customerId`, `addressId`): `Promise`<`void`\> #### Parameters @@ -716,7 +716,7 @@ ___ ### retrieve -▸ **retrieve**(`customerId`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> +**retrieve**(`customerId`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> Gets a customer by id. @@ -769,7 +769,7 @@ ___ ### retrieveByEmail -▸ **retrieveByEmail**(`email`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> +**retrieveByEmail**(`email`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> Gets a registered customer by email. @@ -824,7 +824,7 @@ ___ ### retrieveByPhone -▸ **retrieveByPhone**(`phone`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> +**retrieveByPhone**(`phone`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> Gets a customer by phone. @@ -877,7 +877,7 @@ ___ ### retrieveRegisteredByEmail -▸ **retrieveRegisteredByEmail**(`email`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> +**retrieveRegisteredByEmail**(`email`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> #### Parameters @@ -928,7 +928,7 @@ ___ ### retrieveUnregisteredByEmail -▸ **retrieveUnregisteredByEmail**(`email`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> +**retrieveUnregisteredByEmail**(`email`, `config?`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> #### Parameters @@ -979,7 +979,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -1017,7 +1017,7 @@ ___ ### update -▸ **update**(`customerId`, `update`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> +**update**(`customerId`, `update`): `Promise`<[`Customer`](admin_collections.internal.Customer.mdx)\> Updates a customer. @@ -1070,7 +1070,7 @@ ___ ### updateAddress -▸ **updateAddress**(`customerId`, `addressId`, `address`): `Promise`<[`Address`](admin_collections.internal.Address.mdx)\> +**updateAddress**(`customerId`, `addressId`, `address`): `Promise`<[`Address`](admin_collections.internal.Address.mdx)\> #### Parameters @@ -1129,7 +1129,7 @@ ___ ### updateBillingAddress\_ -▸ **updateBillingAddress_**(`customer`, `addressOrId`): `Promise`<`void`\> +**updateBillingAddress_**(`customer`, `addressOrId`): `Promise`<`void`\> Updates the customers' billing address. @@ -1173,7 +1173,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`CustomerService`](admin_discounts.internal.internal.CustomerService.mdx) +**withTransaction**(`transactionManager?`): [`CustomerService`](admin_discounts.internal.internal.CustomerService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionService.mdx index b20987ac88..a6ebc1d22e 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountConditionService.mdx @@ -77,7 +77,7 @@ Provides layer to manipulate discount conditions. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -102,7 +102,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -179,7 +179,7 @@ ___ ### delete -▸ **delete**(`discountConditionId`): `Promise`<`void` \| [`DiscountCondition`](admin_collections.internal.DiscountCondition.mdx)\> +**delete**(`discountConditionId`): `Promise`<`void` \| [`DiscountCondition`](admin_collections.internal.DiscountCondition.mdx)\> #### Parameters @@ -222,7 +222,7 @@ ___ ### removeResources -▸ **removeResources**(`data`): `Promise`<`void`\> +**removeResources**(`data`): `Promise`<`void`\> #### Parameters @@ -256,7 +256,7 @@ ___ ### retrieve -▸ **retrieve**(`conditionId`, `config?`): `Promise`<[`DiscountCondition`](admin_collections.internal.DiscountCondition.mdx)\> +**retrieve**(`conditionId`, `config?`): `Promise`<[`DiscountCondition`](admin_collections.internal.DiscountCondition.mdx)\> #### Parameters @@ -307,7 +307,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -345,7 +345,7 @@ ___ ### upsertCondition -▸ **upsertCondition**(`data`, `overrideExisting?`): `Promise`<([`DiscountConditionCustomerGroup`](admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx) \| [`DiscountConditionProduct`](admin_discounts.internal.internal.DiscountConditionProduct.mdx) \| [`DiscountConditionProductCollection`](admin_discounts.internal.internal.DiscountConditionProductCollection.mdx) \| [`DiscountConditionProductTag`](admin_discounts.internal.internal.DiscountConditionProductTag.mdx) \| [`DiscountConditionProductType`](admin_discounts.internal.internal.DiscountConditionProductType.mdx))[]\> +**upsertCondition**(`data`, `overrideExisting?`): `Promise`<([`DiscountConditionCustomerGroup`](admin_discounts.internal.internal.DiscountConditionCustomerGroup.mdx) \| [`DiscountConditionProduct`](admin_discounts.internal.internal.DiscountConditionProduct.mdx) \| [`DiscountConditionProductCollection`](admin_discounts.internal.internal.DiscountConditionProductCollection.mdx) \| [`DiscountConditionProductTag`](admin_discounts.internal.internal.DiscountConditionProductTag.mdx) \| [`DiscountConditionProductType`](admin_discounts.internal.internal.DiscountConditionProductType.mdx))[]\> #### Parameters @@ -405,7 +405,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`DiscountConditionService`](admin_discounts.internal.internal.DiscountConditionService.mdx) +**withTransaction**(`transactionManager?`): [`DiscountConditionService`](admin_discounts.internal.internal.DiscountConditionService.mdx) #### Parameters @@ -443,7 +443,7 @@ ___ ### resolveConditionType\_ -▸ `Static` `Protected` **resolveConditionType_**(`data`): `undefined` \| { `resource_ids`: (`string` \| { `id`: `string` })[] ; `type`: [`DiscountConditionType`](../enums/admin_collections.internal.DiscountConditionType.mdx) } +`Static` `Protected` **resolveConditionType_**(`data`): `undefined` \| { `resource_ids`: (`string` \| { `id`: `string` })[] ; `type`: [`DiscountConditionType`](../enums/admin_collections.internal.DiscountConditionType.mdx) } #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountService.mdx index 733bc1ee33..1d69153f18 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DiscountService.mdx @@ -157,7 +157,7 @@ Provides layer to manipulate discounts. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -182,7 +182,7 @@ TransactionBaseService.activeManager\_ ### addRegion -▸ **addRegion**(`discountId`, `regionId`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> +**addRegion**(`discountId`, `regionId`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> Adds a region to the discount regions array. @@ -235,7 +235,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -312,7 +312,7 @@ ___ ### calculateDiscountForLineItem -▸ **calculateDiscountForLineItem**(`discountId`, `lineItem`, `calculationContextData`): `Promise`<`number`\> +**calculateDiscountForLineItem**(`discountId`, `lineItem`, `calculationContextData`): `Promise`<`number`\> #### Parameters @@ -371,7 +371,7 @@ ___ ### canApplyForCustomer -▸ **canApplyForCustomer**(`discountRuleId`, `customerId`): `Promise`<`boolean`\> +**canApplyForCustomer**(`discountRuleId`, `customerId`): `Promise`<`boolean`\> #### Parameters @@ -422,7 +422,7 @@ ___ ### create -▸ **create**(`discount`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> +**create**(`discount`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> Creates a discount with provided data given that the data is validated. Normalizes discount code to uppercase. @@ -468,7 +468,7 @@ ___ ### createDynamicCode -▸ **createDynamicCode**(`discountId`, `data`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> +**createDynamicCode**(`discountId`, `data`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> Creates a dynamic code for a discount id. @@ -521,7 +521,7 @@ ___ ### delete -▸ **delete**(`discountId`): `Promise`<`void`\> +**delete**(`discountId`): `Promise`<`void`\> Deletes a discount idempotently @@ -557,7 +557,7 @@ ___ ### deleteDynamicCode -▸ **deleteDynamicCode**(`discountId`, `code`): `Promise`<`void`\> +**deleteDynamicCode**(`discountId`, `code`): `Promise`<`void`\> Deletes a dynamic code for a discount id. @@ -601,7 +601,7 @@ ___ ### hasCustomersGroupCondition -▸ **hasCustomersGroupCondition**(`discount`): `boolean` +**hasCustomersGroupCondition**(`discount`): `boolean` #### Parameters @@ -635,7 +635,7 @@ ___ ### hasExpired -▸ **hasExpired**(`discount`): `boolean` +**hasExpired**(`discount`): `boolean` #### Parameters @@ -669,7 +669,7 @@ ___ ### hasNotStarted -▸ **hasNotStarted**(`discount`): `boolean` +**hasNotStarted**(`discount`): `boolean` #### Parameters @@ -703,7 +703,7 @@ ___ ### hasReachedLimit -▸ **hasReachedLimit**(`discount`): `boolean` +**hasReachedLimit**(`discount`): `boolean` #### Parameters @@ -737,7 +737,7 @@ ___ ### isDisabled -▸ **isDisabled**(`discount`): `boolean` +**isDisabled**(`discount`): `boolean` #### Parameters @@ -771,7 +771,7 @@ ___ ### isValidForRegion -▸ **isValidForRegion**(`discount`, `region_id`): `Promise`<`boolean`\> +**isValidForRegion**(`discount`, `region_id`): `Promise`<`boolean`\> #### Parameters @@ -822,7 +822,7 @@ ___ ### list -▸ **list**(`selector?`, `config?`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)[]\> +**list**(`selector?`, `config?`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)[]\> #### Parameters @@ -882,7 +882,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`Discount`](admin_collections.internal.Discount.mdx)[], `number`]\> +**listAndCount**(`selector?`, `config?`): `Promise`<[[`Discount`](admin_collections.internal.Discount.mdx)[], `number`]\> #### Parameters @@ -941,7 +941,7 @@ ___ ### listByCodes -▸ **listByCodes**(`discountCodes`, `config?`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)[]\> +**listByCodes**(`discountCodes`, `config?`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)[]\> List all the discounts corresponding to the given codes @@ -1003,7 +1003,7 @@ ___ ### removeRegion -▸ **removeRegion**(`discountId`, `regionId`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> +**removeRegion**(`discountId`, `regionId`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> Removes a region from the discount regions array. @@ -1056,7 +1056,7 @@ ___ ### retrieve -▸ **retrieve**(`discountId`, `config?`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> +**retrieve**(`discountId`, `config?`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> Gets a discount by id. @@ -1109,7 +1109,7 @@ ___ ### retrieveByCode -▸ **retrieveByCode**(`discountCode`, `config?`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> +**retrieveByCode**(`discountCode`, `config?`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> Gets the discount by discount code. @@ -1162,7 +1162,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -1200,7 +1200,7 @@ ___ ### update -▸ **update**(`discountId`, `update`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> +**update**(`discountId`, `update`): `Promise`<[`Discount`](admin_collections.internal.Discount.mdx)\> Updates a discount. @@ -1253,7 +1253,7 @@ ___ ### validateDiscountForCartOrThrow -▸ **validateDiscountForCartOrThrow**(`cart`, `discount`): `Promise`<`void`\> +**validateDiscountForCartOrThrow**(`cart`, `discount`): `Promise`<`void`\> #### Parameters @@ -1295,7 +1295,7 @@ ___ ### validateDiscountForProduct -▸ **validateDiscountForProduct**(`discountRuleId`, `productId?`): `Promise`<`boolean`\> +**validateDiscountForProduct**(`discountRuleId`, `productId?`): `Promise`<`boolean`\> #### Parameters @@ -1346,7 +1346,7 @@ ___ ### validateDiscountRule\_ -▸ **validateDiscountRule_**<`T`\>(`discountRule`): `T` +**validateDiscountRule_**<`T`\>(`discountRule`): `T` Creates a discount rule with provided data given that the data is validated. @@ -1384,7 +1384,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`DiscountService`](admin_discounts.internal.internal.DiscountService.mdx) +**withTransaction**(`transactionManager?`): [`DiscountService`](admin_discounts.internal.internal.DiscountService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DraftOrderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DraftOrderService.mdx index 0f378ff40a..e56a5553d1 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DraftOrderService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.DraftOrderService.mdx @@ -157,7 +157,7 @@ Handles draft orders ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -182,7 +182,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -259,7 +259,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> +**create**(`data`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> Creates a draft order. @@ -304,7 +304,7 @@ ___ ### delete -▸ **delete**(`draftOrderId`): `Promise`<`undefined` \| [`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> +**delete**(`draftOrderId`): `Promise`<`undefined` \| [`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> Deletes draft order idempotently. @@ -349,7 +349,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)[]\> Lists draft orders @@ -411,7 +411,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`): `Promise`<[[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)[], `number`]\> Lists draft orders alongside the count @@ -472,7 +472,7 @@ ___ ### registerCartCompletion -▸ **registerCartCompletion**(`draftOrderId`, `orderId`): `Promise`<`UpdateResult`\> +**registerCartCompletion**(`draftOrderId`, `orderId`): `Promise`<`UpdateResult`\> Registers a draft order as completed, when an order has been completed. @@ -525,7 +525,7 @@ ___ ### retrieve -▸ **retrieve**(`draftOrderId`, `config?`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> +**retrieve**(`draftOrderId`, `config?`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> Retrieves a draft order with the given id. @@ -578,7 +578,7 @@ ___ ### retrieveByCartId -▸ **retrieveByCartId**(`cartId`, `config?`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> +**retrieveByCartId**(`cartId`, `config?`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> Retrieves a draft order based on its associated cart id @@ -631,7 +631,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -669,7 +669,7 @@ ___ ### update -▸ **update**(`id`, `data`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> +**update**(`id`, `data`): `Promise`<[`DraftOrder`](admin_collections.internal.DraftOrder.mdx)\> Updates a draft order with the given data @@ -730,7 +730,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`DraftOrderService`](admin_discounts.internal.internal.DraftOrderService.mdx) +**withTransaction**(`transactionManager?`): [`DraftOrderService`](admin_discounts.internal.internal.DraftOrderService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.EventBusService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.EventBusService.mdx index ef944ee3b8..e608d5ef0f 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.EventBusService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.EventBusService.mdx @@ -112,7 +112,7 @@ subscribers when events happen. Events will run asynchronously. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -137,7 +137,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -214,7 +214,7 @@ ___ ### emit -▸ **emit**<`T`\>(`data`): `Promise`<`void` \| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> +**emit**<`T`\>(`data`): `Promise`<`void` \| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> Calls all subscribers when an event occurs. @@ -270,7 +270,7 @@ Calls all subscribers when an event occurs. [IEventBusService](../interfaces/admin_discounts.internal.IEventBusService.mdx).[emit](../interfaces/admin_discounts.internal.IEventBusService.mdx#emit) -▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)\> +**emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void` \| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)\> Calls all subscribers when an event occurs. @@ -346,7 +346,7 @@ ___ ### enqueuer\_ -▸ **enqueuer_**(): `Promise`<`void`\> +**enqueuer_**(): `Promise`<`void`\> #### Returns @@ -367,7 +367,7 @@ ___ ### listJobs -▸ `Protected` **listJobs**(`listConfig`): `Promise`<`never`[] \| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> +`Protected` **listJobs**(`listConfig`): `Promise`<`never`[] \| [`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> #### Parameters @@ -410,7 +410,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -448,7 +448,7 @@ ___ ### startEnqueuer -▸ **startEnqueuer**(): `void` +**startEnqueuer**(): `void` #### Returns @@ -469,7 +469,7 @@ ___ ### stopEnqueuer -▸ **stopEnqueuer**(): `Promise`<`void`\> +**stopEnqueuer**(): `Promise`<`void`\> #### Returns @@ -490,7 +490,7 @@ ___ ### subscribe -▸ **subscribe**(`event`, `subscriber`, `context?`): [`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx) +**subscribe**(`event`, `subscriber`, `context?`): [`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx) Adds a function to a list of event subscribers. @@ -546,7 +546,7 @@ ___ ### unsubscribe -▸ **unsubscribe**(`event`, `subscriber`, `context`): [`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx) +**unsubscribe**(`event`, `subscriber`, `context`): [`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx) Removes function from the list of event subscribers. @@ -602,7 +602,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx) +**withTransaction**(`transactionManager?`): [`EventBusService`](admin_discounts.internal.internal.EventBusService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FulfillmentProviderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FulfillmentProviderService.mdx index 433cf486d5..f4b82a5382 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FulfillmentProviderService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.FulfillmentProviderService.mdx @@ -75,7 +75,7 @@ Helps retrieve fulfillment providers ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -100,7 +100,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -177,7 +177,7 @@ ___ ### calculatePrice -▸ **calculatePrice**(`option`, `data`, `cart?`): `Promise`<`number`\> +**calculatePrice**(`option`, `data`, `cart?`): `Promise`<`number`\> #### Parameters @@ -236,7 +236,7 @@ ___ ### canCalculate -▸ **canCalculate**(`option`): `Promise`<`boolean`\> +**canCalculate**(`option`): `Promise`<`boolean`\> #### Parameters @@ -279,7 +279,7 @@ ___ ### cancelFulfillment -▸ **cancelFulfillment**(`fulfillment`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> +**cancelFulfillment**(`fulfillment`): `Promise`<[`Fulfillment`](admin_collections.internal.Fulfillment.mdx)\> #### Parameters @@ -322,7 +322,7 @@ ___ ### createFulfillment -▸ **createFulfillment**(`method`, `items`, `order`, `fulfillment`): `Promise`\> +**createFulfillment**(`method`, `items`, `order`, `fulfillment`): `Promise`\> #### Parameters @@ -406,7 +406,7 @@ ___ ### createReturn -▸ **createReturn**(`returnOrder`): `Promise`\> +**createReturn**(`returnOrder`): `Promise`\> #### Parameters @@ -466,7 +466,7 @@ ___ ### list -▸ **list**(): `Promise`<[`FulfillmentProvider`](admin_collections.internal.FulfillmentProvider.mdx)[]\> +**list**(): `Promise`<[`FulfillmentProvider`](admin_collections.internal.FulfillmentProvider.mdx)[]\> #### Returns @@ -505,7 +505,7 @@ ___ ### listFulfillmentOptions -▸ **listFulfillmentOptions**(`providerIds`): `Promise`<[`FulfillmentOptions`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentoptions)[]\> +**listFulfillmentOptions**(`providerIds`): `Promise`<[`FulfillmentOptions`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentoptions)[]\> #### Parameters @@ -557,7 +557,7 @@ ___ ### registerInstalledProviders -▸ **registerInstalledProviders**(`providers`): `Promise`<`void`\> +**registerInstalledProviders**(`providers`): `Promise`<`void`\> #### Parameters @@ -591,7 +591,7 @@ ___ ### retrieveDocuments -▸ **retrieveDocuments**(`providerId`, `fulfillmentData`, `documentType`): `Promise`<`any`\> +**retrieveDocuments**(`providerId`, `fulfillmentData`, `documentType`): `Promise`<`any`\> Fetches documents from the fulfillment provider @@ -652,7 +652,7 @@ ___ ### retrieveProvider -▸ **retrieveProvider**(`providerId`): `any` +**retrieveProvider**(`providerId`): `any` #### Parameters @@ -686,7 +686,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -724,7 +724,7 @@ ___ ### validateFulfillmentData -▸ **validateFulfillmentData**(`option`, `data`, `cart`): `Promise`\> +**validateFulfillmentData**(`option`, `data`, `cart`): `Promise`\> #### Parameters @@ -800,7 +800,7 @@ ___ ### validateOption -▸ **validateOption**(`option`): `Promise`<`boolean`\> +**validateOption**(`option`): `Promise`<`boolean`\> #### Parameters @@ -843,7 +843,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`FulfillmentProviderService`](admin_discounts.internal.internal.FulfillmentProviderService.mdx) +**withTransaction**(`transactionManager?`): [`FulfillmentProviderService`](admin_discounts.internal.internal.FulfillmentProviderService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GiftCardService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GiftCardService.mdx index 24e81b90ce..651536ed1d 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GiftCardService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.GiftCardService.mdx @@ -107,7 +107,7 @@ Provides layer to manipulate gift cards. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -132,7 +132,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -209,7 +209,7 @@ ___ ### create -▸ **create**(`giftCard`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> +**create**(`giftCard`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> Creates a gift card with provided data given that the data is validated. @@ -254,7 +254,7 @@ ___ ### createTransaction -▸ **createTransaction**(`data`): `Promise`<`string`\> +**createTransaction**(`data`): `Promise`<`string`\> #### Parameters @@ -297,7 +297,7 @@ ___ ### delete -▸ **delete**(`giftCardId`): `Promise`<`void` \| [`GiftCard`](admin_collections.internal.GiftCard.mdx)\> +**delete**(`giftCardId`): `Promise`<`void` \| [`GiftCard`](admin_collections.internal.GiftCard.mdx)\> Deletes a gift card idempotently @@ -342,7 +342,7 @@ ___ ### list -▸ **list**(`selector?`, `config?`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)[]\> +**list**(`selector?`, `config?`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)[]\> #### Parameters @@ -402,7 +402,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`GiftCard`](admin_collections.internal.GiftCard.mdx)[], `number`]\> +**listAndCount**(`selector?`, `config?`): `Promise`<[[`GiftCard`](admin_collections.internal.GiftCard.mdx)[], `number`]\> #### Parameters @@ -461,7 +461,7 @@ ___ ### retrieve -▸ **retrieve**(`giftCardId`, `config?`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> +**retrieve**(`giftCardId`, `config?`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> Gets a gift card by id. @@ -514,7 +514,7 @@ ___ ### retrieveByCode -▸ **retrieveByCode**(`code`, `config?`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> +**retrieveByCode**(`code`, `config?`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> #### Parameters @@ -565,7 +565,7 @@ ___ ### retrieve\_ -▸ `Protected` **retrieve_**(`selector`, `config?`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> +`Protected` **retrieve_**(`selector`, `config?`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> #### Parameters @@ -616,7 +616,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -654,7 +654,7 @@ ___ ### update -▸ **update**(`giftCardId`, `update`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> +**update**(`giftCardId`, `update`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\> Updates a giftCard. @@ -707,7 +707,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`GiftCardService`](admin_discounts.internal.internal.GiftCardService.mdx) +**withTransaction**(`transactionManager?`): [`GiftCardService`](admin_discounts.internal.internal.GiftCardService.mdx) #### Parameters @@ -745,7 +745,7 @@ ___ ### generateCode -▸ `Static` **generateCode**(): `string` +`Static` **generateCode**(): `string` Generates a 16 character gift card code @@ -768,7 +768,7 @@ ___ ### resolveTaxRate -▸ `Static` `Protected` **resolveTaxRate**(`giftCardTaxRate`, `region`): ``null`` \| `number` +`Static` `Protected` **resolveTaxRate**(`giftCardTaxRate`, `region`): ``null`` \| `number` The tax_rate of the giftcard can depend on whether regions tax gift cards, an input provided by the user or the tax rate. Based on these conditions, tax_rate changes. diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IdempotencyKeyService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IdempotencyKeyService.mdx index 2a95a970fb..41b4eff002 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IdempotencyKeyService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.IdempotencyKeyService.mdx @@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -90,7 +90,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -167,7 +167,7 @@ ___ ### create -▸ **create**(`payload`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> +**create**(`payload`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> Creates an idempotency key for a request. If no idempotency key is provided in request, we will create a unique @@ -214,7 +214,7 @@ ___ ### initializeRequest -▸ **initializeRequest**(`headerKey`, `reqMethod`, `reqParams`, `reqPath`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> +**initializeRequest**(`headerKey`, `reqMethod`, `reqParams`, `reqPath`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> Execute the initial steps in a idempotent request. @@ -283,7 +283,7 @@ ___ ### lock -▸ **lock**(`idempotencyKey`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> +**lock**(`idempotencyKey`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> Locks an idempotency. @@ -328,7 +328,7 @@ ___ ### retrieve -▸ **retrieve**(`idempotencyKeyOrSelector`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> +**retrieve**(`idempotencyKeyOrSelector`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> Retrieves an idempotency key @@ -373,7 +373,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -411,7 +411,7 @@ ___ ### update -▸ **update**(`idempotencyKey`, `update`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> +**update**(`idempotencyKey`, `update`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> Locks an idempotency. @@ -464,7 +464,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`IdempotencyKeyService`](admin_discounts.internal.internal.IdempotencyKeyService.mdx) +**withTransaction**(`transactionManager?`): [`IdempotencyKeyService`](admin_discounts.internal.internal.IdempotencyKeyService.mdx) #### Parameters @@ -502,7 +502,7 @@ ___ ### workStage -▸ **workStage**(`idempotencyKey`, `callback`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> +**workStage**(`idempotencyKey`, `callback`): `Promise`<[`IdempotencyKey`](admin_discounts.internal.internal.IdempotencyKey.mdx)\> Performs an atomic work stage. An atomic work stage contains some related functionality, that needs to be diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemAdjustmentService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemAdjustmentService.mdx index 17c3bf6cd1..0b08d590b6 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemAdjustmentService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemAdjustmentService.mdx @@ -75,7 +75,7 @@ Provides layer to manipulate line item adjustments. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -100,7 +100,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -177,7 +177,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)\> +**create**(`data`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)\> Creates a line item adjustment @@ -222,7 +222,7 @@ ___ ### createAdjustmentForLineItem -▸ **createAdjustmentForLineItem**(`cart`, `lineItem`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[]\> +**createAdjustmentForLineItem**(`cart`, `lineItem`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[]\> Creates adjustment for a line item @@ -284,7 +284,7 @@ ___ ### createAdjustments -▸ **createAdjustments**(`cart`, `lineItem?`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[] \| [`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[][]\> +**createAdjustments**(`cart`, `lineItem?`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[] \| [`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[][]\> Creates adjustment for a line item @@ -337,7 +337,7 @@ ___ ### delete -▸ **delete**(`selectorOrIds`): `Promise`<`void`\> +**delete**(`selectorOrIds`): `Promise`<`void`\> Deletes line item adjustments matching a selector @@ -373,7 +373,7 @@ ___ ### generateAdjustments -▸ **generateAdjustments**(`calculationContextData`, `generatedLineItem`, `context`): `Promise`<[`GeneratedAdjustment`](../../admin_discounts/modules/admin_discounts.internal.mdx#generatedadjustment)[]\> +**generateAdjustments**(`calculationContextData`, `generatedLineItem`, `context`): `Promise`<[`GeneratedAdjustment`](../../admin_discounts/modules/admin_discounts.internal.mdx#generatedadjustment)[]\> Creates adjustment for a line item @@ -443,7 +443,7 @@ ___ ### list -▸ **list**(`selector?`, `config?`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[]\> +**list**(`selector?`, `config?`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)[]\> Lists line item adjustments @@ -505,7 +505,7 @@ ___ ### retrieve -▸ **retrieve**(`lineItemAdjustmentId`, `config?`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)\> +**retrieve**(`lineItemAdjustmentId`, `config?`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)\> Retrieves a line item adjustment by id. @@ -558,7 +558,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -596,7 +596,7 @@ ___ ### update -▸ **update**(`id`, `data`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)\> +**update**(`id`, `data`): `Promise`<[`LineItemAdjustment`](admin_collections.internal.LineItemAdjustment.mdx)\> Creates a line item adjustment @@ -649,7 +649,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`LineItemAdjustmentService`](admin_discounts.internal.internal.LineItemAdjustmentService.mdx) +**withTransaction**(`transactionManager?`): [`LineItemAdjustmentService`](admin_discounts.internal.internal.LineItemAdjustmentService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemService.mdx index 83738f360d..95eb01732e 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.LineItemService.mdx @@ -137,7 +137,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -162,7 +162,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -239,7 +239,7 @@ ___ ### cloneTo -▸ **cloneTo**(`ids`, `data?`, `options?`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> +**cloneTo**(`ids`, `data?`, `options?`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> #### Parameters @@ -315,7 +315,7 @@ ___ ### create -▸ **create**<`T`, `TResult`\>(`data`): `Promise`<`TResult`\> +**create**<`T`, `TResult`\>(`data`): `Promise`<`TResult`\> Create a line item @@ -370,7 +370,7 @@ ___ ### createReturnLines -▸ **createReturnLines**(`returnId`, `cartId`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> +**createReturnLines**(`returnId`, `cartId`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> Creates return line items for a given cart based on the return items in a return. @@ -433,7 +433,7 @@ ___ ### createTaxLine -▸ **createTaxLine**(`args`): [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx) +**createTaxLine**(`args`): [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx) Create a line item tax line. @@ -469,7 +469,7 @@ ___ ### delete -▸ **delete**(`id`): `Promise`<`undefined` \| ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx)\> +**delete**(`id`): `Promise`<`undefined` \| ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx)\> Deletes a line item. @@ -514,7 +514,7 @@ ___ ### deleteWithTaxLines -▸ **deleteWithTaxLines**(`id`): `Promise`<`undefined` \| ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx)\> +**deleteWithTaxLines**(`id`): `Promise`<`undefined` \| ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx)\> #### Parameters @@ -562,7 +562,7 @@ ___ ### generate -▸ **generate**<`T`, `TResult`\>(`variantIdOrData`, `regionIdOrContext`, `quantity?`, `context?`): `Promise`<`TResult`\> +**generate**<`T`, `TResult`\>(`variantIdOrData`, `regionIdOrContext`, `quantity?`, `context?`): `Promise`<`TResult`\> Generate a single or multiple line item without persisting the data into the db @@ -641,7 +641,7 @@ ___ ### generateLineItem -▸ `Protected` **generateLineItem**(`variant`, `quantity`, `context`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)\> +`Protected` **generateLineItem**(`variant`, `quantity`, `context`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)\> #### Parameters @@ -764,7 +764,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> #### Parameters @@ -824,7 +824,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `config?`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)\> +**retrieve**(`id`, `config?`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)\> Retrieves a line item by its id. @@ -877,7 +877,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -915,7 +915,7 @@ ___ ### update -▸ **update**(`idOrSelector`, `data`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> +**update**(`idOrSelector`, `data`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> Updates a line item @@ -977,7 +977,7 @@ ___ ### validateGenerateArguments -▸ `Protected` **validateGenerateArguments**<`T`, `TResult`\>(`variantIdOrData`, `regionIdOrContext`, `quantity?`): `void` +`Protected` **validateGenerateArguments**<`T`, `TResult`\>(`variantIdOrData`, `regionIdOrContext`, `quantity?`): `void` \>[] +**usePreCartCreation**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\>[] #### Returns @@ -387,7 +387,7 @@ ___ ### validateMiddleware\_ -▸ **validateMiddleware_**(`fn`): `void` +**validateMiddleware_**(`fn`): `void` Validates a middleware function, throws if fn is not of type function. diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NewTotalsService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NewTotalsService.mdx index c16319ea5c..728d671ba1 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NewTotalsService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NewTotalsService.mdx @@ -81,7 +81,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -106,7 +106,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -183,7 +183,7 @@ ___ ### getGiftCardTotals -▸ **getGiftCardTotals**(`giftCardableAmount`, `«destructured»`): `Promise`<{ `tax_total`: `number` ; `total`: `number` }\> +**getGiftCardTotals**(`giftCardableAmount`, `«destructured»`): `Promise`<{ `tax_total`: `number` ; `total`: `number` }\> Calculate and return the gift cards totals @@ -260,7 +260,7 @@ ___ ### getGiftCardTransactionsTotals -▸ **getGiftCardTransactionsTotals**(`«destructured»`): { `tax_total`: `number` ; `total`: `number` } +**getGiftCardTransactionsTotals**(`«destructured»`): { `tax_total`: `number` ; `total`: `number` } Calculate and return the gift cards totals based on their transactions @@ -347,7 +347,7 @@ ___ ### getLineItemRefund -▸ **getLineItemRefund**(`lineItem`, `«destructured»`): `number` +**getLineItemRefund**(`lineItem`, `«destructured»`): `number` Return the amount that can be refund on a line item @@ -447,7 +447,7 @@ ___ ### getLineItemRefundLegacy -▸ `Protected` **getLineItemRefundLegacy**(`lineItem`, `«destructured»`): `number` +`Protected` **getLineItemRefundLegacy**(`lineItem`, `«destructured»`): `number` #### Parameters @@ -537,7 +537,7 @@ ___ ### getLineItemTotals -▸ **getLineItemTotals**(`items`, `«destructured»`): `Promise`<{ `[lineItemId: string]`: [`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals); }\> +**getLineItemTotals**(`items`, `«destructured»`): `Promise`<{ `[lineItemId: string]`: [`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals); }\> Calculate and return the items totals for either the legacy calculation or the new calculation @@ -614,7 +614,7 @@ ___ ### getLineItemTotalsLegacy -▸ `Protected` **getLineItemTotalsLegacy**(`item`, `«destructured»`): `Promise`<[`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals)\> +`Protected` **getLineItemTotalsLegacy**(`item`, `«destructured»`): `Promise`<[`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals)\> Calculate and return the legacy calculated totals using the tax rate @@ -707,7 +707,7 @@ ___ ### getLineItemTotals\_ -▸ `Protected` **getLineItemTotals_**(`item`, `«destructured»`): `Promise`<[`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals)\> +`Protected` **getLineItemTotals_**(`item`, `«destructured»`): `Promise`<[`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals)\> Calculate and return the totals for an item @@ -808,7 +808,7 @@ ___ ### getShippingMethodTotals -▸ **getShippingMethodTotals**(`shippingMethods`, `«destructured»`): `Promise`<{ `[shippingMethodId: string]`: [`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals); }\> +**getShippingMethodTotals**(`shippingMethods`, `«destructured»`): `Promise`<{ `[shippingMethodId: string]`: [`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals); }\> Calculate and return the shipping methods totals for either the legacy calculation or the new calculation @@ -893,7 +893,7 @@ ___ ### getShippingMethodTotalsLegacy -▸ `Protected` **getShippingMethodTotalsLegacy**(`shippingMethod`, `«destructured»`): `Promise`<[`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals)\> +`Protected` **getShippingMethodTotalsLegacy**(`shippingMethod`, `«destructured»`): `Promise`<[`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals)\> Calculate and return the shipping method totals legacy using the tax rate @@ -970,7 +970,7 @@ ___ ### getShippingMethodTotals\_ -▸ `Protected` **getShippingMethodTotals_**(`shippingMethod`, `«destructured»`): `Promise`<[`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals)\> +`Protected` **getShippingMethodTotals_**(`shippingMethod`, `«destructured»`): `Promise`<[`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals)\> Calculate and return the shipping method totals @@ -1055,7 +1055,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -1093,7 +1093,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`NewTotalsService`](admin_discounts.internal.internal.NewTotalsService.mdx) +**withTransaction**(`transactionManager?`): [`NewTotalsService`](admin_discounts.internal.internal.NewTotalsService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NoteService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NoteService.mdx index 8baad27466..2bed30ae87 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NoteService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NoteService.mdx @@ -105,7 +105,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -130,7 +130,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -207,7 +207,7 @@ ___ ### create -▸ **create**(`data`, `config?`): `Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)\> +**create**(`data`, `config?`): `Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)\> Creates a note associated with a given author @@ -268,7 +268,7 @@ ___ ### delete -▸ **delete**(`noteId`): `Promise`<`void`\> +**delete**(`noteId`): `Promise`<`void`\> Deletes a given note @@ -304,7 +304,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)[]\> Fetches all notes related to the given selector @@ -366,7 +366,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Note`](admin_discounts.internal.internal.Note.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`): `Promise`<[[`Note`](admin_discounts.internal.internal.Note.mdx)[], `number`]\> Fetches all notes related to the given selector @@ -427,7 +427,7 @@ ___ ### retrieve -▸ **retrieve**(`noteId`, `config?`): `Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)\> +**retrieve**(`noteId`, `config?`): `Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)\> Retrieves a specific note. @@ -480,7 +480,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -518,7 +518,7 @@ ___ ### update -▸ **update**(`noteId`, `value`): `Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)\> +**update**(`noteId`, `value`): `Promise`<[`Note`](admin_discounts.internal.internal.Note.mdx)\> Updates a given note with a new value @@ -571,7 +571,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`NoteService`](admin_discounts.internal.internal.NoteService.mdx) +**withTransaction**(`transactionManager?`): [`NoteService`](admin_discounts.internal.internal.NoteService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NotificationService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NotificationService.mdx index 8008fb8866..65d68542a9 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NotificationService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.NotificationService.mdx @@ -105,7 +105,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -130,7 +130,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -207,7 +207,7 @@ ___ ### handleEvent -▸ **handleEvent**(`eventName`, `data`): `Promise`<`undefined` \| `void` \| [`Notification`](admin_discounts.internal.internal.Notification.mdx)[]\> +**handleEvent**(`eventName`, `data`): `Promise`<`undefined` \| `void` \| [`Notification`](admin_discounts.internal.internal.Notification.mdx)[]\> Handles an event by relaying the event data to the subscribing providers. The result of the notification send will be persisted in the database in @@ -262,7 +262,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`Notification`](admin_discounts.internal.internal.Notification.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`Notification`](admin_discounts.internal.internal.Notification.mdx)[]\> Retrieves a list of notifications. @@ -324,7 +324,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Notification`](admin_discounts.internal.internal.Notification.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`): `Promise`<[[`Notification`](admin_discounts.internal.internal.Notification.mdx)[], `number`]\> Retrieves a list of notifications and total count. @@ -385,7 +385,7 @@ ___ ### registerAttachmentGenerator -▸ **registerAttachmentGenerator**(`service`): `void` +**registerAttachmentGenerator**(`service`): `void` Registers an attachment generator to the service. The generator can be used to generate on demand invoices or other documents. @@ -422,7 +422,7 @@ ___ ### registerInstalledProviders -▸ **registerInstalledProviders**(`providerIds`): `Promise`<`void`\> +**registerInstalledProviders**(`providerIds`): `Promise`<`void`\> Takes a list of notification provider ids and persists them in the database. @@ -458,7 +458,7 @@ ___ ### resend -▸ **resend**(`id`, `config?`): `Promise`<[`Notification`](admin_discounts.internal.internal.Notification.mdx)\> +**resend**(`id`, `config?`): `Promise`<[`Notification`](admin_discounts.internal.internal.Notification.mdx)\> Resends a notification by retrieving a prior notification and calling the underlying provider's resendNotification method. @@ -512,7 +512,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `config?`): `Promise`<[`Notification`](admin_discounts.internal.internal.Notification.mdx)\> +**retrieve**(`id`, `config?`): `Promise`<[`Notification`](admin_discounts.internal.internal.Notification.mdx)\> Retrieves a notification with a given id @@ -565,7 +565,7 @@ ___ ### retrieveProvider\_ -▸ `Protected` **retrieveProvider_**(`id`): [`AbstractNotificationService`](admin_discounts.internal.internal.AbstractNotificationService.mdx) +`Protected` **retrieveProvider_**(`id`): [`AbstractNotificationService`](admin_discounts.internal.internal.AbstractNotificationService.mdx) Finds a provider with a given id. Will throw a NOT_FOUND error if the resolution fails. @@ -602,7 +602,7 @@ ___ ### send -▸ **send**(`event`, `eventData`, `providerId`): `Promise`<`undefined` \| [`Notification`](admin_discounts.internal.internal.Notification.mdx)\> +**send**(`event`, `eventData`, `providerId`): `Promise`<`undefined` \| [`Notification`](admin_discounts.internal.internal.Notification.mdx)\> Sends a notification, by calling the given provider's sendNotification method. Persists the Notification in the database. @@ -664,7 +664,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -702,7 +702,7 @@ ___ ### subscribe -▸ **subscribe**(`eventName`, `providerId`): `void` +**subscribe**(`eventName`, `providerId`): `void` Subscribes a given provider to an event. @@ -746,7 +746,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`NotificationService`](admin_discounts.internal.internal.NotificationService.mdx) +**withTransaction**(`transactionManager?`): [`NotificationService`](admin_discounts.internal.internal.NotificationService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OauthService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OauthService.mdx index f58fd88b68..0b16e56430 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OauthService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OauthService.mdx @@ -105,7 +105,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -130,7 +130,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -207,7 +207,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> +**create**(`data`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> #### Parameters @@ -250,7 +250,7 @@ ___ ### generateToken -▸ **generateToken**(`appName`, `code`, `state`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> +**generateToken**(`appName`, `code`, `state`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> #### Parameters @@ -309,7 +309,7 @@ ___ ### list -▸ **list**(`selector`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)[]\> +**list**(`selector`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)[]\> #### Parameters @@ -361,7 +361,7 @@ ___ ### refreshToken -▸ **refreshToken**(`appName`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> +**refreshToken**(`appName`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> #### Parameters @@ -404,7 +404,7 @@ ___ ### registerOauthApp -▸ **registerOauthApp**(`appDetails`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> +**registerOauthApp**(`appDetails`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> #### Parameters @@ -447,7 +447,7 @@ ___ ### retrieve -▸ **retrieve**(`oauthId`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> +**retrieve**(`oauthId`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> #### Parameters @@ -490,7 +490,7 @@ ___ ### retrieveByName -▸ **retrieveByName**(`appName`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> +**retrieveByName**(`appName`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> #### Parameters @@ -533,7 +533,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -571,7 +571,7 @@ ___ ### update -▸ **update**(`id`, `update`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> +**update**(`id`, `update`): `Promise`<[`Oauth`](admin_discounts.internal.internal.Oauth.mdx)\> #### Parameters @@ -622,7 +622,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`OauthService`](admin_discounts.internal.internal.OauthService.mdx) +**withTransaction**(`transactionManager?`): [`OauthService`](admin_discounts.internal.internal.OauthService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditItemChangeService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditItemChangeService.mdx index a16c6a3629..5519ba10c5 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditItemChangeService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditItemChangeService.mdx @@ -113,7 +113,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -138,7 +138,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -215,7 +215,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)\> +**create**(`data`): `Promise`<[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)\> #### Parameters @@ -258,7 +258,7 @@ ___ ### delete -▸ **delete**(`itemChangeIds`): `Promise`<`void`\> +**delete**(`itemChangeIds`): `Promise`<`void`\> #### Parameters @@ -292,7 +292,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)[]\> #### Parameters @@ -352,7 +352,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `config?`): `Promise`<[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)\> +**retrieve**(`id`, `config?`): `Promise`<[`OrderItemChange`](admin_collections.internal.OrderItemChange.mdx)\> #### Parameters @@ -403,7 +403,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -441,7 +441,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`OrderEditItemChangeService`](admin_discounts.internal.internal.OrderEditItemChangeService.mdx) +**withTransaction**(`transactionManager?`): [`OrderEditItemChangeService`](admin_discounts.internal.internal.OrderEditItemChangeService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditService.mdx index 30762a1c50..bdf8a582fd 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderEditService.mdx @@ -201,7 +201,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -226,7 +226,7 @@ TransactionBaseService.activeManager\_ ### addLineItem -▸ **addLineItem**(`orderEditId`, `data`): `Promise`<`void`\> +**addLineItem**(`orderEditId`, `data`): `Promise`<`void`\> #### Parameters @@ -268,7 +268,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -345,7 +345,7 @@ ___ ### cancel -▸ **cancel**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> +**cancel**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> #### Parameters @@ -404,7 +404,7 @@ ___ ### confirm -▸ **confirm**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> +**confirm**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> #### Parameters @@ -463,7 +463,7 @@ ___ ### create -▸ **create**(`data`, `context`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> +**create**(`data`, `context`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> #### Parameters @@ -522,7 +522,7 @@ ___ ### decline -▸ **decline**(`orderEditId`, `context`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> +**decline**(`orderEditId`, `context`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> #### Parameters @@ -589,7 +589,7 @@ ___ ### decorateTotals -▸ **decorateTotals**(`orderEdit`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> +**decorateTotals**(`orderEdit`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> #### Parameters @@ -632,7 +632,7 @@ ___ ### delete -▸ **delete**(`id`): `Promise`<`void`\> +**delete**(`id`): `Promise`<`void`\> #### Parameters @@ -666,7 +666,7 @@ ___ ### deleteClonedItems -▸ `Protected` **deleteClonedItems**(`orderEditId`): `Promise`<`void`\> +`Protected` **deleteClonedItems**(`orderEditId`): `Promise`<`void`\> #### Parameters @@ -700,7 +700,7 @@ ___ ### deleteItemChange -▸ **deleteItemChange**(`orderEditId`, `itemChangeId`): `Promise`<`void`\> +**deleteItemChange**(`orderEditId`, `itemChangeId`): `Promise`<`void`\> #### Parameters @@ -742,7 +742,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)[]\> #### Parameters @@ -802,7 +802,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`): `Promise`<[[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)[], `number`]\> #### Parameters @@ -861,7 +861,7 @@ ___ ### refreshAdjustments -▸ **refreshAdjustments**(`orderEditId`, `config?`): `Promise`<`void`\> +**refreshAdjustments**(`orderEditId`, `config?`): `Promise`<`void`\> #### Parameters @@ -911,7 +911,7 @@ ___ ### removeLineItem -▸ **removeLineItem**(`orderEditId`, `lineItemId`): `Promise`<`void`\> +**removeLineItem**(`orderEditId`, `lineItemId`): `Promise`<`void`\> #### Parameters @@ -953,7 +953,7 @@ ___ ### requestConfirmation -▸ **requestConfirmation**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> +**requestConfirmation**(`orderEditId`, `context?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> #### Parameters @@ -1012,7 +1012,7 @@ ___ ### retrieve -▸ **retrieve**(`orderEditId`, `config?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> +**retrieve**(`orderEditId`, `config?`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> #### Parameters @@ -1063,7 +1063,7 @@ ___ ### retrieveActive -▸ `Protected` **retrieveActive**(`orderId`, `config?`): `Promise`<`undefined` \| ``null`` \| [`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> +`Protected` **retrieveActive**(`orderId`, `config?`): `Promise`<`undefined` \| ``null`` \| [`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> #### Parameters @@ -1114,7 +1114,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -1152,7 +1152,7 @@ ___ ### update -▸ **update**(`orderEditId`, `data`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> +**update**(`orderEditId`, `data`): `Promise`<[`OrderEdit`](admin_collections.internal.OrderEdit.mdx)\> #### Parameters @@ -1203,7 +1203,7 @@ ___ ### updateLineItem -▸ **updateLineItem**(`orderEditId`, `itemId`, `data`): `Promise`<`void`\> +**updateLineItem**(`orderEditId`, `itemId`, `data`): `Promise`<`void`\> Create or update order edit item change line item and apply the quantity - If the item change already exists then update the quantity of the line item as well as the line adjustments @@ -1265,7 +1265,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`OrderEditService`](admin_discounts.internal.internal.OrderEditService.mdx) +**withTransaction**(`transactionManager?`): [`OrderEditService`](admin_discounts.internal.internal.OrderEditService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderService.mdx index 4e26b1efe0..a47c1c894c 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.OrderService.mdx @@ -369,7 +369,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -394,7 +394,7 @@ TransactionBaseService.activeManager\_ ### addShippingMethod -▸ **addShippingMethod**(`orderId`, `optionId`, `data?`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**addShippingMethod**(`orderId`, `optionId`, `data?`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> #### Parameters @@ -461,7 +461,7 @@ ___ ### archive -▸ **archive**(`orderId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**archive**(`orderId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> Archives an order. It only alloved, if the order has been fulfilled and payment has been captured. @@ -507,7 +507,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -584,7 +584,7 @@ ___ ### cancel -▸ **cancel**(`orderId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**cancel**(`orderId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> Cancels an order. Throws if fulfillment process has been initiated. @@ -631,7 +631,7 @@ ___ ### cancelFulfillment -▸ **cancelFulfillment**(`fulfillmentId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**cancelFulfillment**(`fulfillmentId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> Cancels a fulfillment (if related to an order) @@ -676,7 +676,7 @@ ___ ### capturePayment -▸ **capturePayment**(`orderId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**capturePayment**(`orderId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> Captures payment for an order. @@ -721,7 +721,7 @@ ___ ### completeOrder -▸ **completeOrder**(`orderId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**completeOrder**(`orderId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> #### Parameters @@ -764,7 +764,7 @@ ___ ### createFromCart -▸ **createFromCart**(`cartOrId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**createFromCart**(`cartOrId`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> Creates an order from a cart @@ -809,7 +809,7 @@ ___ ### createFulfillment -▸ **createFulfillment**(`orderId`, `itemsToFulfill`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**createFulfillment**(`orderId`, `itemsToFulfill`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> Creates fulfillments for an order. In a situation where the order has more than one shipping method, @@ -897,7 +897,7 @@ ___ ### createGiftCardsFromLineItem\_ -▸ `Protected` **createGiftCardsFromLineItem_**(`order`, `lineItem`, `manager`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\>[] +`Protected` **createGiftCardsFromLineItem_**(`order`, `lineItem`, `manager`): `Promise`<[`GiftCard`](admin_collections.internal.GiftCard.mdx)\>[] #### Parameters @@ -965,7 +965,7 @@ ___ ### createRefund -▸ **createRefund**(`orderId`, `refundAmount`, `reason`, `note?`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**createRefund**(`orderId`, `refundAmount`, `reason`, `note?`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> Refunds a given amount back to the customer. @@ -1050,7 +1050,7 @@ ___ ### createShipment -▸ **createShipment**(`orderId`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**createShipment**(`orderId`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> Adds a shipment to the order to indicate that an order has left the warehouse. Will ask the fulfillment provider for any documents that may @@ -1137,7 +1137,7 @@ ___ ### decorateTotals -▸ **decorateTotals**(`order`, `totalsFields?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**decorateTotals**(`order`, `totalsFields?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> #### Parameters @@ -1184,7 +1184,7 @@ ___ } ]} /> -▸ **decorateTotals**(`order`, `context?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**decorateTotals**(`order`, `context?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> #### Parameters @@ -1235,7 +1235,7 @@ ___ ### decorateTotalsLegacy -▸ `Protected` **decorateTotalsLegacy**(`order`, `totalsFields?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +`Protected` **decorateTotalsLegacy**(`order`, `totalsFields?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> #### Parameters @@ -1286,7 +1286,7 @@ ___ ### getFulfillmentItems -▸ `Protected` **getFulfillmentItems**(`order`, `items`, `transformer`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> +`Protected` **getFulfillmentItems**(`order`, `items`, `transformer`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx)[]\> Retrieves the order line items, given an array of items. @@ -1356,7 +1356,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)[]\> #### Parameters @@ -1416,7 +1416,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Order`](admin_collections.internal.Order.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`): `Promise`<[[`Order`](admin_collections.internal.Order.mdx)[], `number`]\> #### Parameters @@ -1475,7 +1475,7 @@ ___ ### registerReturnReceived -▸ **registerReturnReceived**(`orderId`, `receivedReturn`, `customRefundAmount?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**registerReturnReceived**(`orderId`, `receivedReturn`, `customRefundAmount?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> Handles receiving a return. This will create a refund to the customer. If the returned items don't match the requested @@ -1542,7 +1542,7 @@ ___ ### retrieve -▸ **retrieve**(`orderId`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**retrieve**(`orderId`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> Gets an order by id. @@ -1595,7 +1595,7 @@ ___ ### retrieveByCartId -▸ **retrieveByCartId**(`cartId`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**retrieveByCartId**(`cartId`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> Gets an order by cart id. @@ -1648,7 +1648,7 @@ ___ ### retrieveByCartIdWithTotals -▸ **retrieveByCartIdWithTotals**(`cartId`, `options?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**retrieveByCartIdWithTotals**(`cartId`, `options?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> #### Parameters @@ -1699,7 +1699,7 @@ ___ ### retrieveByExternalId -▸ **retrieveByExternalId**(`externalId`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**retrieveByExternalId**(`externalId`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> Gets an order by id. @@ -1752,7 +1752,7 @@ ___ ### retrieveLegacy -▸ `Protected` **retrieveLegacy**(`orderIdOrSelector`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +`Protected` **retrieveLegacy**(`orderIdOrSelector`, `config?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> #### Parameters @@ -1803,7 +1803,7 @@ ___ ### retrieveWithTotals -▸ **retrieveWithTotals**(`orderId`, `options?`, `context?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**retrieveWithTotals**(`orderId`, `options?`, `context?`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> #### Parameters @@ -1862,7 +1862,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -1900,7 +1900,7 @@ ___ ### transformQueryForTotals -▸ `Protected` **transformQueryForTotals**(`config`): { `relations`: `undefined` \| `string`[] ; `select`: `undefined` \| keyof [`Order`](admin_collections.internal.Order.mdx)[] ; `totalsToSelect`: `undefined` \| keyof [`Order`](admin_collections.internal.Order.mdx)[] } +`Protected` **transformQueryForTotals**(`config`): { `relations`: `undefined` \| `string`[] ; `select`: `undefined` \| keyof [`Order`](admin_collections.internal.Order.mdx)[] ; `totalsToSelect`: `undefined` \| keyof [`Order`](admin_collections.internal.Order.mdx)[] } #### Parameters @@ -1961,7 +1961,7 @@ ___ ### update -▸ **update**(`orderId`, `update`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> +**update**(`orderId`, `update`): `Promise`<[`Order`](admin_collections.internal.Order.mdx)\> Updates an order. Metadata updates should use dedicated method, e.g. `setMetadata` etc. The function @@ -2016,7 +2016,7 @@ ___ ### updateBillingAddress -▸ `Protected` **updateBillingAddress**(`order`, `address`): `Promise`<`void`\> +`Protected` **updateBillingAddress**(`order`, `address`): `Promise`<`void`\> Updates the order's billing address. @@ -2060,7 +2060,7 @@ ___ ### updateShippingAddress -▸ `Protected` **updateShippingAddress**(`order`, `address`): `Promise`<`void`\> +`Protected` **updateShippingAddress**(`order`, `address`): `Promise`<`void`\> Updates the order's shipping address. @@ -2104,7 +2104,7 @@ ___ ### validateFulfillmentLineItem -▸ `Protected` **validateFulfillmentLineItem**(`item`, `quantity`): ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx) +`Protected` **validateFulfillmentLineItem**(`item`, `quantity`): ``null`` \| [`LineItem`](admin_collections.internal.LineItem.mdx) Checks that a given quantity of a line item can be fulfilled. Fails if the fulfillable quantity is lower than the requested fulfillment quantity. @@ -2151,7 +2151,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`OrderService`](admin_discounts.internal.internal.OrderService.mdx) +**withTransaction**(`transactionManager?`): [`OrderService`](admin_discounts.internal.internal.OrderService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentCollectionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentCollectionService.mdx index c310583350..510e635fec 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentCollectionService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentCollectionService.mdx @@ -137,7 +137,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -162,7 +162,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -239,7 +239,7 @@ ___ ### authorizePaymentSessions -▸ **authorizePaymentSessions**(`paymentCollectionId`, `sessionIds`, `context?`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> +**authorizePaymentSessions**(`paymentCollectionId`, `sessionIds`, `context?`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> Authorizes the payment sessions of a payment collection. @@ -300,7 +300,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> +**create**(`data`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> Creates a new payment collection. @@ -345,7 +345,7 @@ ___ ### delete -▸ **delete**(`paymentCollectionId`): `Promise`<`undefined` \| [`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> +**delete**(`paymentCollectionId`): `Promise`<`undefined` \| [`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> Deletes a payment collection. @@ -390,7 +390,7 @@ ___ ### markAsAuthorized -▸ **markAsAuthorized**(`paymentCollectionId`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> +**markAsAuthorized**(`paymentCollectionId`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> Marks a payment collection as authorized bypassing the payment flow. @@ -435,7 +435,7 @@ ___ ### refreshPaymentSession -▸ **refreshPaymentSession**(`paymentCollectionId`, `sessionId`, `customerId`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> +**refreshPaymentSession**(`paymentCollectionId`, `sessionId`, `customerId`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> Removes and recreate a payment session of a payment collection. @@ -496,7 +496,7 @@ ___ ### retrieve -▸ **retrieve**(`paymentCollectionId`, `config?`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> +**retrieve**(`paymentCollectionId`, `config?`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> Retrieves a payment collection by id. @@ -549,7 +549,7 @@ ___ ### setPaymentSession -▸ **setPaymentSession**(`paymentCollectionId`, `sessionInput`, `customerId`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> +**setPaymentSession**(`paymentCollectionId`, `sessionInput`, `customerId`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> Manages a single payment sessions of a payment collection. @@ -610,7 +610,7 @@ ___ ### setPaymentSessionsBatch -▸ **setPaymentSessionsBatch**(`paymentCollectionOrId`, `sessionsInput`, `customerId`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> +**setPaymentSessionsBatch**(`paymentCollectionOrId`, `sessionsInput`, `customerId`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> Manages multiple payment sessions of a payment collection. @@ -671,7 +671,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -709,7 +709,7 @@ ___ ### update -▸ **update**(`paymentCollectionId`, `data`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> +**update**(`paymentCollectionId`, `data`): `Promise`<[`PaymentCollection`](admin_collections.internal.PaymentCollection.mdx)\> Updates a payment collection. @@ -762,7 +762,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`PaymentCollectionService`](admin_discounts.internal.internal.PaymentCollectionService.mdx) +**withTransaction**(`transactionManager?`): [`PaymentCollectionService`](admin_discounts.internal.internal.PaymentCollectionService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentProviderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentProviderService.mdx index dc35e71059..f19a21681f 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentProviderService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PaymentProviderService.mdx @@ -131,7 +131,7 @@ Helps retrieve payment providers ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -156,7 +156,7 @@ ___ ### paymentService\_ -• `Protected` `get` **paymentService_**(): [`PaymentService`](admin_discounts.internal.PaymentService.mdx) +`Protected` `get` **paymentService_**(): [`PaymentService`](admin_discounts.internal.PaymentService.mdx) #### Returns @@ -177,7 +177,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -254,7 +254,7 @@ ___ ### authorizePayment -▸ **authorizePayment**(`paymentSession`, `context`): `Promise`<`undefined` \| [`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> +**authorizePayment**(`paymentSession`, `context`): `Promise`<`undefined` \| [`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> #### Parameters @@ -305,7 +305,7 @@ ___ ### buildPaymentProcessorContext -▸ `Protected` **buildPaymentProcessorContext**(`cartOrData`): [`Cart`](admin_collections.internal.Cart.mdx) & [`PaymentContext`](../modules/admin_discounts.internal.internal.mdx#paymentcontext) +`Protected` **buildPaymentProcessorContext**(`cartOrData`): [`Cart`](admin_collections.internal.Cart.mdx) & [`PaymentContext`](../modules/admin_discounts.internal.internal.mdx#paymentcontext) Build the create session context for both legacy and new API @@ -341,7 +341,7 @@ ___ ### cancelPayment -▸ **cancelPayment**(`paymentObj`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> +**cancelPayment**(`paymentObj`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> #### Parameters @@ -384,7 +384,7 @@ ___ ### capturePayment -▸ **capturePayment**(`paymentObj`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> +**capturePayment**(`paymentObj`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> #### Parameters @@ -427,7 +427,7 @@ ___ ### createPayment -▸ **createPayment**(`data`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> +**createPayment**(`data`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> #### Parameters @@ -470,7 +470,7 @@ ___ ### createSession -▸ **createSession**(`providerId`, `cart`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> +**createSession**(`providerId`, `cart`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> #### Parameters @@ -519,7 +519,7 @@ ___ #### Deprecated -▸ **createSession**(`sessionInput`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> +**createSession**(`sessionInput`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> Creates a payment session with the given provider. @@ -564,7 +564,7 @@ ___ ### deleteSession -▸ **deleteSession**(`paymentSession`): `Promise`<`undefined` \| [`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> +**deleteSession**(`paymentSession`): `Promise`<`undefined` \| [`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> #### Parameters @@ -607,7 +607,7 @@ ___ ### getStatus -▸ **getStatus**(`payment`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> +**getStatus**(`payment`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> #### Parameters @@ -682,7 +682,7 @@ ___ ### list -▸ **list**(): `Promise`<[`PaymentProvider`](admin_collections.internal.PaymentProvider.mdx)[]\> +**list**(): `Promise`<[`PaymentProvider`](admin_collections.internal.PaymentProvider.mdx)[]\> #### Returns @@ -721,7 +721,7 @@ ___ ### listPayments -▸ **listPayments**(`selector`, `config?`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)[]\> +**listPayments**(`selector`, `config?`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)[]\> List all the payments according to the given selector and config. @@ -783,7 +783,7 @@ ___ ### processUpdateRequestsData -▸ `Protected` **processUpdateRequestsData**(`data`, `paymentResponse`): `Promise`<`void`\> +`Protected` **processUpdateRequestsData**(`data`, `paymentResponse`): `Promise`<`void`\> Process the collected data. Can be used every time we need to process some collected data returned by the provider @@ -827,7 +827,7 @@ ___ ### refreshSession -▸ **refreshSession**(`paymentSession`, `sessionInput`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> +**refreshSession**(`paymentSession`, `sessionInput`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> Refreshes a payment session with the given provider. This means, that we delete the current one and create a new. @@ -905,7 +905,7 @@ ___ ### refundFromPayment -▸ **refundFromPayment**(`payment`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> +**refundFromPayment**(`payment`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> #### Parameters @@ -972,7 +972,7 @@ ___ ### refundPayment -▸ **refundPayment**(`payObjs`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> +**refundPayment**(`payObjs`, `amount`, `reason`, `note?`): `Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> #### Parameters @@ -1039,7 +1039,7 @@ ___ ### registerInstalledProviders -▸ **registerInstalledProviders**(`providerIds`): `Promise`<`void`\> +**registerInstalledProviders**(`providerIds`): `Promise`<`void`\> #### Parameters @@ -1073,7 +1073,7 @@ ___ ### retrievePayment -▸ **retrievePayment**(`paymentId`, `relations?`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> +**retrievePayment**(`paymentId`, `relations?`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> Retrieve a payment entity with the given id. @@ -1126,7 +1126,7 @@ ___ ### retrieveProvider -▸ **retrieveProvider**<`TProvider`\>(`providerId`): `TProvider` extends [`AbstractPaymentService`](admin_discounts.internal.internal.AbstractPaymentService.mdx) ? [`AbstractPaymentService`](admin_discounts.internal.internal.AbstractPaymentService.mdx) : `TProvider` extends [`AbstractPaymentProcessor`](admin_discounts.internal.internal.AbstractPaymentProcessor.mdx) ? [`AbstractPaymentProcessor`](admin_discounts.internal.internal.AbstractPaymentProcessor.mdx) : `any` +**retrieveProvider**<`TProvider`\>(`providerId`): `TProvider` extends [`AbstractPaymentService`](admin_discounts.internal.internal.AbstractPaymentService.mdx) ? [`AbstractPaymentService`](admin_discounts.internal.internal.AbstractPaymentService.mdx) : `TProvider` extends [`AbstractPaymentProcessor`](admin_discounts.internal.internal.AbstractPaymentProcessor.mdx) ? [`AbstractPaymentProcessor`](admin_discounts.internal.internal.AbstractPaymentProcessor.mdx) : `any` Finds a provider given an id @@ -1173,7 +1173,7 @@ ___ ### retrieveRefund -▸ **retrieveRefund**(`id`, `config?`): `Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> +**retrieveRefund**(`id`, `config?`): `Promise`<[`Refund`](admin_collections.internal.Refund.mdx)\> #### Parameters @@ -1224,7 +1224,7 @@ ___ ### retrieveSession -▸ **retrieveSession**(`paymentSessionId`, `relations?`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> +**retrieveSession**(`paymentSessionId`, `relations?`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> Return the payment session for the given id. @@ -1277,7 +1277,7 @@ ___ ### saveSession -▸ `Protected` **saveSession**(`providerId`, `data`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> +`Protected` **saveSession**(`providerId`, `data`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> Create or update a Payment session data. @@ -1386,7 +1386,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -1424,7 +1424,7 @@ ___ ### updatePayment -▸ **updatePayment**(`paymentId`, `data`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> +**updatePayment**(`paymentId`, `data`): `Promise`<[`Payment`](admin_collections.internal.Payment.mdx)\> #### Parameters @@ -1491,7 +1491,7 @@ ___ ### updateSession -▸ **updateSession**(`paymentSession`, `sessionInput`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> +**updateSession**(`paymentSession`, `sessionInput`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> Update a payment session with the given provider. @@ -1568,7 +1568,7 @@ ___ ### updateSessionData -▸ **updateSessionData**(`paymentSession`, `data`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> +**updateSessionData**(`paymentSession`, `data`): `Promise`<[`PaymentSession`](admin_collections.internal.PaymentSession.mdx)\> #### Parameters @@ -1619,7 +1619,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`PaymentProviderService`](admin_discounts.internal.internal.PaymentProviderService.mdx) +**withTransaction**(`transactionManager?`): [`PaymentProviderService`](admin_discounts.internal.internal.PaymentProviderService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PriceListService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PriceListService.mdx index 024265e01f..47489ce913 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PriceListService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PriceListService.mdx @@ -123,7 +123,7 @@ Provides layer to manipulate product tags. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -148,7 +148,7 @@ TransactionBaseService.activeManager\_ ### addCurrencyFromRegion -▸ `Protected` **addCurrencyFromRegion**<`T`\>(`prices`): `Promise`<`T`[]\> +`Protected` **addCurrencyFromRegion**<`T`\>(`prices`): `Promise`<`T`[]\> Add `currency_code` to an MA record if `region_id`is passed. @@ -204,7 +204,7 @@ ___ ### addPrices -▸ **addPrices**(`id`, `prices`, `replace?`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> +**addPrices**(`id`, `prices`, `replace?`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> Adds prices to a price list in bulk, optionally replacing all existing prices @@ -265,7 +265,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -342,7 +342,7 @@ ___ ### clearPrices -▸ **clearPrices**(`id`): `Promise`<`void`\> +**clearPrices**(`id`): `Promise`<`void`\> Removes all prices from a price list and deletes the removed prices in bulk @@ -378,7 +378,7 @@ ___ ### create -▸ **create**(`priceListObject`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> +**create**(`priceListObject`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> Creates a Price List @@ -423,7 +423,7 @@ ___ ### delete -▸ **delete**(`id`): `Promise`<`void`\> +**delete**(`id`): `Promise`<`void`\> Deletes a Price List Will never fail due to delete being idempotent. @@ -460,7 +460,7 @@ ___ ### deletePrices -▸ **deletePrices**(`id`, `priceIds`): `Promise`<`void`\> +**deletePrices**(`id`, `priceIds`): `Promise`<`void`\> Removes prices from a price list and deletes the removed prices in bulk @@ -504,7 +504,7 @@ ___ ### deleteProductPrices -▸ **deleteProductPrices**(`priceListId`, `productIds`): `Promise`<[`string`[], `number`]\> +**deleteProductPrices**(`priceListId`, `productIds`): `Promise`<[`string`[], `number`]\> #### Parameters @@ -563,7 +563,7 @@ ___ ### deleteVariantPrices -▸ **deleteVariantPrices**(`priceListId`, `variantIds`): `Promise`<[`string`[], `number`]\> +**deleteVariantPrices**(`priceListId`, `variantIds`): `Promise`<[`string`[], `number`]\> #### Parameters @@ -622,7 +622,7 @@ ___ ### list -▸ **list**(`selector?`, `config?`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)[]\> +**list**(`selector?`, `config?`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)[]\> Lists Price Lists @@ -684,7 +684,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`PriceList`](admin_collections.internal.PriceList.mdx)[], `number`]\> +**listAndCount**(`selector?`, `config?`): `Promise`<[[`PriceList`](admin_collections.internal.PriceList.mdx)[], `number`]\> Lists Price Lists and adds count @@ -745,7 +745,7 @@ ___ ### listPriceListsVariantIdsMap -▸ **listPriceListsVariantIdsMap**(`priceListIds`): `Promise`<{ `[priceListId: string]`: `string`[]; }\> +**listPriceListsVariantIdsMap**(`priceListIds`): `Promise`<{ `[priceListId: string]`: `string`[]; }\> #### Parameters @@ -788,7 +788,7 @@ ___ ### listProducts -▸ **listProducts**(`priceListId`, `selector?`, `config?`, `requiresPriceList?`): `Promise`<[[`Product`](admin_collections.internal.Product.mdx)[], `number`]\> +**listProducts**(`priceListId`, `selector?`, `config?`, `requiresPriceList?`): `Promise`<[[`Product`](admin_collections.internal.Product.mdx)[], `number`]\> #### Parameters @@ -863,7 +863,7 @@ ___ ### listVariants -▸ **listVariants**(`priceListId`, `selector?`, `config?`, `requiresPriceList?`): `Promise`<[[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[], `number`]\> +**listVariants**(`priceListId`, `selector?`, `config?`, `requiresPriceList?`): `Promise`<[[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[], `number`]\> #### Parameters @@ -938,7 +938,7 @@ ___ ### retrieve -▸ **retrieve**(`priceListId`, `config?`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> +**retrieve**(`priceListId`, `config?`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> Retrieves a product tag by id. @@ -991,7 +991,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -1029,7 +1029,7 @@ ___ ### update -▸ **update**(`id`, `update`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> +**update**(`id`, `update`): `Promise`<[`PriceList`](admin_collections.internal.PriceList.mdx)\> Updates a Price List @@ -1082,7 +1082,7 @@ ___ ### upsertCustomerGroups\_ -▸ `Protected` **upsertCustomerGroups_**(`priceListId`, `customerGroups`): `Promise`<`void`\> +`Protected` **upsertCustomerGroups_**(`priceListId`, `customerGroups`): `Promise`<`void`\> #### Parameters @@ -1124,7 +1124,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`PriceListService`](admin_discounts.internal.internal.PriceListService.mdx) +**withTransaction**(`transactionManager?`): [`PriceListService`](admin_discounts.internal.internal.PriceListService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PricingService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PricingService.mdx index 7b21dfbf1e..b03bd8d67d 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PricingService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.PricingService.mdx @@ -115,7 +115,7 @@ Allows retrieval of prices. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -140,7 +140,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -217,7 +217,7 @@ ___ ### calculateTaxes -▸ **calculateTaxes**(`variantPricing`, `productRates`): [`TaxedPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxedpricing) +**calculateTaxes**(`variantPricing`, `productRates`): [`TaxedPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxedpricing) Gets the prices for a product variant @@ -261,7 +261,7 @@ ___ ### collectPricingContext -▸ **collectPricingContext**(`context`): `Promise`<[`PricingContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricingcontext)\> +**collectPricingContext**(`context`): `Promise`<[`PricingContext`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricingcontext)\> Collects additional information necessary for completing the price selection. @@ -307,7 +307,7 @@ ___ ### getProductPricing -▸ **getProductPricing**(`product`, `context`): `Promise`\> +**getProductPricing**(`product`, `context`): `Promise`\> Gets all the variant prices for a product. All the product's variants will be fetched. @@ -378,7 +378,7 @@ ___ ### getProductPricingById -▸ **getProductPricingById**(`productId`, `context`): `Promise`\> +**getProductPricingById**(`productId`, `context`): `Promise`\> Gets all the variant prices for a product by the product id @@ -448,7 +448,7 @@ ___ ### getProductVariantPricing -▸ **getProductVariantPricing**(`variant`, `context`): `Promise`<[`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing)\> +**getProductVariantPricing**(`variant`, `context`): `Promise`<[`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing)\> Gets the prices for a product variant. @@ -501,7 +501,7 @@ ___ ### getProductVariantPricingById -▸ **getProductVariantPricingById**(`variantId`, `context`): `Promise`<[`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing)\> +**getProductVariantPricingById**(`variantId`, `context`): `Promise`<[`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing)\> Gets the prices for a product variant by a variant id. @@ -558,7 +558,7 @@ ___ ### getProductVariantsPricing -▸ **getProductVariantsPricing**(`data`, `context`): `Promise`<{ `[variant_id: string]`: [`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing); }\> +**getProductVariantsPricing**(`data`, `context`): `Promise`<{ `[variant_id: string]`: [`ProductVariantPricing`](../../admin_discounts/modules/admin_discounts.internal.mdx#productvariantpricing); }\> Gets the prices for a collection of variants. @@ -611,7 +611,7 @@ ___ ### getShippingOptionPricing -▸ **getShippingOptionPricing**(`shippingOption`, `context`): `Promise`<[`PricedShippingOption`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedshippingoption)\> +**getShippingOptionPricing**(`shippingOption`, `context`): `Promise`<[`PricedShippingOption`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedshippingoption)\> Gets the prices for a shipping option. @@ -664,7 +664,7 @@ ___ ### setProductPrices -▸ **setProductPrices**(`products`, `context?`): `Promise`<([`Product`](admin_collections.internal.Product.mdx) \| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]\> +**setProductPrices**(`products`, `context?`): `Promise`<([`Product`](admin_collections.internal.Product.mdx) \| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]\> Set additional prices on a list of products. @@ -726,7 +726,7 @@ ___ ### setShippingOptionPrices -▸ **setShippingOptionPrices**(`shippingOptions`, `context?`): `Promise`<[`PricedShippingOption`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedshippingoption)[]\> +**setShippingOptionPrices**(`shippingOptions`, `context?`): `Promise`<[`PricedShippingOption`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedshippingoption)[]\> Set additional prices on a list of shipping options. @@ -788,7 +788,7 @@ ___ ### setVariantPrices -▸ **setVariantPrices**(`variants`, `context?`): `Promise`<[`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[]\> +**setVariantPrices**(`variants`, `context?`): `Promise`<[`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[]\> Set additional prices on a list of product variants. @@ -850,7 +850,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -888,7 +888,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`PricingService`](admin_discounts.internal.internal.PricingService.mdx) +**withTransaction**(`transactionManager?`): [`PricingService`](admin_discounts.internal.internal.PricingService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCategoryService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCategoryService.mdx index ec20aa1003..2eaf6a8c3b 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCategoryService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCategoryService.mdx @@ -107,7 +107,7 @@ Provides layer to manipulate product categories. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -132,7 +132,7 @@ TransactionBaseService.activeManager\_ ### addProducts -▸ **addProducts**(`productCategoryId`, `productIds`): `Promise`<`void`\> +**addProducts**(`productCategoryId`, `productIds`): `Promise`<`void`\> Add a batch of product to a product category @@ -176,7 +176,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -253,7 +253,7 @@ ___ ### create -▸ **create**(`productCategoryInput`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> +**create**(`productCategoryInput`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> Creates a product category @@ -298,7 +298,7 @@ ___ ### delete -▸ **delete**(`productCategoryId`): `Promise`<`void`\> +**delete**(`productCategoryId`): `Promise`<`void`\> Deletes a product category @@ -334,7 +334,7 @@ ___ ### fetchReorderConditions -▸ `Protected` **fetchReorderConditions**(`productCategory`, `input`, `shouldDeleteElement?`): [`ReorderConditions`](../../admin_discounts/modules/admin_discounts.internal.mdx#reorderconditions) +`Protected` **fetchReorderConditions**(`productCategory`, `input`, `shouldDeleteElement?`): [`ReorderConditions`](../../admin_discounts/modules/admin_discounts.internal.mdx#reorderconditions) #### Parameters @@ -384,7 +384,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`, `treeSelector?`): `Promise`<[[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`, `treeSelector?`): `Promise`<[[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)[], `number`]\> Lists product category based on the provided parameters and includes the count of product category that match the query. @@ -454,7 +454,7 @@ ___ ### performReordering -▸ `Protected` **performReordering**(`repository`, `conditions`): `Promise`<`void`\> +`Protected` **performReordering**(`repository`, `conditions`): `Promise`<`void`\> #### Parameters @@ -496,7 +496,7 @@ ___ ### removeProducts -▸ **removeProducts**(`productCategoryId`, `productIds`): `Promise`<`void`\> +**removeProducts**(`productCategoryId`, `productIds`): `Promise`<`void`\> Remove a batch of product from a product category @@ -540,7 +540,7 @@ ___ ### retrieve -▸ **retrieve**(`productCategoryId`, `config?`, `selector?`, `treeSelector?`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> +**retrieve**(`productCategoryId`, `config?`, `selector?`, `treeSelector?`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> Retrieves a product category by id. @@ -609,7 +609,7 @@ ___ ### retrieveByHandle -▸ **retrieveByHandle**(`handle`, `config?`, `selector?`, `treeSelector?`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> +**retrieveByHandle**(`handle`, `config?`, `selector?`, `treeSelector?`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> Retrieves a product category by handle. @@ -678,7 +678,7 @@ ___ ### retrieve\_ -▸ `Protected` **retrieve_**(`config?`, `selector?`, `treeSelector?`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> +`Protected` **retrieve_**(`config?`, `selector?`, `treeSelector?`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> A generic retrieve for fining product categories by different attributes. @@ -739,7 +739,7 @@ ___ ### shiftSiblings -▸ `Protected` **shiftSiblings**(`repository`, `conditions`): `Promise`<`void`\> +`Protected` **shiftSiblings**(`repository`, `conditions`): `Promise`<`void`\> #### Parameters @@ -781,7 +781,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -819,7 +819,7 @@ ___ ### transformParentIdToEntity -▸ `Protected` **transformParentIdToEntity**(`productCategoryInput`): `Promise`<[`CreateProductCategoryInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#createproductcategoryinput) \| [`UpdateProductCategoryInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#updateproductcategoryinput)\> +`Protected` **transformParentIdToEntity**(`productCategoryInput`): `Promise`<[`CreateProductCategoryInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#createproductcategoryinput) \| [`UpdateProductCategoryInput`](../../admin_discounts/modules/admin_discounts.internal.mdx#updateproductcategoryinput)\> Accepts an input object and transforms product_category_id into product_category entity. @@ -865,7 +865,7 @@ ___ ### update -▸ **update**(`productCategoryId`, `productCategoryInput`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> +**update**(`productCategoryId`, `productCategoryInput`): `Promise`<[`ProductCategory`](admin_collections.internal.ProductCategory.mdx)\> Updates a product category @@ -918,7 +918,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`ProductCategoryService`](admin_discounts.internal.internal.ProductCategoryService.mdx) +**withTransaction**(`transactionManager?`): [`ProductCategoryService`](admin_discounts.internal.internal.ProductCategoryService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCollectionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCollectionService.mdx index bb7e2c2459..b14dedc87c 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCollectionService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductCollectionService.mdx @@ -131,7 +131,7 @@ Provides layer to manipulate product collections. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -156,7 +156,7 @@ TransactionBaseService.activeManager\_ ### addProducts -▸ **addProducts**(`collectionId`, `productIds`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> +**addProducts**(`collectionId`, `productIds`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> #### Parameters @@ -207,7 +207,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -284,7 +284,7 @@ ___ ### create -▸ **create**(`collection`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> +**create**(`collection`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> Creates a product collection @@ -329,7 +329,7 @@ ___ ### delete -▸ **delete**(`collectionId`): `Promise`<`void`\> +**delete**(`collectionId`): `Promise`<`void`\> Deletes a product collection idempotently @@ -365,7 +365,7 @@ ___ ### list -▸ **list**(`selector?`, `config?`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)[]\> +**list**(`selector?`, `config?`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)[]\> Lists product collections @@ -443,7 +443,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)[], `number`]\> +**listAndCount**(`selector?`, `config?`): `Promise`<[[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)[], `number`]\> Lists product collections and add count. @@ -504,7 +504,7 @@ ___ ### removeProducts -▸ **removeProducts**(`collectionId`, `productIds`): `Promise`<`void`\> +**removeProducts**(`collectionId`, `productIds`): `Promise`<`void`\> #### Parameters @@ -546,7 +546,7 @@ ___ ### retrieve -▸ **retrieve**(`collectionId`, `config?`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> +**retrieve**(`collectionId`, `config?`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> Retrieves a product collection by id. @@ -599,7 +599,7 @@ ___ ### retrieveByHandle -▸ **retrieveByHandle**(`collectionHandle`, `config?`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> +**retrieveByHandle**(`collectionHandle`, `config?`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> Retrieves a product collection by id. @@ -652,7 +652,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -690,7 +690,7 @@ ___ ### update -▸ **update**(`collectionId`, `update`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> +**update**(`collectionId`, `update`): `Promise`<[`ProductCollection`](admin_collections.internal.ProductCollection.mdx)\> Updates a product collection @@ -743,7 +743,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`ProductCollectionService`](admin_discounts.internal.internal.ProductCollectionService.mdx) +**withTransaction**(`transactionManager?`): [`ProductCollectionService`](admin_discounts.internal.internal.ProductCollectionService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductService.mdx index d730b1d097..0c3b016f20 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductService.mdx @@ -185,7 +185,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -210,7 +210,7 @@ TransactionBaseService.activeManager\_ ### addOption -▸ **addOption**(`productId`, `optionTitle`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> +**addOption**(`productId`, `optionTitle`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> Adds an option to a product. Options can, for example, be "Size", "Color", etc. Will update all the products variants with a dummy value for the newly @@ -265,7 +265,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -342,7 +342,7 @@ ___ ### count -▸ **count**(`selector?`): `Promise`<`number`\> +**count**(`selector?`): `Promise`<`number`\> Return the total number of documents in database @@ -387,7 +387,7 @@ ___ ### create -▸ **create**(`productObject`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> +**create**(`productObject`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> Creates a product. @@ -432,7 +432,7 @@ ___ ### delete -▸ **delete**(`productId`): `Promise`<`void`\> +**delete**(`productId`): `Promise`<`void`\> Deletes a product from a given product id. The product's associated variants will also be deleted. @@ -469,7 +469,7 @@ ___ ### deleteOption -▸ **deleteOption**(`productId`, `optionId`): `Promise`<`void` \| [`Product`](admin_collections.internal.Product.mdx)\> +**deleteOption**(`productId`, `optionId`): `Promise`<`void` \| [`Product`](admin_collections.internal.Product.mdx)\> Delete an option from a product. @@ -522,7 +522,7 @@ ___ ### filterProductsBySalesChannel -▸ **filterProductsBySalesChannel**(`productIds`, `salesChannelId`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)[]\> +**filterProductsBySalesChannel**(`productIds`, `salesChannelId`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)[]\> #### Parameters @@ -590,7 +590,7 @@ ___ ### isProductInSalesChannels -▸ **isProductInSalesChannels**(`id`, `salesChannelIds`): `Promise`<`boolean`\> +**isProductInSalesChannels**(`id`, `salesChannelIds`): `Promise`<`boolean`\> Check if the product is assigned to at least one of the provided sales channels. @@ -643,7 +643,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)[]\> Lists products based on the provided parameters. @@ -705,7 +705,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Product`](admin_collections.internal.Product.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`): `Promise`<[[`Product`](admin_collections.internal.Product.mdx)[], `number`]\> Lists products based on the provided parameters and includes the count of products that match the query. @@ -767,7 +767,7 @@ ___ ### listTagsByUsage -▸ **listTagsByUsage**(`take?`): `Promise`<[`ProductTag`](admin_collections.internal.ProductTag.mdx)[]\> +**listTagsByUsage**(`take?`): `Promise`<[`ProductTag`](admin_collections.internal.ProductTag.mdx)[]\> #### Parameters @@ -819,7 +819,7 @@ ___ ### listTypes -▸ **listTypes**(): `Promise`<[`ProductType`](admin_collections.internal.ProductType.mdx)[]\> +**listTypes**(): `Promise`<[`ProductType`](admin_collections.internal.ProductType.mdx)[]\> #### Returns @@ -858,7 +858,7 @@ ___ ### prepareListQuery\_ -▸ `Protected` **prepareListQuery_**(`selector`, `config`): { `q`: `string` ; `query`: [`FindWithoutRelationsOptions`](../../admin_discounts/modules/admin_discounts.internal.mdx#findwithoutrelationsoptions-1) ; `relations`: keyof [`Product`](admin_collections.internal.Product.mdx)[] } +`Protected` **prepareListQuery_**(`selector`, `config`): { `q`: `string` ; `query`: [`FindWithoutRelationsOptions`](../../admin_discounts/modules/admin_discounts.internal.mdx#findwithoutrelationsoptions-1) ; `relations`: keyof [`Product`](admin_collections.internal.Product.mdx)[] } Temporary method to be used in place we need custom query strategy to prevent typeorm bug @@ -929,7 +929,7 @@ ___ ### reorderVariants -▸ **reorderVariants**(`productId`, `variantOrder`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> +**reorderVariants**(`productId`, `variantOrder`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> #### Parameters @@ -980,7 +980,7 @@ ___ ### retrieve -▸ **retrieve**(`productId`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> +**retrieve**(`productId`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> Gets a product by id. Throws in case of DB Error and if product was not found. @@ -1034,7 +1034,7 @@ ___ ### retrieveByExternalId -▸ **retrieveByExternalId**(`externalId`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> +**retrieveByExternalId**(`externalId`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> Gets a product by external id. Throws in case of DB Error and if product was not found. @@ -1088,7 +1088,7 @@ ___ ### retrieveByHandle -▸ **retrieveByHandle**(`productHandle`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> +**retrieveByHandle**(`productHandle`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> Gets a product by handle. Throws in case of DB Error and if product was not found. @@ -1142,7 +1142,7 @@ ___ ### retrieveOptionByTitle -▸ **retrieveOptionByTitle**(`title`, `productId`): `Promise`<``null`` \| [`ProductOption`](admin_collections.internal.ProductOption.mdx)\> +**retrieveOptionByTitle**(`title`, `productId`): `Promise`<``null`` \| [`ProductOption`](admin_collections.internal.ProductOption.mdx)\> Retrieve product's option by title. @@ -1195,7 +1195,7 @@ ___ ### retrieveVariants -▸ **retrieveVariants**(`productId`, `config?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> +**retrieveVariants**(`productId`, `config?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> Gets all variants belonging to a product. @@ -1257,7 +1257,7 @@ ___ ### retrieve\_ -▸ **retrieve_**(`selector`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> +**retrieve_**(`selector`, `config?`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> Gets a product by selector. Throws in case of DB Error and if product was not found. @@ -1311,7 +1311,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -1349,7 +1349,7 @@ ___ ### update -▸ **update**(`productId`, `update`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> +**update**(`productId`, `update`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> Updates a product. Product variant updates should use dedicated methods, e.g. `addVariant`, etc. The function will throw errors if metadata or @@ -1404,7 +1404,7 @@ ___ ### updateOption -▸ **updateOption**(`productId`, `optionId`, `data`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> +**updateOption**(`productId`, `optionId`, `data`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)\> Updates a product's option. Throws if the call tries to update an option not associated with the product. Throws if the updated title already exists. @@ -1466,7 +1466,7 @@ ___ ### updateShippingProfile -▸ **updateShippingProfile**(`productIds`, `profileId`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)[]\> +**updateShippingProfile**(`productIds`, `profileId`): `Promise`<[`Product`](admin_collections.internal.Product.mdx)[]\> Assign a product to a profile, if a profile id null is provided then detach the product from the profile @@ -1528,7 +1528,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`ProductService`](admin_discounts.internal.internal.ProductService.mdx) +**withTransaction**(`transactionManager?`): [`ProductService`](admin_discounts.internal.internal.ProductService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTypeService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTypeService.mdx index b2d8da33bc..f4eba3d7b0 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTypeService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductTypeService.mdx @@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -90,7 +90,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -167,7 +167,7 @@ ___ ### list -▸ **list**(`selector?`, `config?`): `Promise`<[`ProductType`](admin_collections.internal.ProductType.mdx)[]\> +**list**(`selector?`, `config?`): `Promise`<[`ProductType`](admin_collections.internal.ProductType.mdx)[]\> Lists product types @@ -229,7 +229,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`ProductType`](admin_collections.internal.ProductType.mdx)[], `number`]\> +**listAndCount**(`selector?`, `config?`): `Promise`<[[`ProductType`](admin_collections.internal.ProductType.mdx)[], `number`]\> Lists product types and adds count. @@ -290,7 +290,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `config?`): `Promise`<[`ProductType`](admin_collections.internal.ProductType.mdx)\> +**retrieve**(`id`, `config?`): `Promise`<[`ProductType`](admin_collections.internal.ProductType.mdx)\> Gets a product type by id. Throws in case of DB Error and if product was not found. @@ -344,7 +344,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -382,7 +382,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`ProductTypeService`](admin_discounts.internal.internal.ProductTypeService.mdx) +**withTransaction**(`transactionManager?`): [`ProductTypeService`](admin_discounts.internal.internal.ProductTypeService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantInventoryService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantInventoryService.mdx index 94032bbb9d..593440ee90 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantInventoryService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantInventoryService.mdx @@ -121,7 +121,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -146,7 +146,7 @@ TransactionBaseService.activeManager\_ ### adjustInventory -▸ **adjustInventory**(`variantId`, `locationId`, `quantity`): `Promise`<`void`\> +**adjustInventory**(`variantId`, `locationId`, `quantity`): `Promise`<`void`\> Adjusts inventory of a variant on a location @@ -198,7 +198,7 @@ ___ ### adjustReservationsQuantityByLineItem -▸ **adjustReservationsQuantityByLineItem**(`lineItemId`, `variantId`, `locationId`, `quantity`): `Promise`<`void`\> +**adjustReservationsQuantityByLineItem**(`lineItemId`, `variantId`, `locationId`, `quantity`): `Promise`<`void`\> Adjusts the quantity of reservations for a line item by a given amount. @@ -258,7 +258,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -335,7 +335,7 @@ ___ ### attachInventoryItem -▸ **attachInventoryItem**(`attachments`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> +**attachInventoryItem**(`attachments`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> Attach a variant to an inventory item @@ -385,7 +385,7 @@ Attach a variant to an inventory item } ]} /> -▸ **attachInventoryItem**(`variantId`, `inventoryItemId`, `requiredQuantity?`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> +**attachInventoryItem**(`variantId`, `inventoryItemId`, `requiredQuantity?`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> #### Parameters @@ -453,7 +453,7 @@ ___ ### confirmInventory -▸ **confirmInventory**(`variantId`, `quantity`, `context?`): `Promise`<[`Boolean`](../../admin_collections/modules/admin_collections.internal.mdx#boolean)\> +**confirmInventory**(`variantId`, `quantity`, `context?`): `Promise`<[`Boolean`](../../admin_collections/modules/admin_collections.internal.mdx#boolean)\> confirms if requested inventory is available @@ -522,7 +522,7 @@ ___ ### deleteReservationsByLineItem -▸ **deleteReservationsByLineItem**(`lineItemId`, `variantId`, `quantity`): `Promise`<`void`\> +**deleteReservationsByLineItem**(`lineItemId`, `variantId`, `quantity`): `Promise`<`void`\> delete a reservation of variant quantity @@ -574,7 +574,7 @@ ___ ### detachInventoryItem -▸ **detachInventoryItem**(`inventoryItemId`, `variantId?`): `Promise`<`void`\> +**detachInventoryItem**(`inventoryItemId`, `variantId?`): `Promise`<`void`\> Remove a variant from an inventory item @@ -618,7 +618,7 @@ ___ ### getVariantQuantityFromVariantInventoryItems -▸ **getVariantQuantityFromVariantInventoryItems**(`variantInventoryItems`, `channelId`): `Promise`<`number`\> +**getVariantQuantityFromVariantInventoryItems**(`variantInventoryItems`, `channelId`): `Promise`<`number`\> Get the quantity of a variant from a list of variantInventoryItems The inventory quantity of the variant should be equal to the inventory @@ -674,7 +674,7 @@ ___ ### listByItem -▸ **listByItem**(`itemIds`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> +**listByItem**(`itemIds`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> list registered inventory items @@ -728,7 +728,7 @@ ___ ### listByVariant -▸ **listByVariant**(`variantId`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> +**listByVariant**(`variantId`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)[]\> List inventory items for a specific variant @@ -782,7 +782,7 @@ ___ ### listInventoryItemsByVariant -▸ **listInventoryItemsByVariant**(`variantId`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[]\> +**listInventoryItemsByVariant**(`variantId`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[]\> lists inventory items for a given variant @@ -836,7 +836,7 @@ ___ ### listVariantsByItem -▸ **listVariantsByItem**(`itemId`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> +**listVariantsByItem**(`itemId`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> lists variant by inventory item id @@ -890,7 +890,7 @@ ___ ### reserveQuantity -▸ **reserveQuantity**(`variantId`, `quantity`, `context?`): `Promise`<`void` \| [`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[]\> +**reserveQuantity**(`variantId`, `quantity`, `context?`): `Promise`<`void` \| [`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[]\> Reserves a quantity of a variant @@ -951,7 +951,7 @@ ___ ### retrieve -▸ **retrieve**(`inventoryItemId`, `variantId`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)\> +**retrieve**(`inventoryItemId`, `variantId`): `Promise`<[`ProductVariantInventoryItem`](admin_collections.internal.ProductVariantInventoryItem.mdx)\> Retrieves a product variant inventory item by its inventory item ID and variant ID. @@ -1004,7 +1004,7 @@ ___ ### setProductAvailability -▸ **setProductAvailability**(`products`, `salesChannelId`): `Promise`<([`Product`](admin_collections.internal.Product.mdx) \| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]\> +**setProductAvailability**(`products`, `salesChannelId`): `Promise`<([`Product`](admin_collections.internal.Product.mdx) \| [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct))[]\> #### Parameters @@ -1064,7 +1064,7 @@ ___ ### setVariantAvailability -▸ **setVariantAvailability**(`variants`, `salesChannelId`, `availabilityContext?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[] \| [`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[]\> +**setVariantAvailability**(`variants`, `salesChannelId`, `availabilityContext?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[] \| [`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[]\> #### Parameters @@ -1123,7 +1123,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -1161,7 +1161,7 @@ ___ ### validateInventoryAtLocation -▸ **validateInventoryAtLocation**(`items`, `locationId`): `Promise`<`void`\> +**validateInventoryAtLocation**(`items`, `locationId`): `Promise`<`void`\> Validate stock at a location for fulfillment items @@ -1205,7 +1205,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`ProductVariantInventoryService`](admin_discounts.internal.internal.ProductVariantInventoryService.mdx) +**withTransaction**(`transactionManager?`): [`ProductVariantInventoryService`](admin_discounts.internal.internal.ProductVariantInventoryService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantService.mdx index 90739de0ee..38fd9f38d3 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ProductVariantService.mdx @@ -153,7 +153,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -178,7 +178,7 @@ TransactionBaseService.activeManager\_ ### addOptionValue -▸ **addOptionValue**(`variantId`, `optionId`, `optionValue`): `Promise`<[`ProductOptionValue`](admin_collections.internal.ProductOptionValue.mdx)\> +**addOptionValue**(`variantId`, `optionId`, `optionValue`): `Promise`<[`ProductOptionValue`](admin_collections.internal.ProductOptionValue.mdx)\> Adds option value to a variant. Fails when product with variant does not exist or @@ -243,7 +243,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -320,7 +320,7 @@ ___ ### create -▸ **create**<`TVariants`, `TOutput`\>(`productOrProductId`, `variants`): `Promise`<`TOutput`\> +**create**<`TVariants`, `TOutput`\>(`productOrProductId`, `variants`): `Promise`<`TOutput`\> Creates an unpublished product variant. Will validate against parent product to ensure that the variant can in fact be created. @@ -384,7 +384,7 @@ ___ ### delete -▸ **delete**(`variantIds`): `Promise`<`void`\> +**delete**(`variantIds`): `Promise`<`void`\> Deletes variant or variants. Will never fail due to delete being idempotent. @@ -421,7 +421,7 @@ ___ ### deleteOptionValue -▸ **deleteOptionValue**(`variantId`, `optionId`): `Promise`<`void`\> +**deleteOptionValue**(`variantId`, `optionId`): `Promise`<`void`\> Deletes option value from given variant. Will never fail due to delete being idempotent. @@ -466,7 +466,7 @@ ___ ### getFreeTextQueryBuilder\_ -▸ **getFreeTextQueryBuilder_**(`variantRepo`, `query`, `q?`): `SelectQueryBuilder`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> +**getFreeTextQueryBuilder_**(`variantRepo`, `query`, `q?`): `SelectQueryBuilder`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> Lists variants based on the provided parameters and includes the count of variants that match the query. @@ -528,7 +528,7 @@ ___ ### getRegionPrice -▸ **getRegionPrice**(`variantId`, `context`): `Promise`<``null`` \| `number`\> +**getRegionPrice**(`variantId`, `context`): `Promise`<``null`` \| `number`\> Gets the price specific to a region. If no region specific money amount exists the function will try to use a currency price. If no default @@ -583,7 +583,7 @@ ___ ### isVariantInSalesChannels -▸ **isVariantInSalesChannels**(`id`, `salesChannelIds`): `Promise`<`boolean`\> +**isVariantInSalesChannels**(`id`, `salesChannelIds`): `Promise`<`boolean`\> Check if the variant is assigned to at least one of the provided sales channels. @@ -636,7 +636,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> #### Parameters @@ -696,7 +696,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`): `Promise`<[[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[], `number`]\> #### Parameters @@ -755,7 +755,7 @@ ___ ### retrieve -▸ **retrieve**(`variantId`, `config?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> +**retrieve**(`variantId`, `config?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> Gets a product variant by id. @@ -808,7 +808,7 @@ ___ ### retrieveBySKU -▸ **retrieveBySKU**(`sku`, `config?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> +**retrieveBySKU**(`sku`, `config?`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> Gets a product variant by id. @@ -861,7 +861,7 @@ ___ ### setCurrencyPrice -▸ **setCurrencyPrice**(`variantId`, `price`): `Promise`<[`MoneyAmount`](admin_collections.internal.MoneyAmount.mdx)\> +**setCurrencyPrice**(`variantId`, `price`): `Promise`<[`MoneyAmount`](admin_collections.internal.MoneyAmount.mdx)\> #### Parameters @@ -917,7 +917,7 @@ ___ ### setRegionPrice -▸ **setRegionPrice**(`variantId`, `price`): `Promise`<[`MoneyAmount`](admin_collections.internal.MoneyAmount.mdx)\> +**setRegionPrice**(`variantId`, `price`): `Promise`<[`MoneyAmount`](admin_collections.internal.MoneyAmount.mdx)\> #### Parameters @@ -973,7 +973,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -1011,7 +1011,7 @@ ___ ### update -▸ **update**(`variantData`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> +**update**(`variantData`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> Updates a collection of variant. @@ -1061,7 +1061,7 @@ Updates a collection of variant. } ]} /> -▸ **update**(`variantOrVariantId`, `update`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> +**update**(`variantOrVariantId`, `update`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> Updates a variant. Price updates should use dedicated methods. @@ -1112,7 +1112,7 @@ The function will throw, if price updates are attempted. } ]} /> -▸ **update**(`variantOrVariantId`, `update`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> +**update**(`variantOrVariantId`, `update`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)\> #### Parameters @@ -1163,7 +1163,7 @@ ___ ### updateBatch -▸ `Protected` **updateBatch**(`variantData`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> +`Protected` **updateBatch**(`variantData`): `Promise`<[`ProductVariant`](admin_collections.internal.ProductVariant.mdx)[]\> #### Parameters @@ -1215,7 +1215,7 @@ ___ ### updateOptionValue -▸ **updateOptionValue**(`variantId`, `optionId`, `optionValue`): `Promise`<[`ProductOptionValue`](admin_collections.internal.ProductOptionValue.mdx)\> +**updateOptionValue**(`variantId`, `optionId`, `optionValue`): `Promise`<[`ProductOptionValue`](admin_collections.internal.ProductOptionValue.mdx)\> Updates variant's option value. Option value must be of type string or number. @@ -1277,7 +1277,7 @@ ___ ### updateVariantPrices -▸ **updateVariantPrices**(`data`): `Promise`<`void`\> +**updateVariantPrices**(`data`): `Promise`<`void`\> Updates variant/prices collection. Deletes any prices that are not in the update object, and is not associated with a price list. @@ -1310,7 +1310,7 @@ Deletes any prices that are not in the update object, and is not associated with } ]} /> -▸ **updateVariantPrices**(`variantId`, `prices`): `Promise`<`void`\> +**updateVariantPrices**(`variantId`, `prices`): `Promise`<`void`\> Updates a variant's prices. Deletes any prices that are not in the update object, and is not associated with a price list. @@ -1355,7 +1355,7 @@ ___ ### updateVariantPricesBatch -▸ `Protected` **updateVariantPricesBatch**(`data`): `Promise`<`void`\> +`Protected` **updateVariantPricesBatch**(`data`): `Promise`<`void`\> #### Parameters @@ -1389,7 +1389,7 @@ ___ ### upsertCurrencyPrices -▸ **upsertCurrencyPrices**(`data`): `Promise`<`void`\> +**upsertCurrencyPrices**(`data`): `Promise`<`void`\> #### Parameters @@ -1423,7 +1423,7 @@ ___ ### upsertRegionPrices -▸ **upsertRegionPrices**(`data`): `Promise`<`void`\> +**upsertRegionPrices**(`data`): `Promise`<`void`\> #### Parameters @@ -1457,7 +1457,7 @@ ___ ### validateVariantsToCreate\_ -▸ `Protected` **validateVariantsToCreate_**(`product`, `variants`): `void` +`Protected` **validateVariantsToCreate_**(`product`, `variants`): `void` #### Parameters @@ -1499,7 +1499,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`ProductVariantService`](admin_discounts.internal.internal.ProductVariantService.mdx) +**withTransaction**(`transactionManager?`): [`ProductVariantService`](admin_discounts.internal.internal.ProductVariantService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.RegionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.RegionService.mdx index 81854fb702..805ba32a24 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.RegionService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.RegionService.mdx @@ -179,7 +179,7 @@ Provides layer to manipulate regions. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -204,7 +204,7 @@ TransactionBaseService.activeManager\_ ### addCountry -▸ **addCountry**(`regionId`, `code`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> +**addCountry**(`regionId`, `code`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> Adds a country to the region. @@ -257,7 +257,7 @@ ___ ### addFulfillmentProvider -▸ **addFulfillmentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> +**addFulfillmentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> Adds a fulfillment provider that is available in the region. Fails if the provider doesn't exist. @@ -311,7 +311,7 @@ ___ ### addPaymentProvider -▸ **addPaymentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> +**addPaymentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> Adds a payment provider that is available in the region. Fails if the provider doesn't exist. @@ -365,7 +365,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -442,7 +442,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> +**create**(`data`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> Creates a region. @@ -487,7 +487,7 @@ ___ ### delete -▸ **delete**(`regionId`): `Promise`<`void`\> +**delete**(`regionId`): `Promise`<`void`\> Deletes a region. @@ -523,7 +523,7 @@ ___ ### list -▸ **list**(`selector?`, `config?`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)[]\> +**list**(`selector?`, `config?`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)[]\> Lists all regions based on a query @@ -585,7 +585,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector?`, `config?`): `Promise`<[[`Region`](admin_collections.internal.Region.mdx)[], `number`]\> +**listAndCount**(`selector?`, `config?`): `Promise`<[[`Region`](admin_collections.internal.Region.mdx)[], `number`]\> Lists all regions based on a query and returns them along with count @@ -646,7 +646,7 @@ ___ ### removeCountry -▸ **removeCountry**(`regionId`, `code`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> +**removeCountry**(`regionId`, `code`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> Removes a country from a Region. @@ -699,7 +699,7 @@ ___ ### removeFulfillmentProvider -▸ **removeFulfillmentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> +**removeFulfillmentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> Removes a fulfillment provider from a region. Is idempotent. @@ -752,7 +752,7 @@ ___ ### removePaymentProvider -▸ **removePaymentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> +**removePaymentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> Removes a payment provider from a region. Is idempotent. @@ -805,7 +805,7 @@ ___ ### retrieve -▸ **retrieve**(`regionId`, `config?`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> +**retrieve**(`regionId`, `config?`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> Retrieves a region by its id. @@ -858,7 +858,7 @@ ___ ### retrieveByCountryCode -▸ **retrieveByCountryCode**(`code`, `config?`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> +**retrieveByCountryCode**(`code`, `config?`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> Retrieve a region by country code. @@ -911,7 +911,7 @@ ___ ### retrieveByName -▸ **retrieveByName**(`name`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> +**retrieveByName**(`name`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> Retrieves a region by name. @@ -956,7 +956,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -994,7 +994,7 @@ ___ ### update -▸ **update**(`regionId`, `update`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> +**update**(`regionId`, `update`): `Promise`<[`Region`](admin_collections.internal.Region.mdx)\> Updates a region @@ -1047,7 +1047,7 @@ ___ ### validateCountry -▸ `Protected` **validateCountry**(`code`, `regionId`): `Promise`<[`Country`](admin_collections.internal.Country.mdx)\> +`Protected` **validateCountry**(`code`, `regionId`): `Promise`<[`Country`](admin_collections.internal.Country.mdx)\> Validates a country code. Will normalize the code before checking for existence. @@ -1101,7 +1101,7 @@ ___ ### validateCurrency -▸ `Protected` **validateCurrency**(`currencyCode`): `Promise`<`void`\> +`Protected` **validateCurrency**(`currencyCode`): `Promise`<`void`\> Validates a currency code. Will throw if the currency code doesn't exist. @@ -1141,7 +1141,7 @@ ___ ### validateFields -▸ `Protected` **validateFields**<`T`\>(`regionData`, `id?`): `Promise`<`DeepPartial`<[`Region`](admin_collections.internal.Region.mdx)\>\> +`Protected` **validateFields**<`T`\>(`regionData`, `id?`): `Promise`<`DeepPartial`<[`Region`](admin_collections.internal.Region.mdx)\>\> Validates fields for creation and updates. If the region already exists the id can be passed to check that country updates are allowed. @@ -1215,7 +1215,7 @@ ___ ### validateTaxRate -▸ `Protected` **validateTaxRate**(`taxRate`): `void` +`Protected` **validateTaxRate**(`taxRate`): `void` Validates a tax rate. Will throw if the tax rate is not between 0 and 1. @@ -1255,7 +1255,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`RegionService`](admin_discounts.internal.internal.RegionService.mdx) +**withTransaction**(`transactionManager?`): [`RegionService`](admin_discounts.internal.internal.RegionService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnReasonService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnReasonService.mdx index af93d65244..1115e4836c 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnReasonService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnReasonService.mdx @@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -90,7 +90,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -167,7 +167,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)\> +**create**(`data`): `Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)\> #### Parameters @@ -210,7 +210,7 @@ ___ ### delete -▸ **delete**(`returnReasonId`): `Promise`<`void`\> +**delete**(`returnReasonId`): `Promise`<`void`\> #### Parameters @@ -244,7 +244,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)[]\> #### Parameters @@ -304,7 +304,7 @@ ___ ### retrieve -▸ **retrieve**(`returnReasonId`, `config?`): `Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)\> +**retrieve**(`returnReasonId`, `config?`): `Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)\> Gets an order by id. @@ -357,7 +357,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -395,7 +395,7 @@ ___ ### update -▸ **update**(`id`, `data`): `Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)\> +**update**(`id`, `data`): `Promise`<[`ReturnReason`](admin_collections.internal.ReturnReason.mdx)\> #### Parameters @@ -446,7 +446,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`ReturnReasonService`](admin_discounts.internal.internal.ReturnReasonService.mdx) +**withTransaction**(`transactionManager?`): [`ReturnReasonService`](admin_discounts.internal.internal.ReturnReasonService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnService.mdx index 9c629731c5..c57db92e69 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ReturnService.mdx @@ -145,7 +145,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -170,7 +170,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -247,7 +247,7 @@ ___ ### cancel -▸ **cancel**(`returnId`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> +**cancel**(`returnId`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> Cancels a return if possible. Returns can be canceled if it has not been received. @@ -292,7 +292,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> +**create**(`data`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> Creates a return request for an order, with given items, and a shipping method. If no refund amount is provided the refund amount is calculated from @@ -339,7 +339,7 @@ ___ ### fulfill -▸ **fulfill**(`returnId`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> +**fulfill**(`returnId`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> #### Parameters @@ -382,7 +382,7 @@ ___ ### getFulfillmentItems -▸ `Protected` **getFulfillmentItems**(`order`, `items`, `transformer`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx) & { `note?`: `string` ; `reason_id?`: `string` }[]\> +`Protected` **getFulfillmentItems**(`order`, `items`, `transformer`): `Promise`<[`LineItem`](admin_collections.internal.LineItem.mdx) & { `note?`: `string` ; `reason_id?`: `string` }[]\> Retrieves the order line items, given an array of items @@ -452,7 +452,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)[]\> #### Parameters @@ -512,7 +512,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Return`](admin_collections.internal.Return.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`): `Promise`<[[`Return`](admin_collections.internal.Return.mdx)[], `number`]\> #### Parameters @@ -571,7 +571,7 @@ ___ ### receive -▸ **receive**(`returnId`, `receivedItems`, `refundAmount?`, `allowMismatch?`, `context?`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> +**receive**(`returnId`, `receivedItems`, `refundAmount?`, `allowMismatch?`, `context?`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> Registers a previously requested return as received. This will create a refund to the customer. If the returned items don't match the requested @@ -662,7 +662,7 @@ ___ ### retrieve -▸ **retrieve**(`returnId`, `config?`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> +**retrieve**(`returnId`, `config?`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> Retrieves a return by its id. @@ -715,7 +715,7 @@ ___ ### retrieveBySwap -▸ **retrieveBySwap**(`swapId`, `relations?`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> +**retrieveBySwap**(`swapId`, `relations?`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> #### Parameters @@ -766,7 +766,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -804,7 +804,7 @@ ___ ### update -▸ **update**(`returnId`, `update`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> +**update**(`returnId`, `update`): `Promise`<[`Return`](admin_collections.internal.Return.mdx)\> #### Parameters @@ -855,7 +855,7 @@ ___ ### validateReturnLineItem -▸ `Protected` **validateReturnLineItem**(`item?`, `quantity?`, `additional?`): `DeepPartial`<[`LineItem`](admin_collections.internal.LineItem.mdx)\> +`Protected` **validateReturnLineItem**(`item?`, `quantity?`, `additional?`): `DeepPartial`<[`LineItem`](admin_collections.internal.LineItem.mdx)\> Checks that a given quantity of a line item can be returned. Fails if the item is undefined or if the returnable quantity of the item is lower, than @@ -934,7 +934,7 @@ ___ ### validateReturnStatuses -▸ `Protected` **validateReturnStatuses**(`order`): `void` +`Protected` **validateReturnStatuses**(`order`): `void` Checks that an order has the statuses necessary to complete a return. fulfillment_status cannot be not_fulfilled or returned. @@ -976,7 +976,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`ReturnService`](admin_discounts.internal.internal.ReturnService.mdx) +**withTransaction**(`transactionManager?`): [`ReturnService`](admin_discounts.internal.internal.ReturnService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelInventoryService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelInventoryService.mdx index d7c22ca730..64b6a99aae 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelInventoryService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelInventoryService.mdx @@ -81,7 +81,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -106,7 +106,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -183,7 +183,7 @@ ___ ### retrieveAvailableItemQuantity -▸ **retrieveAvailableItemQuantity**(`salesChannelId`, `inventoryItemId`): `Promise`<`number`\> +**retrieveAvailableItemQuantity**(`salesChannelId`, `inventoryItemId`): `Promise`<`number`\> Retrieves the available quantity of an item across all sales channel locations @@ -236,7 +236,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -274,7 +274,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`SalesChannelInventoryService`](admin_discounts.internal.internal.SalesChannelInventoryService.mdx) +**withTransaction**(`transactionManager?`): [`SalesChannelInventoryService`](admin_discounts.internal.internal.SalesChannelInventoryService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelLocationService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelLocationService.mdx index b21f5f7cd1..bb11d500ff 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelLocationService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelLocationService.mdx @@ -83,7 +83,7 @@ Service for managing the stock locations of sales channels ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -108,7 +108,7 @@ TransactionBaseService.activeManager\_ ### associateLocation -▸ **associateLocation**(`salesChannelId`, `locationId`): `Promise`<`void`\> +**associateLocation**(`salesChannelId`, `locationId`): `Promise`<`void`\> Associates a sales channel with a stock location. @@ -152,7 +152,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -229,7 +229,7 @@ ___ ### listLocationIds -▸ **listLocationIds**(`salesChannelId`): `Promise`<`string`[]\> +**listLocationIds**(`salesChannelId`): `Promise`<`string`[]\> Lists the stock locations associated with a sales channel. @@ -283,7 +283,7 @@ ___ ### listSalesChannelIds -▸ **listSalesChannelIds**(`locationId`): `Promise`<`string`[]\> +**listSalesChannelIds**(`locationId`): `Promise`<`string`[]\> Lists the sales channels associated with a stock location. @@ -337,7 +337,7 @@ ___ ### removeLocation -▸ **removeLocation**(`locationId`, `salesChannelId?`): `Promise`<`void`\> +**removeLocation**(`locationId`, `salesChannelId?`): `Promise`<`void`\> Removes an association between a sales channel and a stock location. @@ -381,7 +381,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -419,7 +419,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`SalesChannelLocationService`](admin_discounts.internal.internal.SalesChannelLocationService.mdx) +**withTransaction**(`transactionManager?`): [`SalesChannelLocationService`](admin_discounts.internal.internal.SalesChannelLocationService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelService.mdx index ee30117ee5..3b4c80d304 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SalesChannelService.mdx @@ -113,7 +113,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -138,7 +138,7 @@ TransactionBaseService.activeManager\_ ### addProducts -▸ **addProducts**(`salesChannelId`, `productIds`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> +**addProducts**(`salesChannelId`, `productIds`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> Add a batch of product to a sales channel @@ -191,7 +191,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -268,7 +268,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> +**create**(`data`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> Creates a SalesChannel @@ -316,7 +316,7 @@ ___ ### createDefault -▸ **createDefault**(): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> +**createDefault**(): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> Creates a default sales channel, if this does not already exist. @@ -348,7 +348,7 @@ ___ ### delete -▸ **delete**(`salesChannelId`): `Promise`<`void`\> +**delete**(`salesChannelId`): `Promise`<`void`\> Deletes a sales channel from This feature is under development and may change in the future. @@ -386,7 +386,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`): `Promise`<[[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)[], `number`]\> Lists sales channels based on the provided parameters and includes the count of sales channels that match the query. @@ -448,7 +448,7 @@ ___ ### listProductIdsBySalesChannelIds -▸ **listProductIdsBySalesChannelIds**(`salesChannelIds`): `Promise`<{ `[salesChannelId: string]`: `string`[]; }\> +**listProductIdsBySalesChannelIds**(`salesChannelIds`): `Promise`<{ `[salesChannelId: string]`: `string`[]; }\> List all product ids that belongs to the sales channels ids @@ -493,7 +493,7 @@ ___ ### removeProducts -▸ **removeProducts**(`salesChannelId`, `productIds`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> +**removeProducts**(`salesChannelId`, `productIds`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> Remove a batch of product from a sales channel @@ -546,7 +546,7 @@ ___ ### retrieve -▸ **retrieve**(`salesChannelId`, `config?`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> +**retrieve**(`salesChannelId`, `config?`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> Retrieve a SalesChannel by id @@ -599,7 +599,7 @@ ___ ### retrieveByName -▸ **retrieveByName**(`name`, `config?`): `Promise`<`unknown`\> +**retrieveByName**(`name`, `config?`): `Promise`<`unknown`\> Find a sales channel by name. @@ -652,7 +652,7 @@ ___ ### retrieveDefault -▸ **retrieveDefault**(): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> +**retrieveDefault**(): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> Retrieves the default sales channel. @@ -684,7 +684,7 @@ ___ ### retrieve\_ -▸ `Protected` **retrieve_**(`selector`, `config?`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> +`Protected` **retrieve_**(`selector`, `config?`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> A generic retrieve used to find a sales channel by different attributes. @@ -737,7 +737,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -775,7 +775,7 @@ ___ ### update -▸ **update**(`salesChannelId`, `data`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> +**update**(`salesChannelId`, `data`): `Promise`<[`SalesChannel`](admin_collections.internal.SalesChannel.mdx)\> #### Parameters @@ -826,7 +826,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`SalesChannelService`](admin_discounts.internal.internal.SalesChannelService.mdx) +**withTransaction**(`transactionManager?`): [`SalesChannelService`](admin_discounts.internal.internal.SalesChannelService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SearchService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SearchService.mdx index 524aa9597e..0ccbdff77c 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SearchService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SearchService.mdx @@ -41,7 +41,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### options -• `get` **options**(): Record<`string`, `unknown`\> +`get` **options**(): Record<`string`, `unknown`\> #### Returns @@ -83,7 +83,7 @@ AbstractSearchService.options ### addDocuments -▸ **addDocuments**(`indexName`, `documents`, `type`): `Promise`<`void`\> +**addDocuments**(`indexName`, `documents`, `type`): `Promise`<`void`\> Used to index documents by the search engine provider @@ -139,7 +139,7 @@ ___ ### createIndex -▸ **createIndex**(`indexName`, `options`): `Promise`<`void`\> +**createIndex**(`indexName`, `options`): `Promise`<`void`\> Used to create an index @@ -187,7 +187,7 @@ ___ ### deleteAllDocuments -▸ **deleteAllDocuments**(`indexName`): `Promise`<`void`\> +**deleteAllDocuments**(`indexName`): `Promise`<`void`\> Used to delete all documents @@ -227,7 +227,7 @@ ___ ### deleteDocument -▸ **deleteDocument**(`indexName`, `document_id`): `Promise`<`void`\> +**deleteDocument**(`indexName`, `document_id`): `Promise`<`void`\> Used to delete document @@ -275,7 +275,7 @@ ___ ### getIndex -▸ **getIndex**(`indexName`): `Promise`<`void`\> +**getIndex**(`indexName`): `Promise`<`void`\> Used to get an index @@ -315,7 +315,7 @@ ___ ### replaceDocuments -▸ **replaceDocuments**(`indexName`, `documents`, `type`): `Promise`<`void`\> +**replaceDocuments**(`indexName`, `documents`, `type`): `Promise`<`void`\> Used to replace documents @@ -371,7 +371,7 @@ ___ ### search -▸ **search**(`indexName`, `query`, `options`): `Promise`<{ `hits`: `unknown`[] }\> +**search**(`indexName`, `query`, `options`): `Promise`<{ `hits`: `unknown`[] }\> Used to search for a document in an index @@ -436,7 +436,7 @@ ___ ### updateSettings -▸ **updateSettings**(`indexName`, `settings`): `Promise`<`void`\> +**updateSettings**(`indexName`, `settings`): `Promise`<`void`\> Used to update the settings of an index diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingOptionService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingOptionService.mdx index 78a861a7d2..6133d34247 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingOptionService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingOptionService.mdx @@ -115,7 +115,7 @@ Provides layer to manipulate profiles. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -140,7 +140,7 @@ TransactionBaseService.activeManager\_ ### addRequirement -▸ **addRequirement**(`optionId`, `requirement`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> +**addRequirement**(`optionId`, `requirement`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> Adds a requirement to a shipping option. Only 1 requirement of each type is allowed. @@ -194,7 +194,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -271,7 +271,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> +**create**(`data`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> Creates a new shipping option. Used both for outbound and inbound shipping options. The difference is registered by the `is_return` field which @@ -318,7 +318,7 @@ ___ ### createShippingMethod -▸ **createShippingMethod**(`optionId`, `data`, `config`): `Promise`<[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)\> +**createShippingMethod**(`optionId`, `data`, `config`): `Promise`<[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)\> Creates a shipping method for a given cart. @@ -379,7 +379,7 @@ ___ ### delete -▸ **delete**(`optionId`): `Promise`<`void` \| [`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> +**delete**(`optionId`): `Promise`<`void` \| [`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> Deletes a profile with a given profile id. @@ -424,7 +424,7 @@ ___ ### deleteShippingMethods -▸ **deleteShippingMethods**(`shippingMethods`): `Promise`<[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)[]\> +**deleteShippingMethods**(`shippingMethods`): `Promise`<[`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)[]\> Removes a given shipping method @@ -478,7 +478,7 @@ ___ ### getPrice\_ -▸ **getPrice_**(`option`, `data`, `cart`): `Promise`<`number`\> +**getPrice_**(`option`, `data`, `cart`): `Promise`<`number`\> Returns the amount to be paid for a shipping method. Will ask the fulfillment provider to calculate the price if the shipping option has the @@ -541,7 +541,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]\> #### Parameters @@ -601,7 +601,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`): `Promise`<[[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[], `number`]\> #### Parameters @@ -660,7 +660,7 @@ ___ ### removeRequirement -▸ **removeRequirement**(`requirementId`): `Promise`<`void` \| [`ShippingOptionRequirement`](admin_collections.internal.ShippingOptionRequirement.mdx)\> +**removeRequirement**(`requirementId`): `Promise`<`void` \| [`ShippingOptionRequirement`](admin_collections.internal.ShippingOptionRequirement.mdx)\> Removes a requirement from a shipping option @@ -705,7 +705,7 @@ ___ ### retrieve -▸ **retrieve**(`optionId`, `options?`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> +**retrieve**(`optionId`, `options?`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> Gets a profile by id. Throws in case of DB Error and if profile was not found. @@ -759,7 +759,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -797,7 +797,7 @@ ___ ### update -▸ **update**(`optionId`, `update`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> +**update**(`optionId`, `update`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> Updates a profile. Metadata updates and product updates should use dedicated methods, e.g. `setMetadata`, etc. The function @@ -852,7 +852,7 @@ ___ ### updateShippingMethod -▸ **updateShippingMethod**(`id`, `update`): `Promise`<`undefined` \| [`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)\> +**updateShippingMethod**(`id`, `update`): `Promise`<`undefined` \| [`ShippingMethod`](admin_collections.internal.ShippingMethod.mdx)\> Updates a shipping method's associations. Useful when a cart is completed and its methods should be copied to an order/swap entity. @@ -906,7 +906,7 @@ ___ ### updateShippingProfile -▸ **updateShippingProfile**(`optionIds`, `profileId`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]\> +**updateShippingProfile**(`optionIds`, `profileId`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]\> #### Parameters @@ -966,7 +966,7 @@ ___ ### validateCartOption -▸ **validateCartOption**(`option`, `cart`): `Promise`<``null`` \| [`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> +**validateCartOption**(`option`, `cart`): `Promise`<``null`` \| [`ShippingOption`](admin_collections.internal.ShippingOption.mdx)\> Checks if a given option id is a valid option for a cart. If it is the option is returned with the correct price. Throws when region_ids do not @@ -1021,7 +1021,7 @@ ___ ### validatePriceType\_ -▸ **validatePriceType_**(`priceType`, `option`): `Promise`<[`ShippingOptionPriceType`](../enums/admin_collections.internal.ShippingOptionPriceType.mdx)\> +**validatePriceType_**(`priceType`, `option`): `Promise`<[`ShippingOptionPriceType`](../enums/admin_collections.internal.ShippingOptionPriceType.mdx)\> Validates a shipping option price @@ -1082,7 +1082,7 @@ ___ ### validateRequirement\_ -▸ **validateRequirement_**(`requirement`, `optionId?`): `Promise`<[`ShippingOptionRequirement`](admin_collections.internal.ShippingOptionRequirement.mdx)\> +**validateRequirement_**(`requirement`, `optionId?`): `Promise`<[`ShippingOptionRequirement`](admin_collections.internal.ShippingOptionRequirement.mdx)\> Validates a requirement @@ -1135,7 +1135,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`ShippingOptionService`](admin_discounts.internal.internal.ShippingOptionService.mdx) +**withTransaction**(`transactionManager?`): [`ShippingOptionService`](admin_discounts.internal.internal.ShippingOptionService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingProfileService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingProfileService.mdx index 640c4c1638..1db0221e54 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingProfileService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.ShippingProfileService.mdx @@ -109,7 +109,7 @@ Provides layer to manipulate profiles. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -134,7 +134,7 @@ TransactionBaseService.activeManager\_ ### addProduct -▸ **addProduct**(`profileId`, `productId`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> +**addProduct**(`profileId`, `productId`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> #### Parameters @@ -189,7 +189,7 @@ ___ ### addProducts -▸ **addProducts**(`profileId`, `productId`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> +**addProducts**(`profileId`, `productId`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> Adds a product or an array of products to the profile. @@ -242,7 +242,7 @@ ___ ### addShippingOption -▸ **addShippingOption**(`profileId`, `optionId`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> +**addShippingOption**(`profileId`, `optionId`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> Adds a shipping option to the profile. The shipping option can be used to fulfill the products in the products field. @@ -296,7 +296,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -373,7 +373,7 @@ ___ ### create -▸ **create**(`profile`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> +**create**(`profile`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> Creates a new shipping profile. @@ -418,7 +418,7 @@ ___ ### createDefault -▸ **createDefault**(): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> +**createDefault**(): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> Creates a default shipping profile, if this does not already exist. @@ -450,7 +450,7 @@ ___ ### createGiftCardDefault -▸ **createGiftCardDefault**(): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> +**createGiftCardDefault**(): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> Creates a default shipping profile, for gift cards if unless it already exists. @@ -483,7 +483,7 @@ ___ ### delete -▸ **delete**(`profileId`): `Promise`<`void`\> +**delete**(`profileId`): `Promise`<`void`\> Deletes a profile with a given profile id. @@ -519,7 +519,7 @@ ___ ### fetchCartOptions -▸ **fetchCartOptions**(`cart`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]\> +**fetchCartOptions**(`cart`): `Promise`<[`ShippingOption`](admin_collections.internal.ShippingOption.mdx)[]\> Finds all the shipping profiles that cover the products in a cart, and validates all options that are available for the cart. @@ -574,7 +574,7 @@ ___ ### getMapProfileIdsByProductIds -▸ **getMapProfileIdsByProductIds**(`productIds`): `Promise`<`Map`<`string`, `string`\>\> +**getMapProfileIdsByProductIds**(`productIds`): `Promise`<`Map`<`string`, `string`\>\> #### Parameters @@ -634,7 +634,7 @@ ___ ### getProfilesInCart -▸ `Protected` **getProfilesInCart**(`cart`): `Promise`<`string`[]\> +`Protected` **getProfilesInCart**(`cart`): `Promise`<`string`[]\> Returns a list of all the productIds in the cart. @@ -688,7 +688,7 @@ ___ ### list -▸ **list**(`selector?`, `config?`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)[]\> +**list**(`selector?`, `config?`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)[]\> #### Parameters @@ -748,7 +748,7 @@ ___ ### removeProducts -▸ **removeProducts**(`profileId`, `productId`): `Promise`<`void` \| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> +**removeProducts**(`profileId`, `productId`): `Promise`<`void` \| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> Removes a product or an array of products from the profile. @@ -801,7 +801,7 @@ ___ ### retrieve -▸ **retrieve**(`profileId`, `options?`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> +**retrieve**(`profileId`, `options?`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> Gets a profile by id. Throws in case of DB Error and if profile was not found. @@ -855,7 +855,7 @@ ___ ### retrieveDefault -▸ **retrieveDefault**(): `Promise`<``null`` \| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> +**retrieveDefault**(): `Promise`<``null`` \| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> #### Returns @@ -885,7 +885,7 @@ ___ ### retrieveForProducts -▸ **retrieveForProducts**(`productIds`): `Promise`<{ `[product_id: string]`: [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)[]; }\> +**retrieveForProducts**(`productIds`): `Promise`<{ `[product_id: string]`: [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)[]; }\> #### Parameters @@ -928,7 +928,7 @@ ___ ### retrieveGiftCardDefault -▸ **retrieveGiftCardDefault**(): `Promise`<``null`` \| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> +**retrieveGiftCardDefault**(): `Promise`<``null`` \| [`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> Retrieves the default gift card profile @@ -960,7 +960,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -998,7 +998,7 @@ ___ ### update -▸ **update**(`profileId`, `update`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> +**update**(`profileId`, `update`): `Promise`<[`ShippingProfile`](admin_collections.internal.ShippingProfile.mdx)\> Updates a profile. Metadata updates and product updates should use dedicated methods, e.g. `setMetadata`, `addProduct`, etc. The function @@ -1053,7 +1053,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`ShippingProfileService`](admin_discounts.internal.internal.ShippingProfileService.mdx) +**withTransaction**(`transactionManager?`): [`ShippingProfileService`](admin_discounts.internal.internal.ShippingProfileService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StagedJobService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StagedJobService.mdx index 09d381da31..b8b879ba1f 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StagedJobService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StagedJobService.mdx @@ -67,7 +67,7 @@ Provides layer to manipulate users. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -92,7 +92,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -169,7 +169,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> +**create**(`data`): `Promise`<[`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> #### Parameters @@ -221,7 +221,7 @@ ___ ### delete -▸ **delete**(`stagedJobIds`): `Promise`<`void`\> +**delete**(`stagedJobIds`): `Promise`<`void`\> #### Parameters @@ -255,7 +255,7 @@ ___ ### list -▸ **list**(`config`): `Promise`<[`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> +**list**(`config`): `Promise`<[`StagedJob`](admin_discounts.internal.internal.StagedJob.mdx)[]\> #### Parameters @@ -307,7 +307,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -345,7 +345,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`StagedJobService`](admin_discounts.internal.internal.StagedJobService.mdx) +**withTransaction**(`transactionManager?`): [`StagedJobService`](admin_discounts.internal.internal.StagedJobService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreService.mdx index aff5247de0..df8ff86329 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StoreService.mdx @@ -83,7 +83,7 @@ Provides layer to manipulate store settings. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -108,7 +108,7 @@ TransactionBaseService.activeManager\_ ### addCurrency -▸ **addCurrency**(`code`): `Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> +**addCurrency**(`code`): `Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> Add a currency to the store @@ -153,7 +153,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -230,7 +230,7 @@ ___ ### create -▸ **create**(): `Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> +**create**(): `Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> Creates a store if it doesn't already exist. @@ -262,7 +262,7 @@ ___ ### getDefaultCurrency\_ -▸ `Protected` **getDefaultCurrency_**(`code`): [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`Currency`](admin_collections.internal.Currency.mdx)\> +`Protected` **getDefaultCurrency_**(`code`): [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`Currency`](admin_collections.internal.Currency.mdx)\> #### Parameters @@ -305,7 +305,7 @@ ___ ### removeCurrency -▸ **removeCurrency**(`code`): `Promise`<`any`\> +**removeCurrency**(`code`): `Promise`<`any`\> Removes a currency from the store @@ -350,7 +350,7 @@ ___ ### retrieve -▸ **retrieve**(`config?`): `Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> +**retrieve**(`config?`): `Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> Retrieve the store settings. There is always a maximum of one store. @@ -395,7 +395,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -433,7 +433,7 @@ ___ ### update -▸ **update**(`data`): `Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> +**update**(`data`): `Promise`<[`Store`](admin_discounts.internal.internal.Store.mdx)\> Updates a store @@ -478,7 +478,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`StoreService`](admin_discounts.internal.internal.StoreService.mdx) +**withTransaction**(`transactionManager?`): [`StoreService`](admin_discounts.internal.internal.StoreService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StrategyResolverService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StrategyResolverService.mdx index 5c905243f5..44ba29fd8d 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StrategyResolverService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.StrategyResolverService.mdx @@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -90,7 +90,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -167,7 +167,7 @@ ___ ### resolveBatchJobByType -▸ **resolveBatchJobByType**(`type`): [`AbstractBatchJobStrategy`](admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx) +**resolveBatchJobByType**(`type`): [`AbstractBatchJobStrategy`](admin_discounts.internal.internal.AbstractBatchJobStrategy.mdx) #### Parameters @@ -201,7 +201,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -239,7 +239,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`StrategyResolverService`](admin_discounts.internal.internal.StrategyResolverService.mdx) +**withTransaction**(`transactionManager?`): [`StrategyResolverService`](admin_discounts.internal.internal.StrategyResolverService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SwapService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SwapService.mdx index 0c2f069cb2..e635375f5f 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SwapService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SwapService.mdx @@ -243,7 +243,7 @@ Handles swaps ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -268,7 +268,7 @@ TransactionBaseService.activeManager\_ ### areReturnItemsValid -▸ `Protected` **areReturnItemsValid**(`returnItems`): `Promise`<`boolean`\> +`Protected` **areReturnItemsValid**(`returnItems`): `Promise`<`boolean`\> #### Parameters @@ -311,7 +311,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -388,7 +388,7 @@ ___ ### cancel -▸ **cancel**(`swapId`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> +**cancel**(`swapId`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> Cancels a given swap if possible. A swap can only be canceled if all related returns, fulfillments, and payments have been canceled. If a swap @@ -435,7 +435,7 @@ ___ ### cancelFulfillment -▸ **cancelFulfillment**(`fulfillmentId`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> +**cancelFulfillment**(`fulfillmentId`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> Cancels a fulfillment (if related to a swap) @@ -480,7 +480,7 @@ ___ ### create -▸ **create**(`order`, `returnItems`, `additionalItems?`, `returnShipping?`, `custom?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> +**create**(`order`, `returnItems`, `additionalItems?`, `returnShipping?`, `custom?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> Creates a swap from an order, with given return items, additional items and an optional return shipping method. @@ -606,7 +606,7 @@ ___ ### createCart -▸ **createCart**(`swapId`, `customShippingOptions?`, `context?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> +**createCart**(`swapId`, `customShippingOptions?`, `context?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> Creates a cart from the given swap. The cart can be used to pay for differences associated with the swap. The swap represented by the @@ -678,7 +678,7 @@ ___ ### createFulfillment -▸ **createFulfillment**(`swapId`, `config?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> +**createFulfillment**(`swapId`, `config?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> Fulfills the additional items associated with the swap. Will call the fulfillment providers associated with the shipping methods. @@ -732,7 +732,7 @@ ___ ### createShipment -▸ **createShipment**(`swapId`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> +**createShipment**(`swapId`, `fulfillmentId`, `trackingLinks?`, `config?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> Marks a fulfillment as shipped and attaches tracking numbers. @@ -801,7 +801,7 @@ ___ ### deleteMetadata -▸ **deleteMetadata**(`swapId`, `key`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> +**deleteMetadata**(`swapId`, `key`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> Dedicated method to delete metadata for a swap. @@ -854,7 +854,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)[]\> List swaps. @@ -916,7 +916,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`Swap`](admin_collections.internal.Swap.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`): `Promise`<[[`Swap`](admin_collections.internal.Swap.mdx)[], `number`]\> List swaps. @@ -977,7 +977,7 @@ ___ ### processDifference -▸ **processDifference**(`swapId`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> +**processDifference**(`swapId`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> Process difference for the requested swap. @@ -1022,7 +1022,7 @@ ___ ### registerCartCompletion -▸ **registerCartCompletion**(`swapId`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> +**registerCartCompletion**(`swapId`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> Register a cart completion @@ -1067,7 +1067,7 @@ ___ ### registerReceived -▸ **registerReceived**(`id`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> +**registerReceived**(`id`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> Registers the swap return items as received so that they cannot be used as a part of other swaps/returns. @@ -1113,7 +1113,7 @@ ___ ### retrieve -▸ **retrieve**(`swapId`, `config?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> +**retrieve**(`swapId`, `config?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> Retrieves a swap with the given id. @@ -1166,7 +1166,7 @@ ___ ### retrieveByCartId -▸ **retrieveByCartId**(`cartId`, `relations?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> +**retrieveByCartId**(`cartId`, `relations?`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> Retrieves a swap based on its associated cart id @@ -1219,7 +1219,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -1257,7 +1257,7 @@ ___ ### transformQueryForCart -▸ `Protected` **transformQueryForCart**(`config`): [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Swap`](admin_collections.internal.Swap.mdx)\>, ``"select"``\> & { `select?`: `string`[] } & { `cartRelations`: `undefined` \| `string`[] ; `cartSelects`: `undefined` \| keyof [`Cart`](admin_collections.internal.Cart.mdx)[] } +`Protected` **transformQueryForCart**(`config`): [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<[`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Swap`](admin_collections.internal.Swap.mdx)\>, ``"select"``\> & { `select?`: `string`[] } & { `cartRelations`: `undefined` \| `string`[] ; `cartSelects`: `undefined` \| keyof [`Cart`](admin_collections.internal.Cart.mdx)[] } Transform find config object for retrieval. @@ -1293,7 +1293,7 @@ ___ ### update -▸ **update**(`swapId`, `update`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> +**update**(`swapId`, `update`): `Promise`<[`Swap`](admin_collections.internal.Swap.mdx)\> Update the swap record. @@ -1346,7 +1346,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`SwapService`](admin_discounts.internal.internal.SwapService.mdx) +**withTransaction**(`transactionManager?`): [`SwapService`](admin_discounts.internal.internal.SwapService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SystemPaymentProviderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SystemPaymentProviderService.mdx index fbde345acb..997b74971f 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SystemPaymentProviderService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.SystemPaymentProviderService.mdx @@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -90,7 +90,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -167,7 +167,7 @@ ___ ### authorizePayment -▸ **authorizePayment**(`_`): `Promise`\> +**authorizePayment**(`_`): `Promise`\> #### Parameters @@ -227,7 +227,7 @@ ___ ### cancelPayment -▸ **cancelPayment**(`_`): `Promise`\> +**cancelPayment**(`_`): `Promise`\> #### Parameters @@ -287,7 +287,7 @@ ___ ### capturePayment -▸ **capturePayment**(`_`): `Promise`\> +**capturePayment**(`_`): `Promise`\> #### Parameters @@ -347,7 +347,7 @@ ___ ### createPayment -▸ **createPayment**(`_`): `Promise`\> +**createPayment**(`_`): `Promise`\> #### Parameters @@ -407,7 +407,7 @@ ___ ### deletePayment -▸ **deletePayment**(`_`): `Promise`\> +**deletePayment**(`_`): `Promise`\> #### Parameters @@ -467,7 +467,7 @@ ___ ### getPaymentData -▸ **getPaymentData**(`_`): `Promise`\> +**getPaymentData**(`_`): `Promise`\> #### Parameters @@ -527,7 +527,7 @@ ___ ### getStatus -▸ **getStatus**(`_`): `Promise`<`string`\> +**getStatus**(`_`): `Promise`<`string`\> #### Parameters @@ -570,7 +570,7 @@ ___ ### refundPayment -▸ **refundPayment**(`_`): `Promise`\> +**refundPayment**(`_`): `Promise`\> #### Parameters @@ -630,7 +630,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -668,7 +668,7 @@ ___ ### updatePayment -▸ **updatePayment**(`_`): `Promise`\> +**updatePayment**(`_`): `Promise`\> #### Parameters @@ -728,7 +728,7 @@ ___ ### updatePaymentData -▸ **updatePaymentData**(`_`): `Promise`\> +**updatePaymentData**(`_`): `Promise`\> #### Parameters @@ -788,7 +788,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`SystemPaymentProviderService`](admin_discounts.internal.internal.SystemPaymentProviderService.mdx) +**withTransaction**(`transactionManager?`): [`SystemPaymentProviderService`](admin_discounts.internal.internal.SystemPaymentProviderService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxProviderService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxProviderService.mdx index f110fe7988..42db227411 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxProviderService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxProviderService.mdx @@ -123,7 +123,7 @@ Finds tax providers and assists in tax related operations. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -148,7 +148,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -225,7 +225,7 @@ ___ ### clearLineItemsTaxLines -▸ **clearLineItemsTaxLines**(`itemIds`): `Promise`<`void`\> +**clearLineItemsTaxLines**(`itemIds`): `Promise`<`void`\> #### Parameters @@ -259,7 +259,7 @@ ___ ### clearTaxLines -▸ **clearTaxLines**(`cartId`): `Promise`<`void`\> +**clearTaxLines**(`cartId`): `Promise`<`void`\> #### Parameters @@ -293,7 +293,7 @@ ___ ### createShippingTaxLines -▸ **createShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]\> +**createShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]\> Persists the tax lines relevant for a shipping method to the database. Used for return shipping methods. @@ -356,7 +356,7 @@ ___ ### createTaxLines -▸ **createTaxLines**(`cartOrLineItems`, `calculationContext`): `Promise`<([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]\> +**createTaxLines**(`cartOrLineItems`, `calculationContext`): `Promise`<([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]\> Persists the tax lines relevant for an order to the database. @@ -418,7 +418,7 @@ ___ ### getRegionRatesForProduct -▸ **getRegionRatesForProduct**(`productIds`, `region`): `Promise`<`Map`<`string`, [`TaxServiceRate`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxservicerate)[]\>\> +**getRegionRatesForProduct**(`productIds`, `region`): `Promise`<`Map`<`string`, [`TaxServiceRate`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxservicerate)[]\>\> Gets the tax rates configured for a product. The rates are cached between calls. @@ -489,7 +489,7 @@ ___ ### getRegionRatesForShipping -▸ **getRegionRatesForShipping**(`optionId`, `regionDetails`): `Promise`<[`TaxServiceRate`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxservicerate)[]\> +**getRegionRatesForShipping**(`optionId`, `regionDetails`): `Promise`<[`TaxServiceRate`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxservicerate)[]\> Gets the tax rates configured for a shipping option. The rates are cached between calls. @@ -552,7 +552,7 @@ ___ ### getShippingTaxLines -▸ **getShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<[`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx)[]\> +**getShippingTaxLines**(`shippingMethod`, `calculationContext`): `Promise`<[`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx)[]\> Gets the relevant tax lines for a shipping method. Note: this method doesn't persist the tax lines. Use createShippingTaxLines if you wish to @@ -616,7 +616,7 @@ ___ ### getTaxLines -▸ **getTaxLines**(`lineItems`, `calculationContext`): `Promise`<([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]\> +**getTaxLines**(`lineItems`, `calculationContext`): `Promise`<([`ShippingMethodTaxLine`](admin_collections.internal.ShippingMethodTaxLine.mdx) \| [`LineItemTaxLine`](admin_collections.internal.LineItemTaxLine.mdx))[]\> Gets the relevant tax lines for an order or cart. If an order is provided the order's tax lines will be returned. If a cart is provided the tax lines @@ -682,7 +682,7 @@ ___ ### getTaxLinesMap -▸ `Protected` **getTaxLinesMap**(`items`, `calculationContext`): `Promise`<[`TaxLinesMaps`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxlinesmaps)\> +`Protected` **getTaxLinesMap**(`items`, `calculationContext`): `Promise`<[`TaxLinesMaps`](../../admin_discounts/modules/admin_discounts.internal.mdx#taxlinesmaps)\> Return a map of tax lines for line items and shipping methods @@ -735,7 +735,7 @@ ___ ### list -▸ **list**(): `Promise`<[`TaxProvider`](admin_collections.internal.TaxProvider.mdx)[]\> +**list**(): `Promise`<[`TaxProvider`](admin_collections.internal.TaxProvider.mdx)[]\> #### Returns @@ -774,7 +774,7 @@ ___ ### registerInstalledProviders -▸ **registerInstalledProviders**(`providers`): `Promise`<`void`\> +**registerInstalledProviders**(`providers`): `Promise`<`void`\> #### Parameters @@ -808,7 +808,7 @@ ___ ### retrieveProvider -▸ **retrieveProvider**(`region`): [`ITaxService`](../interfaces/admin_discounts.internal.internal.ITaxService.mdx) +**retrieveProvider**(`region`): [`ITaxService`](../interfaces/admin_discounts.internal.internal.ITaxService.mdx) Retrieves the relevant tax provider for the given region. @@ -844,7 +844,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -882,7 +882,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx) +**withTransaction**(`transactionManager?`): [`TaxProviderService`](admin_discounts.internal.internal.TaxProviderService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxRateService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxRateService.mdx index 0d0719a4b7..695b99ef1d 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxRateService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TaxRateService.mdx @@ -89,7 +89,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -114,7 +114,7 @@ TransactionBaseService.activeManager\_ ### addToProduct -▸ **addToProduct**(`id`, `productIds`, `replace?`): `Promise`<[`ProductTaxRate`](admin_discounts.internal.internal.ProductTaxRate.mdx) \| [`ProductTaxRate`](admin_discounts.internal.internal.ProductTaxRate.mdx)[]\> +**addToProduct**(`id`, `productIds`, `replace?`): `Promise`<[`ProductTaxRate`](admin_discounts.internal.internal.ProductTaxRate.mdx) \| [`ProductTaxRate`](admin_discounts.internal.internal.ProductTaxRate.mdx)[]\> #### Parameters @@ -173,7 +173,7 @@ ___ ### addToProductType -▸ **addToProductType**(`id`, `productTypeIds`, `replace?`): `Promise`<[`ProductTypeTaxRate`](admin_discounts.internal.internal.ProductTypeTaxRate.mdx)[]\> +**addToProductType**(`id`, `productTypeIds`, `replace?`): `Promise`<[`ProductTypeTaxRate`](admin_discounts.internal.internal.ProductTypeTaxRate.mdx)[]\> #### Parameters @@ -241,7 +241,7 @@ ___ ### addToShippingOption -▸ **addToShippingOption**(`id`, `optionIds`, `replace?`): `Promise`<[`ShippingTaxRate`](admin_discounts.internal.internal.ShippingTaxRate.mdx)[]\> +**addToShippingOption**(`id`, `optionIds`, `replace?`): `Promise`<[`ShippingTaxRate`](admin_discounts.internal.internal.ShippingTaxRate.mdx)[]\> #### Parameters @@ -309,7 +309,7 @@ ___ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -386,7 +386,7 @@ ___ ### create -▸ **create**(`data`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)\> +**create**(`data`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)\> #### Parameters @@ -429,7 +429,7 @@ ___ ### delete -▸ **delete**(`id`): `Promise`<`void`\> +**delete**(`id`): `Promise`<`void`\> #### Parameters @@ -463,7 +463,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]\> #### Parameters @@ -523,7 +523,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`): `Promise`<[[`TaxRate`](admin_collections.internal.TaxRate.mdx)[], `number`]\> +**listAndCount**(`selector`, `config?`): `Promise`<[[`TaxRate`](admin_collections.internal.TaxRate.mdx)[], `number`]\> #### Parameters @@ -582,7 +582,7 @@ ___ ### listByProduct -▸ **listByProduct**(`productId`, `config`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]\> +**listByProduct**(`productId`, `config`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]\> #### Parameters @@ -642,7 +642,7 @@ ___ ### listByShippingOption -▸ **listByShippingOption**(`shippingOptionId`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]\> +**listByShippingOption**(`shippingOptionId`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)[]\> #### Parameters @@ -694,7 +694,7 @@ ___ ### removeFromProduct -▸ **removeFromProduct**(`id`, `productIds`): `Promise`<`void`\> +**removeFromProduct**(`id`, `productIds`): `Promise`<`void`\> #### Parameters @@ -736,7 +736,7 @@ ___ ### removeFromProductType -▸ **removeFromProductType**(`id`, `typeIds`): `Promise`<`void`\> +**removeFromProductType**(`id`, `typeIds`): `Promise`<`void`\> #### Parameters @@ -778,7 +778,7 @@ ___ ### removeFromShippingOption -▸ **removeFromShippingOption**(`id`, `optionIds`): `Promise`<`void`\> +**removeFromShippingOption**(`id`, `optionIds`): `Promise`<`void`\> #### Parameters @@ -820,7 +820,7 @@ ___ ### retrieve -▸ **retrieve**(`taxRateId`, `config?`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)\> +**retrieve**(`taxRateId`, `config?`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)\> #### Parameters @@ -871,7 +871,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -909,7 +909,7 @@ ___ ### update -▸ **update**(`id`, `data`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)\> +**update**(`id`, `data`): `Promise`<[`TaxRate`](admin_collections.internal.TaxRate.mdx)\> #### Parameters @@ -960,7 +960,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`TaxRateService`](admin_discounts.internal.internal.TaxRateService.mdx) +**withTransaction**(`transactionManager?`): [`TaxRateService`](admin_discounts.internal.internal.TaxRateService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TokenService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TokenService.mdx index 6feb6190eb..3697bd6581 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TokenService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TokenService.mdx @@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### signToken -▸ **signToken**(`data`, `options?`): `string` +**signToken**(`data`, `options?`): `string` #### Parameters @@ -75,7 +75,7 @@ ___ ### verifyToken -▸ **verifyToken**(`token`, `options?`): `string` \| `Jwt` \| `JwtPayload` +**verifyToken**(`token`, `options?`): `string` \| `Jwt` \| `JwtPayload` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TotalsService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TotalsService.mdx index c4b03575fa..4ad2519672 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TotalsService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TotalsService.mdx @@ -93,7 +93,7 @@ A service that calculates total and subtotals for orders, carts etc.. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -118,7 +118,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -195,7 +195,7 @@ ___ ### calculateDiscount\_ -▸ **calculateDiscount_**(`lineItem`, `variant`, `variantPrice`, `value`, `discountType`): [`LineDiscount`](../../admin_discounts/modules/admin_discounts.internal.mdx#linediscount) +**calculateDiscount_**(`lineItem`, `variant`, `variantPrice`, `value`, `discountType`): [`LineDiscount`](../../admin_discounts/modules/admin_discounts.internal.mdx#linediscount) Calculates either fixed or percentage discount of a variant @@ -267,7 +267,7 @@ ___ ### getAllocationItemDiscounts -▸ **getAllocationItemDiscounts**(`discount`, `cart`): [`LineDiscount`](../../admin_discounts/modules/admin_discounts.internal.mdx#linediscount)[] +**getAllocationItemDiscounts**(`discount`, `cart`): [`LineDiscount`](../../admin_discounts/modules/admin_discounts.internal.mdx#linediscount)[] If the rule of a discount has allocation="item", then we need to calculate discount on each item in the cart. Furthermore, we need to @@ -324,7 +324,7 @@ ___ ### getAllocationMap -▸ **getAllocationMap**(`orderOrCart`, `options?`): `Promise`<[`LineAllocationsMap`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineallocationsmap)\> +**getAllocationMap**(`orderOrCart`, `options?`): `Promise`<[`LineAllocationsMap`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineallocationsmap)\> Gets a map of discounts and gift cards that apply to line items in an order. The function calculates the amount of a discount or gift card that @@ -411,7 +411,7 @@ ___ ### getCalculationContext -▸ **getCalculationContext**(`calculationContextData`, `options?`): `Promise`<[`TaxCalculationContext`](../modules/admin_discounts.internal.internal.mdx#taxcalculationcontext)\> +**getCalculationContext**(`calculationContextData`, `options?`): `Promise`<[`TaxCalculationContext`](../modules/admin_discounts.internal.internal.mdx#taxcalculationcontext)\> Prepares the calculation context for a tax total calculation. @@ -464,7 +464,7 @@ ___ ### getDiscountTotal -▸ **getDiscountTotal**(`cartOrOrder`): `Promise`<`number`\> +**getDiscountTotal**(`cartOrOrder`): `Promise`<`number`\> Calculates the total discount amount for each of the different supported discount types. If discounts aren't present or invalid returns 0. @@ -510,7 +510,7 @@ ___ ### getGiftCardTotal -▸ **getGiftCardTotal**(`cartOrOrder`, `opts?`): `Promise`<{ `tax_total`: `number` ; `total`: `number` }\> +**getGiftCardTotal**(`cartOrOrder`, `opts?`): `Promise`<{ `tax_total`: `number` ; `total`: `number` }\> Gets the gift card amount on a cart or order. @@ -571,7 +571,7 @@ ___ ### getGiftCardableAmount -▸ **getGiftCardableAmount**(`cartOrOrder`): `Promise`<`number`\> +**getGiftCardableAmount**(`cartOrOrder`): `Promise`<`number`\> Gets the amount that can be gift carded on a cart. In regions where gift cards are taxable this amount should exclude taxes. @@ -617,7 +617,7 @@ ___ ### getLineDiscounts -▸ **getLineDiscounts**(`cartOrOrder`, `discount?`): [`LineDiscountAmount`](../../admin_discounts/modules/admin_discounts.internal.mdx#linediscountamount)[] +**getLineDiscounts**(`cartOrOrder`, `discount?`): [`LineDiscountAmount`](../../admin_discounts/modules/admin_discounts.internal.mdx#linediscountamount)[] Returns the discount amount allocated to the line items of an order. @@ -694,7 +694,7 @@ ___ ### getLineItemAdjustmentsTotal -▸ **getLineItemAdjustmentsTotal**(`cartOrOrder`): `number` +**getLineItemAdjustmentsTotal**(`cartOrOrder`): `number` #### Parameters @@ -728,7 +728,7 @@ ___ ### getLineItemDiscountAdjustment -▸ **getLineItemDiscountAdjustment**(`lineItem`, `discount`): `number` +**getLineItemDiscountAdjustment**(`lineItem`, `discount`): `number` #### Parameters @@ -770,7 +770,7 @@ ___ ### getLineItemRefund -▸ **getLineItemRefund**(`order`, `lineItem`): `Promise`<`number`\> +**getLineItemRefund**(`order`, `lineItem`): `Promise`<`number`\> The amount that can be refunded for a given line item. @@ -823,7 +823,7 @@ ___ ### getLineItemTotal -▸ **getLineItemTotal**(`lineItem`, `cartOrOrder`, `options?`): `Promise`<`number`\> +**getLineItemTotal**(`lineItem`, `cartOrOrder`, `options?`): `Promise`<`number`\> Gets a total for a line item. The total can take gift cards, discounts and taxes into account. This can be controlled through the options. @@ -885,7 +885,7 @@ ___ ### getLineItemTotals -▸ **getLineItemTotals**(`lineItem`, `cartOrOrder`, `options?`): `Promise`<[`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals-1)\> +**getLineItemTotals**(`lineItem`, `cartOrOrder`, `options?`): `Promise`<[`LineItemTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#lineitemtotals-1)\> Breaks down the totals related to a line item; these are the subtotal, the amount of discount applied to the line item, the amount of a gift card @@ -948,7 +948,7 @@ ___ ### getPaidTotal -▸ **getPaidTotal**(`order`): `number` +**getPaidTotal**(`order`): `number` Gets the total payments made on an order @@ -984,7 +984,7 @@ ___ ### getRefundTotal -▸ **getRefundTotal**(`order`, `lineItems`): `Promise`<`number`\> +**getRefundTotal**(`order`, `lineItems`): `Promise`<`number`\> Calculates refund total of line items. If any of the items to return have been discounted, we need to @@ -1039,7 +1039,7 @@ ___ ### getRefundedTotal -▸ **getRefundedTotal**(`order`): `number` +**getRefundedTotal**(`order`): `number` Gets the total refund amount for an order. @@ -1075,7 +1075,7 @@ ___ ### getShippingMethodTotals -▸ **getShippingMethodTotals**(`shippingMethod`, `cartOrOrder`, `opts?`): `Promise`<[`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals-1)\> +**getShippingMethodTotals**(`shippingMethod`, `cartOrOrder`, `opts?`): `Promise`<[`ShippingMethodTotals`](../../admin_discounts/modules/admin_discounts.internal.mdx#shippingmethodtotals-1)\> Gets the totals breakdown for a shipping method. Fetches tax lines if not already provided. @@ -1137,7 +1137,7 @@ ___ ### getShippingTotal -▸ **getShippingTotal**(`cartOrOrder`): `Promise`<`number`\> +**getShippingTotal**(`cartOrOrder`): `Promise`<`number`\> Calculates shipping total @@ -1182,7 +1182,7 @@ ___ ### getSubtotal -▸ **getSubtotal**(`cartOrOrder`, `opts?`): `Promise`<`number`\> +**getSubtotal**(`cartOrOrder`, `opts?`): `Promise`<`number`\> Calculates subtotal of a given cart or order. @@ -1235,7 +1235,7 @@ ___ ### getSwapTotal -▸ **getSwapTotal**(`order`): `number` +**getSwapTotal**(`order`): `number` The total paid for swaps. May be negative in case of negative swap difference. @@ -1272,7 +1272,7 @@ ___ ### getTaxTotal -▸ **getTaxTotal**(`cartOrOrder`, `forceTaxes?`): `Promise`<``null`` \| `number`\> +**getTaxTotal**(`cartOrOrder`, `forceTaxes?`): `Promise`<``null`` \| `number`\> Calculates tax total Currently based on the Danish tax system @@ -1326,7 +1326,7 @@ ___ ### getTotal -▸ **getTotal**(`cartOrOrder`, `options?`): `Promise`<`number`\> +**getTotal**(`cartOrOrder`, `options?`): `Promise`<`number`\> Calculates total of a given cart or order. @@ -1379,7 +1379,7 @@ ___ ### rounded -▸ **rounded**(`value`): `number` +**rounded**(`value`): `number` Rounds a number using Math.round. @@ -1415,7 +1415,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -1453,7 +1453,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`TotalsService`](admin_discounts.internal.internal.TotalsService.mdx) +**withTransaction**(`transactionManager?`): [`TotalsService`](admin_discounts.internal.internal.TotalsService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TransactionBaseService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TransactionBaseService.mdx index f016cec6c5..01e821cb36 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TransactionBaseService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.TransactionBaseService.mdx @@ -57,7 +57,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -78,7 +78,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -151,7 +151,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -185,7 +185,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`TransactionBaseService`](admin_discounts.internal.internal.TransactionBaseService.mdx) +**withTransaction**(`transactionManager?`): [`TransactionBaseService`](admin_discounts.internal.internal.TransactionBaseService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.UserService.mdx b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.UserService.mdx index 6246ad612f..b9ec05865d 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.UserService.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/admin_discounts.internal.internal.UserService.mdx @@ -131,7 +131,7 @@ Provides layer to manipulate users. ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -156,7 +156,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -233,7 +233,7 @@ ___ ### create -▸ **create**(`user`, `password`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> +**create**(`user`, `password`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> Creates a user with username being validated. Fails if email is not a valid format. @@ -287,7 +287,7 @@ ___ ### delete -▸ **delete**(`userId`): `Promise`<`void`\> +**delete**(`userId`): `Promise`<`void`\> Deletes a user from a given user id. @@ -323,7 +323,7 @@ ___ ### generateResetPasswordToken -▸ **generateResetPasswordToken**(`userId`): `Promise`<`string`\> +**generateResetPasswordToken**(`userId`): `Promise`<`string`\> Generate a JSON Web token, that will be sent to a user, that wishes to reset password. @@ -372,7 +372,7 @@ ___ ### hashPassword\_ -▸ **hashPassword_**(`password`): `Promise`<`string`\> +**hashPassword_**(`password`): `Promise`<`string`\> Hashes a password @@ -417,7 +417,7 @@ ___ ### list -▸ **list**(`selector`, `config?`): `Promise`<[`User`](admin_auth.internal.User.mdx)[]\> +**list**(`selector`, `config?`): `Promise`<[`User`](admin_auth.internal.User.mdx)[]\> #### Parameters @@ -477,7 +477,7 @@ ___ ### retrieve -▸ **retrieve**(`userId`, `config?`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> +**retrieve**(`userId`, `config?`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> Gets a user by id. Throws in case of DB Error and if user was not found. @@ -531,7 +531,7 @@ ___ ### retrieveByApiToken -▸ **retrieveByApiToken**(`apiToken`, `relations?`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> +**retrieveByApiToken**(`apiToken`, `relations?`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> Gets a user by api token. Throws in case of DB Error and if user was not found. @@ -585,7 +585,7 @@ ___ ### retrieveByEmail -▸ **retrieveByEmail**(`email`, `config?`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> +**retrieveByEmail**(`email`, `config?`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> Gets a user by email. Throws in case of DB Error and if user was not found. @@ -639,7 +639,7 @@ ___ ### setPassword\_ -▸ **setPassword_**(`userId`, `password`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> +**setPassword_**(`userId`, `password`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> Sets a password for a user Fails if no user exists with userId and if the hashing of the new @@ -694,7 +694,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -732,7 +732,7 @@ ___ ### update -▸ **update**(`userId`, `update`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> +**update**(`userId`, `update`): `Promise`<[`User`](admin_auth.internal.User.mdx)\> Updates a user. @@ -785,7 +785,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`UserService`](admin_discounts.internal.internal.UserService.mdx) +**withTransaction**(`transactionManager?`): [`UserService`](admin_discounts.internal.internal.UserService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/classes/swaps.internal.Axios.mdx b/www/apps/docs/content/references/js-client/internal/classes/swaps.internal.Axios.mdx index ffde818171..e8b78d0d7a 100644 --- a/www/apps/docs/content/references/js-client/internal/classes/swaps.internal.Axios.mdx +++ b/www/apps/docs/content/references/js-client/internal/classes/swaps.internal.Axios.mdx @@ -49,7 +49,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### delete -▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> +**delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> (`url`, `config?`): `Promise`<`R`\> +**get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> (`url`, `config?`): `Promise`<`R`\> +**head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> (`url`, `config?`): `Promise`<`R`\> +**options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> (`url`, `data?`, `config?`): `Promise`<`R`\> +**patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> (`url`, `data?`, `config?`): `Promise`<`R`\> +**post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> (`url`, `data?`, `config?`): `Promise`<`R`\> +**put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> (`config`): `Promise`<`R`\> +**request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\> +**normalizeHeaders**(`obj`): Record<`string`, `any`\> #### Parameters @@ -156,7 +156,7 @@ ___ ### request -▸ **request**(`method`, `path`, `payload?`, `options?`, `customHeaders?`): `Promise`<`any`\> +**request**(`method`, `path`, `payload?`, `options?`, `customHeaders?`): `Promise`<`any`\> Axios request @@ -233,7 +233,7 @@ ___ ### requiresAuthentication -▸ **requiresAuthentication**(`path`, `method`): `boolean` +**requiresAuthentication**(`path`, `method`): `boolean` #### Parameters @@ -275,7 +275,7 @@ ___ ### setHeaders -▸ **setHeaders**(`userHeaders`, `method`, `path`, `customHeaders?`): [`AxiosRequestHeaders`](../../swaps/modules/swaps.internal.mdx#axiosrequestheaders) +**setHeaders**(`userHeaders`, `method`, `path`, `customHeaders?`): [`AxiosRequestHeaders`](../../swaps/modules/swaps.internal.mdx#axiosrequestheaders) Creates all the initial headers. We add the idempotency key, if the request is configured to retry. @@ -336,7 +336,7 @@ ___ ### shouldRetryCondition -▸ **shouldRetryCondition**(`err`, `numRetries`, `maxRetries`): `boolean` +**shouldRetryCondition**(`err`, `numRetries`, `maxRetries`): `boolean` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_auth.internal.UserRoles.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_auth.internal.UserRoles.mdx index 8ba2b0d264..61b398db58 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_auth.internal.UserRoles.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_auth.internal.UserRoles.mdx @@ -12,16 +12,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### ADMIN -• **ADMIN** = ``"admin"`` + **ADMIN** = ``"admin"`` ___ ### DEVELOPER -• **DEVELOPER** = ``"developer"`` + **DEVELOPER** = ``"developer"`` ___ ### MEMBER -• **MEMBER** = ``"member"`` + **MEMBER** = ``"member"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_batch_jobs.internal.BatchJobStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_batch_jobs.internal.BatchJobStatus.mdx index f45167a2b9..de550ef6fa 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_batch_jobs.internal.BatchJobStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_batch_jobs.internal.BatchJobStatus.mdx @@ -12,40 +12,40 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### CANCELED -• **CANCELED** = ``"canceled"`` + **CANCELED** = ``"canceled"`` ___ ### COMPLETED -• **COMPLETED** = ``"completed"`` + **COMPLETED** = ``"completed"`` ___ ### CONFIRMED -• **CONFIRMED** = ``"confirmed"`` + **CONFIRMED** = ``"confirmed"`` ___ ### CREATED -• **CREATED** = ``"created"`` + **CREATED** = ``"created"`` ___ ### FAILED -• **FAILED** = ``"failed"`` + **FAILED** = ``"failed"`` ___ ### PRE\_PROCESSED -• **PRE\_PROCESSED** = ``"pre_processed"`` + **PRE\_PROCESSED** = ``"pre_processed"`` ___ ### PROCESSING -• **PROCESSING** = ``"processing"`` + **PROCESSING** = ``"processing"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.AllocationType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.AllocationType.mdx index 7b53c32332..f4112c0268 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.AllocationType.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.AllocationType.mdx @@ -12,10 +12,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### ITEM -• **ITEM** = ``"item"`` + **ITEM** = ``"item"`` ___ ### TOTAL -• **TOTAL** = ``"total"`` + **TOTAL** = ``"total"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.CartType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.CartType.mdx index cf2fee2032..ec946c18fe 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.CartType.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.CartType.mdx @@ -12,28 +12,28 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### CLAIM -• **CLAIM** = ``"claim"`` + **CLAIM** = ``"claim"`` ___ ### DEFAULT -• **DEFAULT** = ``"default"`` + **DEFAULT** = ``"default"`` ___ ### DRAFT\_ORDER -• **DRAFT\_ORDER** = ``"draft_order"`` + **DRAFT\_ORDER** = ``"draft_order"`` ___ ### PAYMENT\_LINK -• **PAYMENT\_LINK** = ``"payment_link"`` + **PAYMENT\_LINK** = ``"payment_link"`` ___ ### SWAP -• **SWAP** = ``"swap"`` + **SWAP** = ``"swap"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimFulfillmentStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimFulfillmentStatus.mdx index a51c7924fc..957301bb74 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimFulfillmentStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimFulfillmentStatus.mdx @@ -12,52 +12,52 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### CANCELED -• **CANCELED** = ``"canceled"`` + **CANCELED** = ``"canceled"`` ___ ### FULFILLED -• **FULFILLED** = ``"fulfilled"`` + **FULFILLED** = ``"fulfilled"`` ___ ### NOT\_FULFILLED -• **NOT\_FULFILLED** = ``"not_fulfilled"`` + **NOT\_FULFILLED** = ``"not_fulfilled"`` ___ ### PARTIALLY\_FULFILLED -• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` + **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` ___ ### PARTIALLY\_RETURNED -• **PARTIALLY\_RETURNED** = ``"partially_returned"`` + **PARTIALLY\_RETURNED** = ``"partially_returned"`` ___ ### PARTIALLY\_SHIPPED -• **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` + **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` ___ ### REQUIRES\_ACTION -• **REQUIRES\_ACTION** = ``"requires_action"`` + **REQUIRES\_ACTION** = ``"requires_action"`` ___ ### RETURNED -• **RETURNED** = ``"returned"`` + **RETURNED** = ``"returned"`` ___ ### SHIPPED -• **SHIPPED** = ``"shipped"`` + **SHIPPED** = ``"shipped"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimPaymentStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimPaymentStatus.mdx index 1a4272ce06..cdaa3383fb 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimPaymentStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimPaymentStatus.mdx @@ -12,16 +12,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### NA -• **NA** = ``"na"`` + **NA** = ``"na"`` ___ ### NOT\_REFUNDED -• **NOT\_REFUNDED** = ``"not_refunded"`` + **NOT\_REFUNDED** = ``"not_refunded"`` ___ ### REFUNDED -• **REFUNDED** = ``"refunded"`` + **REFUNDED** = ``"refunded"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimReason.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimReason.mdx index 1255f55d6b..8486a1ab99 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimReason.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimReason.mdx @@ -12,22 +12,22 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### MISSING\_ITEM -• **MISSING\_ITEM** = ``"missing_item"`` + **MISSING\_ITEM** = ``"missing_item"`` ___ ### OTHER -• **OTHER** = ``"other"`` + **OTHER** = ``"other"`` ___ ### PRODUCTION\_FAILURE -• **PRODUCTION\_FAILURE** = ``"production_failure"`` + **PRODUCTION\_FAILURE** = ``"production_failure"`` ___ ### WRONG\_ITEM -• **WRONG\_ITEM** = ``"wrong_item"`` + **WRONG\_ITEM** = ``"wrong_item"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimType.mdx index 1fc85322f1..da0bc6f996 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimType.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ClaimType.mdx @@ -12,10 +12,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### REFUND -• **REFUND** = ``"refund"`` + **REFUND** = ``"refund"`` ___ ### REPLACE -• **REPLACE** = ``"replace"`` + **REPLACE** = ``"replace"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionOperator.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionOperator.mdx index bf14bd7e30..b8c2f28fec 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionOperator.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionOperator.mdx @@ -12,10 +12,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### IN -• **IN** = ``"in"`` + **IN** = ``"in"`` ___ ### NOT\_IN -• **NOT\_IN** = ``"not_in"`` + **NOT\_IN** = ``"not_in"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionType.mdx index c058fbe18b..f9d5da3f02 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionType.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountConditionType.mdx @@ -12,28 +12,28 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### CUSTOMER\_GROUPS -• **CUSTOMER\_GROUPS** = ``"customer_groups"`` + **CUSTOMER\_GROUPS** = ``"customer_groups"`` ___ ### PRODUCTS -• **PRODUCTS** = ``"products"`` + **PRODUCTS** = ``"products"`` ___ ### PRODUCT\_COLLECTIONS -• **PRODUCT\_COLLECTIONS** = ``"product_collections"`` + **PRODUCT\_COLLECTIONS** = ``"product_collections"`` ___ ### PRODUCT\_TAGS -• **PRODUCT\_TAGS** = ``"product_tags"`` + **PRODUCT\_TAGS** = ``"product_tags"`` ___ ### PRODUCT\_TYPES -• **PRODUCT\_TYPES** = ``"product_types"`` + **PRODUCT\_TYPES** = ``"product_types"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountRuleType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountRuleType.mdx index 720e8a0839..d95427c8ca 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountRuleType.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DiscountRuleType.mdx @@ -12,16 +12,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### FIXED -• **FIXED** = ``"fixed"`` + **FIXED** = ``"fixed"`` ___ ### FREE\_SHIPPING -• **FREE\_SHIPPING** = ``"free_shipping"`` + **FREE\_SHIPPING** = ``"free_shipping"`` ___ ### PERCENTAGE -• **PERCENTAGE** = ``"percentage"`` + **PERCENTAGE** = ``"percentage"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DraftOrderStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DraftOrderStatus.mdx index 76a49e6a9e..b83df828dc 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DraftOrderStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.DraftOrderStatus.mdx @@ -12,10 +12,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### COMPLETED -• **COMPLETED** = ``"completed"`` + **COMPLETED** = ``"completed"`` ___ ### OPEN -• **OPEN** = ``"open"`` + **OPEN** = ``"open"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.FulfillmentStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.FulfillmentStatus.mdx index 2132408549..da6b813e7d 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.FulfillmentStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.FulfillmentStatus.mdx @@ -12,52 +12,52 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### CANCELED -• **CANCELED** = ``"canceled"`` + **CANCELED** = ``"canceled"`` ___ ### FULFILLED -• **FULFILLED** = ``"fulfilled"`` + **FULFILLED** = ``"fulfilled"`` ___ ### NOT\_FULFILLED -• **NOT\_FULFILLED** = ``"not_fulfilled"`` + **NOT\_FULFILLED** = ``"not_fulfilled"`` ___ ### PARTIALLY\_FULFILLED -• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` + **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"`` ___ ### PARTIALLY\_RETURNED -• **PARTIALLY\_RETURNED** = ``"partially_returned"`` + **PARTIALLY\_RETURNED** = ``"partially_returned"`` ___ ### PARTIALLY\_SHIPPED -• **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` + **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` ___ ### REQUIRES\_ACTION -• **REQUIRES\_ACTION** = ``"requires_action"`` + **REQUIRES\_ACTION** = ``"requires_action"`` ___ ### RETURNED -• **RETURNED** = ``"returned"`` + **RETURNED** = ``"returned"`` ___ ### SHIPPED -• **SHIPPED** = ``"shipped"`` + **SHIPPED** = ``"shipped"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditItemChangeType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditItemChangeType.mdx index 9374735b36..84aade89f8 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditItemChangeType.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditItemChangeType.mdx @@ -12,16 +12,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### ITEM\_ADD -• **ITEM\_ADD** = ``"item_add"`` + **ITEM\_ADD** = ``"item_add"`` ___ ### ITEM\_REMOVE -• **ITEM\_REMOVE** = ``"item_remove"`` + **ITEM\_REMOVE** = ``"item_remove"`` ___ ### ITEM\_UPDATE -• **ITEM\_UPDATE** = ``"item_update"`` + **ITEM\_UPDATE** = ``"item_update"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditStatus.mdx index 36d458aeb6..fcafa8cb39 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderEditStatus.mdx @@ -12,28 +12,28 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### CANCELED -• **CANCELED** = ``"canceled"`` + **CANCELED** = ``"canceled"`` ___ ### CONFIRMED -• **CONFIRMED** = ``"confirmed"`` + **CONFIRMED** = ``"confirmed"`` ___ ### CREATED -• **CREATED** = ``"created"`` + **CREATED** = ``"created"`` ___ ### DECLINED -• **DECLINED** = ``"declined"`` + **DECLINED** = ``"declined"`` ___ ### REQUESTED -• **REQUESTED** = ``"requested"`` + **REQUESTED** = ``"requested"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderStatus.mdx index ac05f8d859..067b9279f9 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.OrderStatus.mdx @@ -12,28 +12,28 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### ARCHIVED -• **ARCHIVED** = ``"archived"`` + **ARCHIVED** = ``"archived"`` ___ ### CANCELED -• **CANCELED** = ``"canceled"`` + **CANCELED** = ``"canceled"`` ___ ### COMPLETED -• **COMPLETED** = ``"completed"`` + **COMPLETED** = ``"completed"`` ___ ### PENDING -• **PENDING** = ``"pending"`` + **PENDING** = ``"pending"`` ___ ### REQUIRES\_ACTION -• **REQUIRES\_ACTION** = ``"requires_action"`` + **REQUIRES\_ACTION** = ``"requires_action"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentCollectionStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentCollectionStatus.mdx index 595c1c6f51..b3bcffa4bb 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentCollectionStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentCollectionStatus.mdx @@ -12,28 +12,28 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AUTHORIZED -• **AUTHORIZED** = ``"authorized"`` + **AUTHORIZED** = ``"authorized"`` ___ ### AWAITING -• **AWAITING** = ``"awaiting"`` + **AWAITING** = ``"awaiting"`` ___ ### CANCELED -• **CANCELED** = ``"canceled"`` + **CANCELED** = ``"canceled"`` ___ ### NOT\_PAID -• **NOT\_PAID** = ``"not_paid"`` + **NOT\_PAID** = ``"not_paid"`` ___ ### PARTIALLY\_AUTHORIZED -• **PARTIALLY\_AUTHORIZED** = ``"partially_authorized"`` + **PARTIALLY\_AUTHORIZED** = ``"partially_authorized"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentStatus.mdx index 26a93bf567..07e0548604 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PaymentStatus.mdx @@ -12,40 +12,40 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AWAITING -• **AWAITING** = ``"awaiting"`` + **AWAITING** = ``"awaiting"`` ___ ### CANCELED -• **CANCELED** = ``"canceled"`` + **CANCELED** = ``"canceled"`` ___ ### CAPTURED -• **CAPTURED** = ``"captured"`` + **CAPTURED** = ``"captured"`` ___ ### NOT\_PAID -• **NOT\_PAID** = ``"not_paid"`` + **NOT\_PAID** = ``"not_paid"`` ___ ### PARTIALLY\_REFUNDED -• **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` + **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` ___ ### REFUNDED -• **REFUNDED** = ``"refunded"`` + **REFUNDED** = ``"refunded"`` ___ ### REQUIRES\_ACTION -• **REQUIRES\_ACTION** = ``"requires_action"`` + **REQUIRES\_ACTION** = ``"requires_action"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListStatus.mdx index c166c703e4..9d1fe68d23 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListStatus.mdx @@ -12,10 +12,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### ACTIVE -• **ACTIVE** = ``"active"`` + **ACTIVE** = ``"active"`` ___ ### DRAFT -• **DRAFT** = ``"draft"`` + **DRAFT** = ``"draft"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListType.mdx index 65b44d3243..3c80209aa5 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListType.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.PriceListType.mdx @@ -12,10 +12,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### OVERRIDE -• **OVERRIDE** = ``"override"`` + **OVERRIDE** = ``"override"`` ___ ### SALE -• **SALE** = ``"sale"`` + **SALE** = ``"sale"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ProductStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ProductStatus.mdx index 77ecd60970..44aeb4b9f5 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ProductStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ProductStatus.mdx @@ -12,22 +12,22 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### DRAFT -• **DRAFT** = ``"draft"`` + **DRAFT** = ``"draft"`` ___ ### PROPOSED -• **PROPOSED** = ``"proposed"`` + **PROPOSED** = ``"proposed"`` ___ ### PUBLISHED -• **PUBLISHED** = ``"published"`` + **PUBLISHED** = ``"published"`` ___ ### REJECTED -• **REJECTED** = ``"rejected"`` + **REJECTED** = ``"rejected"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.RequirementType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.RequirementType.mdx index e121684dac..1ed22bd167 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.RequirementType.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.RequirementType.mdx @@ -12,10 +12,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### MAX\_SUBTOTAL -• **MAX\_SUBTOTAL** = ``"max_subtotal"`` + **MAX\_SUBTOTAL** = ``"max_subtotal"`` ___ ### MIN\_SUBTOTAL -• **MIN\_SUBTOTAL** = ``"min_subtotal"`` + **MIN\_SUBTOTAL** = ``"min_subtotal"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ReturnStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ReturnStatus.mdx index 4d9d34d6a5..a0c0f3ab64 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ReturnStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ReturnStatus.mdx @@ -12,22 +12,22 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### CANCELED -• **CANCELED** = ``"canceled"`` + **CANCELED** = ``"canceled"`` ___ ### RECEIVED -• **RECEIVED** = ``"received"`` + **RECEIVED** = ``"received"`` ___ ### REQUESTED -• **REQUESTED** = ``"requested"`` + **REQUESTED** = ``"requested"`` ___ ### REQUIRES\_ACTION -• **REQUIRES\_ACTION** = ``"requires_action"`` + **REQUIRES\_ACTION** = ``"requires_action"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingOptionPriceType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingOptionPriceType.mdx index f9dfff871d..4e35a17233 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingOptionPriceType.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingOptionPriceType.mdx @@ -12,10 +12,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### CALCULATED -• **CALCULATED** = ``"calculated"`` + **CALCULATED** = ``"calculated"`` ___ ### FLAT\_RATE -• **FLAT\_RATE** = ``"flat_rate"`` + **FLAT\_RATE** = ``"flat_rate"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingProfileType.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingProfileType.mdx index 23120e3342..cb89c30ef1 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingProfileType.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.ShippingProfileType.mdx @@ -12,16 +12,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### CUSTOM -• **CUSTOM** = ``"custom"`` + **CUSTOM** = ``"custom"`` ___ ### DEFAULT -• **DEFAULT** = ``"default"`` + **DEFAULT** = ``"default"`` ___ ### GIFT\_CARD -• **GIFT\_CARD** = ``"gift_card"`` + **GIFT\_CARD** = ``"gift_card"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapFulfillmentStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapFulfillmentStatus.mdx index 90066dbb9f..f2340e37a7 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapFulfillmentStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapFulfillmentStatus.mdx @@ -12,34 +12,34 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### CANCELED -• **CANCELED** = ``"canceled"`` + **CANCELED** = ``"canceled"`` ___ ### FULFILLED -• **FULFILLED** = ``"fulfilled"`` + **FULFILLED** = ``"fulfilled"`` ___ ### NOT\_FULFILLED -• **NOT\_FULFILLED** = ``"not_fulfilled"`` + **NOT\_FULFILLED** = ``"not_fulfilled"`` ___ ### PARTIALLY\_SHIPPED -• **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` + **PARTIALLY\_SHIPPED** = ``"partially_shipped"`` ___ ### REQUIRES\_ACTION -• **REQUIRES\_ACTION** = ``"requires_action"`` + **REQUIRES\_ACTION** = ``"requires_action"`` ___ ### SHIPPED -• **SHIPPED** = ``"shipped"`` + **SHIPPED** = ``"shipped"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapPaymentStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapPaymentStatus.mdx index 8f5cb59ed0..cdd7739e3c 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapPaymentStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_collections.internal.SwapPaymentStatus.mdx @@ -12,52 +12,52 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AWAITING -• **AWAITING** = ``"awaiting"`` + **AWAITING** = ``"awaiting"`` ___ ### CANCELED -• **CANCELED** = ``"canceled"`` + **CANCELED** = ``"canceled"`` ___ ### CAPTURED -• **CAPTURED** = ``"captured"`` + **CAPTURED** = ``"captured"`` ___ ### CONFIRMED -• **CONFIRMED** = ``"confirmed"`` + **CONFIRMED** = ``"confirmed"`` ___ ### DIFFERENCE\_REFUNDED -• **DIFFERENCE\_REFUNDED** = ``"difference_refunded"`` + **DIFFERENCE\_REFUNDED** = ``"difference_refunded"`` ___ ### NOT\_PAID -• **NOT\_PAID** = ``"not_paid"`` + **NOT\_PAID** = ``"not_paid"`` ___ ### PARTIALLY\_REFUNDED -• **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` + **PARTIALLY\_REFUNDED** = ``"partially_refunded"`` ___ ### REFUNDED -• **REFUNDED** = ``"refunded"`` + **REFUNDED** = ``"refunded"`` ___ ### REQUIRES\_ACTION -• **REQUIRES\_ACTION** = ``"requires_action"`` + **REQUIRES\_ACTION** = ``"requires_action"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.DiscountConditionJoinTableForeignKey.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.DiscountConditionJoinTableForeignKey.mdx index 28d3e15684..3590d82273 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.DiscountConditionJoinTableForeignKey.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.DiscountConditionJoinTableForeignKey.mdx @@ -12,28 +12,28 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### CUSTOMER\_GROUP\_ID -• **CUSTOMER\_GROUP\_ID** = ``"customer_group_id"`` + **CUSTOMER\_GROUP\_ID** = ``"customer_group_id"`` ___ ### PRODUCT\_COLLECTION\_ID -• **PRODUCT\_COLLECTION\_ID** = ``"product_collection_id"`` + **PRODUCT\_COLLECTION\_ID** = ``"product_collection_id"`` ___ ### PRODUCT\_ID -• **PRODUCT\_ID** = ``"product_id"`` + **PRODUCT\_ID** = ``"product_id"`` ___ ### PRODUCT\_TAG\_ID -• **PRODUCT\_TAG\_ID** = ``"product_tag_id"`` + **PRODUCT\_TAG\_ID** = ``"product_tag_id"`` ___ ### PRODUCT\_TYPE\_ID -• **PRODUCT\_TYPE\_ID** = ``"product_type_id"`` + **PRODUCT\_TYPE\_ID** = ``"product_type_id"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.FulfillmentStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.FulfillmentStatus.mdx index b92735b141..c73e3130aa 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.FulfillmentStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.FulfillmentStatus.mdx @@ -12,52 +12,52 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### canceled -• **canceled** = ``"canceled"`` + **canceled** = ``"canceled"`` ___ ### fulfilled -• **fulfilled** = ``"fulfilled"`` + **fulfilled** = ``"fulfilled"`` ___ ### not\_fulfilled -• **not\_fulfilled** = ``"not_fulfilled"`` + **not\_fulfilled** = ``"not_fulfilled"`` ___ ### partially\_fulfilled -• **partially\_fulfilled** = ``"partially_fulfilled"`` + **partially\_fulfilled** = ``"partially_fulfilled"`` ___ ### partially\_returned -• **partially\_returned** = ``"partially_returned"`` + **partially\_returned** = ``"partially_returned"`` ___ ### partially\_shipped -• **partially\_shipped** = ``"partially_shipped"`` + **partially\_shipped** = ``"partially_shipped"`` ___ ### requires\_action -• **requires\_action** = ``"requires_action"`` + **requires\_action** = ``"requires_action"`` ___ ### returned -• **returned** = ``"returned"`` + **returned** = ``"returned"`` ___ ### shipped -• **shipped** = ``"shipped"`` + **shipped** = ``"shipped"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.MODULE_RESOURCE_TYPE.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.MODULE_RESOURCE_TYPE.mdx index 1fc22331d9..e656260e0a 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.MODULE_RESOURCE_TYPE.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.MODULE_RESOURCE_TYPE.mdx @@ -12,10 +12,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### ISOLATED -• **ISOLATED** = ``"isolated"`` + **ISOLATED** = ``"isolated"`` ___ ### SHARED -• **SHARED** = ``"shared"`` + **SHARED** = ``"shared"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.OrderStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.OrderStatus.mdx index 6a2333f044..1e151eced0 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.OrderStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.OrderStatus.mdx @@ -12,28 +12,28 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### archived -• **archived** = ``"archived"`` + **archived** = ``"archived"`` ___ ### canceled -• **canceled** = ``"canceled"`` + **canceled** = ``"canceled"`` ___ ### completed -• **completed** = ``"completed"`` + **completed** = ``"completed"`` ___ ### pending -• **pending** = ``"pending"`` + **pending** = ``"pending"`` ___ ### requires\_action -• **requires\_action** = ``"requires_action"`` + **requires\_action** = ``"requires_action"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.PaymentStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.PaymentStatus.mdx index ce3f73be34..1df867b964 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.PaymentStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.PaymentStatus.mdx @@ -12,40 +12,40 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### awaiting -• **awaiting** = ``"awaiting"`` + **awaiting** = ``"awaiting"`` ___ ### canceled -• **canceled** = ``"canceled"`` + **canceled** = ``"canceled"`` ___ ### captured -• **captured** = ``"captured"`` + **captured** = ``"captured"`` ___ ### not\_paid -• **not\_paid** = ``"not_paid"`` + **not\_paid** = ``"not_paid"`` ___ ### partially\_refunded -• **partially\_refunded** = ``"partially_refunded"`` + **partially\_refunded** = ``"partially_refunded"`` ___ ### refunded -• **refunded** = ``"refunded"`` + **refunded** = ``"refunded"`` ___ ### requires\_action -• **requires\_action** = ``"requires_action"`` + **requires\_action** = ``"requires_action"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx index 780775061b..d0ff6e311f 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx @@ -12,28 +12,28 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AUTHORIZED -• **AUTHORIZED** = ``"authorized"`` + **AUTHORIZED** = ``"authorized"`` ___ ### CANCELED -• **CANCELED** = ``"canceled"`` + **CANCELED** = ``"canceled"`` ___ ### ERROR -• **ERROR** = ``"error"`` + **ERROR** = ``"error"`` ___ ### PENDING -• **PENDING** = ``"pending"`` + **PENDING** = ``"pending"`` ___ ### REQUIRES\_MORE -• **REQUIRES\_MORE** = ``"requires_more"`` + **REQUIRES\_MORE** = ``"requires_more"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PostgresError.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PostgresError.mdx index b8f82b9b5d..5812d10602 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PostgresError.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.PostgresError.mdx @@ -12,22 +12,22 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### DUPLICATE\_ERROR -• **DUPLICATE\_ERROR** = ``"23505"`` + **DUPLICATE\_ERROR** = ``"23505"`` ___ ### FOREIGN\_KEY\_ERROR -• **FOREIGN\_KEY\_ERROR** = ``"23503"`` + **FOREIGN\_KEY\_ERROR** = ``"23503"`` ___ ### NULL\_VIOLATION -• **NULL\_VIOLATION** = ``"23502"`` + **NULL\_VIOLATION** = ``"23502"`` ___ ### SERIALIZATION\_FAILURE -• **SERIALIZATION\_FAILURE** = ``"40001"`` + **SERIALIZATION\_FAILURE** = ``"40001"`` diff --git a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.RefundReason.mdx b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.RefundReason.mdx index 820c745203..fc2c7ad117 100644 --- a/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.RefundReason.mdx +++ b/www/apps/docs/content/references/js-client/internal/enums/admin_discounts.internal.internal.RefundReason.mdx @@ -12,28 +12,28 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### CLAIM -• **CLAIM** = ``"claim"`` + **CLAIM** = ``"claim"`` ___ ### DISCOUNT -• **DISCOUNT** = ``"discount"`` + **DISCOUNT** = ``"discount"`` ___ ### OTHER -• **OTHER** = ``"other"`` + **OTHER** = ``"other"`` ___ ### RETURN -• **RETURN** = ``"return"`` + **RETURN** = ``"return"`` ___ ### SWAP -• **SWAP** = ``"swap"`` + **SWAP** = ``"swap"`` diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_collections.internal.Boolean.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_collections.internal.Boolean.mdx index 323d8dccf0..5f3b35079a 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_collections.internal.Boolean.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_collections.internal.Boolean.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### valueOf -▸ **valueOf**(): `boolean` +**valueOf**(): `boolean` Returns the primitive value of the specified object. diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGenerator.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGenerator.mdx index e34796f6b4..f2a88283ce 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGenerator.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGenerator.mdx @@ -41,7 +41,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### [asyncIterator] -▸ **[asyncIterator]**(): [`AsyncGenerator`](admin_discounts.internal.AsyncGenerator.mdx)<`T`, `TReturn`, `TNext`\> +**[asyncIterator]**(): [`AsyncGenerator`](admin_discounts.internal.AsyncGenerator.mdx)<`T`, `TReturn`, `TNext`\> #### Returns @@ -62,7 +62,7 @@ ___ ### next -▸ **next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> +**next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> #### Parameters @@ -109,7 +109,7 @@ ___ ### return -▸ **return**(`value`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> +**return**(`value`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> #### Parameters @@ -156,7 +156,7 @@ ___ ### throw -▸ **throw**(`e`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> +**throw**(`e`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx index 21663e1fdf..830681fcbf 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncGeneratorFunction.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AsyncGeneratorFunction -▸ **AsyncGeneratorFunction**(`...args`): [`AsyncGenerator`](admin_discounts.internal.AsyncGenerator.mdx)<`unknown`, `any`, `unknown`\> +**AsyncGeneratorFunction**(`...args`): [`AsyncGenerator`](admin_discounts.internal.AsyncGenerator.mdx)<`unknown`, `any`, `unknown`\> Creates a new AsyncGenerator object. diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterable.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterable.mdx index 692df65fac..3610744114 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterable.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterable.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### [asyncIterator] -▸ **[asyncIterator]**(): [`AsyncIterator`](admin_discounts.internal.AsyncIterator.mdx)<`T`, `any`, `undefined`\> +**[asyncIterator]**(): [`AsyncIterator`](admin_discounts.internal.AsyncIterator.mdx)<`T`, `any`, `undefined`\> #### Returns diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx index 38ade018d2..1216362386 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterableIterator.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### [asyncIterator] -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`T`\> +**[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`T`\> #### Returns @@ -46,7 +46,7 @@ ___ ### next -▸ **next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\> +**next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\> #### Parameters @@ -102,7 +102,7 @@ ___ ### return -▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\> +`Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\> #### Parameters @@ -158,7 +158,7 @@ ___ ### throw -▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\> +`Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\>\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterator.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterator.mdx index 47c92b1522..0e0f838e0a 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterator.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.AsyncIterator.mdx @@ -41,7 +41,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### next -▸ **next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> +**next**(`...args`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> #### Parameters @@ -84,7 +84,7 @@ ___ ### return -▸ `Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> +`Optional` **return**(`value?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> #### Parameters @@ -127,7 +127,7 @@ ___ ### throw -▸ `Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> +`Optional` **throw**(`e?`): `Promise`<[`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\>\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Buffer.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Buffer.mdx index 8c75be99b1..7a91273fb8 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Buffer.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Buffer.mdx @@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### [iterator] -▸ **[iterator]**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`number`\> +**[iterator]**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`number`\> #### Returns @@ -99,7 +99,7 @@ ___ ### at -▸ **at**(`index`): `undefined` \| `number` +**at**(`index`): `undefined` \| `number` Takes an integer value and returns the item at that index, allowing for positive and negative integers. @@ -141,7 +141,7 @@ ___ ### compare -▸ **compare**(`target`, `targetStart?`, `targetEnd?`, `sourceStart?`, `sourceEnd?`): ``0`` \| ``1`` \| ``-1`` +**compare**(`target`, `targetStart?`, `targetEnd?`, `sourceStart?`, `sourceEnd?`): ``0`` \| ``1`` \| ``-1`` Compares `buf` with `target` and returns a number indicating whether `buf`comes before, after, or is the same as `target` in sort order. Comparison is based on the actual sequence of bytes in each `Buffer`. @@ -258,7 +258,7 @@ ___ ### copy -▸ **copy**(`target`, `targetStart?`, `sourceStart?`, `sourceEnd?`): `number` +**copy**(`target`, `targetStart?`, `sourceStart?`, `sourceEnd?`): `number` Copies data from a region of `buf` to a region in `target`, even if the `target`memory region overlaps with `buf`. @@ -366,7 +366,7 @@ ___ ### copyWithin -▸ **copyWithin**(`target`, `start`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**copyWithin**(`target`, `start`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Returns the this object after copying a section of the array identified by start and end to the same array starting at position target @@ -423,7 +423,7 @@ ___ ### entries -▸ **entries**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<[`number`, `number`]\> +**entries**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<[`number`, `number`]\> Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `[index, byte]` pairs from the contents of `buf`. @@ -491,7 +491,7 @@ ___ ### equals -▸ **equals**(`otherBuffer`): `boolean` +**equals**(`otherBuffer`): `boolean` Returns `true` if both `buf` and `otherBuffer` have exactly the same bytes,`false` otherwise. Equivalent to `buf.compare(otherBuffer) === 0`. @@ -544,7 +544,7 @@ ___ ### every -▸ **every**(`predicate`, `thisArg?`): `boolean` +**every**(`predicate`, `thisArg?`): `boolean` Determines whether all the members of an array satisfy the specified test. @@ -592,7 +592,7 @@ ___ ### fill -▸ **fill**(`value`, `offset?`, `end?`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**fill**(`value`, `offset?`, `end?`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Fills `buf` with the specified `value`. If the `offset` and `end` are not given, the entire `buf` will be filled: @@ -710,7 +710,7 @@ ___ ### filter -▸ **filter**(`predicate`, `thisArg?`): `Uint8Array` +**filter**(`predicate`, `thisArg?`): `Uint8Array` Returns the elements of an array that meet the condition specified in a callback function. @@ -758,7 +758,7 @@ ___ ### find -▸ **find**(`predicate`, `thisArg?`): `undefined` \| `number` +**find**(`predicate`, `thisArg?`): `undefined` \| `number` Returns the value of the first element in the array where predicate is true, and undefined otherwise. @@ -807,7 +807,7 @@ ___ ### findIndex -▸ **findIndex**(`predicate`, `thisArg?`): `number` +**findIndex**(`predicate`, `thisArg?`): `number` Returns the index of the first element in the array where predicate is true, and -1 otherwise. @@ -856,7 +856,7 @@ ___ ### forEach -▸ **forEach**(`callbackfn`, `thisArg?`): `void` +**forEach**(`callbackfn`, `thisArg?`): `void` Performs the specified action for each element in an array. @@ -904,7 +904,7 @@ ___ ### includes -▸ **includes**(`value`, `byteOffset?`, `encoding?`): `boolean` +**includes**(`value`, `byteOffset?`, `encoding?`): `boolean` Equivalent to `buf.indexOf() !== -1`. @@ -985,7 +985,7 @@ ___ ### indexOf -▸ **indexOf**(`value`, `byteOffset?`, `encoding?`): `number` +**indexOf**(`value`, `byteOffset?`, `encoding?`): `number` If `value` is: @@ -1105,7 +1105,7 @@ ___ ### join -▸ **join**(`separator?`): `string` +**join**(`separator?`): `string` Adds all the elements of an array separated by the specified separator string. @@ -1145,7 +1145,7 @@ ___ ### keys -▸ **keys**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`number`\> +**keys**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`number`\> Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `buf` keys (indices). @@ -1202,7 +1202,7 @@ ___ ### lastIndexOf -▸ **lastIndexOf**(`value`, `byteOffset?`, `encoding?`): `number` +**lastIndexOf**(`value`, `byteOffset?`, `encoding?`): `number` Identical to `buf.indexOf()`, except the last occurrence of `value` is found rather than the first occurrence. @@ -1321,7 +1321,7 @@ ___ ### map -▸ **map**(`callbackfn`, `thisArg?`): `Uint8Array` +**map**(`callbackfn`, `thisArg?`): `Uint8Array` Calls a defined callback function on each element of an array, and returns an array that contains the results. @@ -1370,7 +1370,7 @@ ___ ### readBigInt64BE -▸ **readBigInt64BE**(`offset?`): `bigint` +**readBigInt64BE**(`offset?`): `bigint` Reads a signed, big-endian 64-bit integer from `buf` at the specified `offset`. @@ -1413,7 +1413,7 @@ ___ ### readBigInt64LE -▸ **readBigInt64LE**(`offset?`): `bigint` +**readBigInt64LE**(`offset?`): `bigint` Reads a signed, little-endian 64-bit integer from `buf` at the specified`offset`. @@ -1456,7 +1456,7 @@ ___ ### readBigUInt64BE -▸ **readBigUInt64BE**(`offset?`): `bigint` +**readBigUInt64BE**(`offset?`): `bigint` Reads an unsigned, big-endian 64-bit integer from `buf` at the specified`offset`. @@ -1507,7 +1507,7 @@ ___ ### readBigUInt64LE -▸ **readBigUInt64LE**(`offset?`): `bigint` +**readBigUInt64LE**(`offset?`): `bigint` Reads an unsigned, little-endian 64-bit integer from `buf` at the specified`offset`. @@ -1558,7 +1558,7 @@ ___ ### readBigUint64BE -▸ **readBigUint64BE**(`offset?`): `bigint` +**readBigUint64BE**(`offset?`): `bigint` #### Parameters @@ -1600,7 +1600,7 @@ ___ ### readBigUint64LE -▸ **readBigUint64LE**(`offset?`): `bigint` +**readBigUint64LE**(`offset?`): `bigint` #### Parameters @@ -1642,7 +1642,7 @@ ___ ### readDoubleBE -▸ **readDoubleBE**(`offset?`): `number` +**readDoubleBE**(`offset?`): `number` Reads a 64-bit, big-endian double from `buf` at the specified `offset`. @@ -1691,7 +1691,7 @@ ___ ### readDoubleLE -▸ **readDoubleLE**(`offset?`): `number` +**readDoubleLE**(`offset?`): `number` Reads a 64-bit, little-endian double from `buf` at the specified `offset`. @@ -1742,7 +1742,7 @@ ___ ### readFloatBE -▸ **readFloatBE**(`offset?`): `number` +**readFloatBE**(`offset?`): `number` Reads a 32-bit, big-endian float from `buf` at the specified `offset`. @@ -1791,7 +1791,7 @@ ___ ### readFloatLE -▸ **readFloatLE**(`offset?`): `number` +**readFloatLE**(`offset?`): `number` Reads a 32-bit, little-endian float from `buf` at the specified `offset`. @@ -1842,7 +1842,7 @@ ___ ### readInt16BE -▸ **readInt16BE**(`offset?`): `number` +**readInt16BE**(`offset?`): `number` Reads a signed, big-endian 16-bit integer from `buf` at the specified `offset`. @@ -1893,7 +1893,7 @@ ___ ### readInt16LE -▸ **readInt16LE**(`offset?`): `number` +**readInt16LE**(`offset?`): `number` Reads a signed, little-endian 16-bit integer from `buf` at the specified`offset`. @@ -1946,7 +1946,7 @@ ___ ### readInt32BE -▸ **readInt32BE**(`offset?`): `number` +**readInt32BE**(`offset?`): `number` Reads a signed, big-endian 32-bit integer from `buf` at the specified `offset`. @@ -1997,7 +1997,7 @@ ___ ### readInt32LE -▸ **readInt32LE**(`offset?`): `number` +**readInt32LE**(`offset?`): `number` Reads a signed, little-endian 32-bit integer from `buf` at the specified`offset`. @@ -2050,7 +2050,7 @@ ___ ### readInt8 -▸ **readInt8**(`offset?`): `number` +**readInt8**(`offset?`): `number` Reads a signed 8-bit integer from `buf` at the specified `offset`. @@ -2105,7 +2105,7 @@ ___ ### readIntBE -▸ **readIntBE**(`offset`, `byteLength`): `number` +**readIntBE**(`offset`, `byteLength`): `number` Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as a big-endian, two's complement signed value supporting up to 48 bits of accuracy. @@ -2167,7 +2167,7 @@ ___ ### readIntLE -▸ **readIntLE**(`offset`, `byteLength`): `number` +**readIntLE**(`offset`, `byteLength`): `number` Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as a little-endian, two's complement signed value supporting up to 48 bits of accuracy. @@ -2225,7 +2225,7 @@ ___ ### readUInt16BE -▸ **readUInt16BE**(`offset?`): `number` +**readUInt16BE**(`offset?`): `number` Reads an unsigned, big-endian 16-bit integer from `buf` at the specified`offset`. @@ -2278,7 +2278,7 @@ ___ ### readUInt16LE -▸ **readUInt16LE**(`offset?`): `number` +**readUInt16LE**(`offset?`): `number` Reads an unsigned, little-endian 16-bit integer from `buf` at the specified`offset`. @@ -2333,7 +2333,7 @@ ___ ### readUInt32BE -▸ **readUInt32BE**(`offset?`): `number` +**readUInt32BE**(`offset?`): `number` Reads an unsigned, big-endian 32-bit integer from `buf` at the specified`offset`. @@ -2384,7 +2384,7 @@ ___ ### readUInt32LE -▸ **readUInt32LE**(`offset?`): `number` +**readUInt32LE**(`offset?`): `number` Reads an unsigned, little-endian 32-bit integer from `buf` at the specified`offset`. @@ -2437,7 +2437,7 @@ ___ ### readUInt8 -▸ **readUInt8**(`offset?`): `number` +**readUInt8**(`offset?`): `number` Reads an unsigned 8-bit integer from `buf` at the specified `offset`. @@ -2492,7 +2492,7 @@ ___ ### readUIntBE -▸ **readUIntBE**(`offset`, `byteLength`): `number` +**readUIntBE**(`offset`, `byteLength`): `number` Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as an unsigned big-endian integer supporting up to 48 bits of accuracy. @@ -2554,7 +2554,7 @@ ___ ### readUIntLE -▸ **readUIntLE**(`offset`, `byteLength`): `number` +**readUIntLE**(`offset`, `byteLength`): `number` Reads `byteLength` number of bytes from `buf` at the specified `offset`and interprets the result as an unsigned, little-endian integer supporting up to 48 bits of accuracy. @@ -2614,7 +2614,7 @@ ___ ### readUint16BE -▸ **readUint16BE**(`offset?`): `number` +**readUint16BE**(`offset?`): `number` #### Parameters @@ -2656,7 +2656,7 @@ ___ ### readUint16LE -▸ **readUint16LE**(`offset?`): `number` +**readUint16LE**(`offset?`): `number` #### Parameters @@ -2698,7 +2698,7 @@ ___ ### readUint32BE -▸ **readUint32BE**(`offset?`): `number` +**readUint32BE**(`offset?`): `number` #### Parameters @@ -2740,7 +2740,7 @@ ___ ### readUint32LE -▸ **readUint32LE**(`offset?`): `number` +**readUint32LE**(`offset?`): `number` #### Parameters @@ -2782,7 +2782,7 @@ ___ ### readUint8 -▸ **readUint8**(`offset?`): `number` +**readUint8**(`offset?`): `number` #### Parameters @@ -2824,7 +2824,7 @@ ___ ### readUintBE -▸ **readUintBE**(`offset`, `byteLength`): `number` +**readUintBE**(`offset`, `byteLength`): `number` #### Parameters @@ -2874,7 +2874,7 @@ ___ ### readUintLE -▸ **readUintLE**(`offset`, `byteLength`): `number` +**readUintLE**(`offset`, `byteLength`): `number` #### Parameters @@ -2924,7 +2924,7 @@ ___ ### reduce -▸ **reduce**(`callbackfn`): `number` +**reduce**(`callbackfn`): `number` Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next @@ -2962,7 +2962,7 @@ call to the callback function. Uint8Array.reduce -▸ **reduce**(`callbackfn`, `initialValue`): `number` +**reduce**(`callbackfn`, `initialValue`): `number` #### Parameters @@ -3004,7 +3004,7 @@ Uint8Array.reduce Uint8Array.reduce -▸ **reduce**<`U`\>(`callbackfn`, `initialValue`): `U` +**reduce**<`U`\>(`callbackfn`, `initialValue`): `U` Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next @@ -3056,7 +3056,7 @@ ___ ### reduceRight -▸ **reduceRight**(`callbackfn`): `number` +**reduceRight**(`callbackfn`): `number` Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an @@ -3094,7 +3094,7 @@ argument in the next call to the callback function. Uint8Array.reduceRight -▸ **reduceRight**(`callbackfn`, `initialValue`): `number` +**reduceRight**(`callbackfn`, `initialValue`): `number` #### Parameters @@ -3136,7 +3136,7 @@ Uint8Array.reduceRight Uint8Array.reduceRight -▸ **reduceRight**<`U`\>(`callbackfn`, `initialValue`): `U` +**reduceRight**<`U`\>(`callbackfn`, `initialValue`): `U` Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an @@ -3188,7 +3188,7 @@ ___ ### reverse -▸ **reverse**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**reverse**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) #### Returns @@ -3213,7 +3213,7 @@ ___ ### set -▸ **set**(`array`, `offset?`): `void` +**set**(`array`, `offset?`): `void` Sets a value or an array of values. @@ -3261,7 +3261,7 @@ ___ ### slice -▸ **slice**(`start?`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**slice**(`start?`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Returns a new `Buffer` that references the same memory as the original, but offset and cropped by the `start` and `end` indices. @@ -3343,7 +3343,7 @@ ___ ### some -▸ **some**(`predicate`, `thisArg?`): `boolean` +**some**(`predicate`, `thisArg?`): `boolean` Determines whether the specified callback function returns true for any element of an array. @@ -3391,7 +3391,7 @@ ___ ### sort -▸ **sort**(`compareFn?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**sort**(`compareFn?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Sorts an array. @@ -3431,7 +3431,7 @@ ___ ### subarray -▸ **subarray**(`start?`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**subarray**(`start?`, `end?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Returns a new `Buffer` that references the same memory as the original, but offset and cropped by the `start` and `end` indices. @@ -3536,7 +3536,7 @@ ___ ### swap16 -▸ **swap16**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**swap16**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Interprets `buf` as an array of unsigned 16-bit integers and swaps the byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 2. @@ -3593,7 +3593,7 @@ ___ ### swap32 -▸ **swap32**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**swap32**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Interprets `buf` as an array of unsigned 32-bit integers and swaps the byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 4. @@ -3640,7 +3640,7 @@ ___ ### swap64 -▸ **swap64**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**swap64**(): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Interprets `buf` as an array of 64-bit numbers and swaps byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 8. @@ -3687,7 +3687,7 @@ ___ ### toJSON -▸ **toJSON**(): { `data`: `number`[] ; `type`: ``"Buffer"`` } +**toJSON**(): { `data`: `number`[] ; `type`: ``"Buffer"`` } Returns a JSON representation of `buf`. [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify) implicitly calls this function when stringifying a `Buffer` instance. @@ -3756,7 +3756,7 @@ ___ ### toLocaleString -▸ **toLocaleString**(): `string` +**toLocaleString**(): `string` Converts a number to a string by using the current locale. @@ -3783,7 +3783,7 @@ ___ ### toString -▸ **toString**(`encoding?`, `start?`, `end?`): `string` +**toString**(`encoding?`, `start?`, `end?`): `string` Decodes `buf` to a string according to the specified character encoding in`encoding`. `start` and `end` may be passed to decode only a subset of `buf`. @@ -3874,7 +3874,7 @@ ___ ### valueOf -▸ **valueOf**(): `Uint8Array` +**valueOf**(): `Uint8Array` Returns the primitive value of the specified object. @@ -3901,7 +3901,7 @@ ___ ### values -▸ **values**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`number`\> +**values**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`number`\> Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) for `buf` values (bytes). This function is called automatically when a `Buffer` is used in a `for..of` statement. @@ -3970,7 +3970,7 @@ ___ ### write -▸ **write**(`string`, `encoding?`): `number` +**write**(`string`, `encoding?`): `number` Writes `string` to `buf` at `offset` according to the character encoding in`encoding`. The `length` parameter is the number of bytes to write. If `buf` did not contain enough space to fit the entire string, only part of `string` will be @@ -4034,7 +4034,7 @@ console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`); v0.1.90 -▸ **write**(`string`, `offset`, `encoding?`): `number` +**write**(`string`, `offset`, `encoding?`): `number` #### Parameters @@ -4080,7 +4080,7 @@ v0.1.90 } ]} /> -▸ **write**(`string`, `offset`, `length`, `encoding?`): `number` +**write**(`string`, `offset`, `length`, `encoding?`): `number` #### Parameters @@ -4138,7 +4138,7 @@ ___ ### writeBigInt64BE -▸ **writeBigInt64BE**(`value`, `offset?`): `number` +**writeBigInt64BE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as big-endian. @@ -4199,7 +4199,7 @@ ___ ### writeBigInt64LE -▸ **writeBigInt64LE**(`value`, `offset?`): `number` +**writeBigInt64LE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as little-endian. @@ -4260,7 +4260,7 @@ ___ ### writeBigUInt64BE -▸ **writeBigUInt64BE**(`value`, `offset?`): `number` +**writeBigUInt64BE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as big-endian. @@ -4321,7 +4321,7 @@ ___ ### writeBigUInt64LE -▸ **writeBigUInt64LE**(`value`, `offset?`): `number` +**writeBigUInt64LE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as little-endian @@ -4382,7 +4382,7 @@ ___ ### writeBigUint64BE -▸ **writeBigUint64BE**(`value`, `offset?`): `number` +**writeBigUint64BE**(`value`, `offset?`): `number` #### Parameters @@ -4432,7 +4432,7 @@ ___ ### writeBigUint64LE -▸ **writeBigUint64LE**(`value`, `offset?`): `number` +**writeBigUint64LE**(`value`, `offset?`): `number` #### Parameters @@ -4482,7 +4482,7 @@ ___ ### writeDoubleBE -▸ **writeDoubleBE**(`value`, `offset?`): `number` +**writeDoubleBE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a JavaScript number. Behavior is undefined when `value` is anything other than a JavaScript number. @@ -4542,7 +4542,7 @@ ___ ### writeDoubleLE -▸ **writeDoubleLE**(`value`, `offset?`): `number` +**writeDoubleLE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a JavaScript number. Behavior is undefined when `value` is anything other than a JavaScript number. @@ -4602,7 +4602,7 @@ ___ ### writeFloatBE -▸ **writeFloatBE**(`value`, `offset?`): `number` +**writeFloatBE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as big-endian. Behavior is undefined when `value` is anything other than a JavaScript number. @@ -4662,7 +4662,7 @@ ___ ### writeFloatLE -▸ **writeFloatLE**(`value`, `offset?`): `number` +**writeFloatLE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as little-endian. Behavior is undefined when `value` is anything other than a JavaScript number. @@ -4722,7 +4722,7 @@ ___ ### writeInt16BE -▸ **writeInt16BE**(`value`, `offset?`): `number` +**writeInt16BE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid signed 16-bit integer. Behavior is undefined when `value` is anything other than a signed 16-bit integer. @@ -4784,7 +4784,7 @@ ___ ### writeInt16LE -▸ **writeInt16LE**(`value`, `offset?`): `number` +**writeInt16LE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid signed 16-bit integer. Behavior is undefined when `value` is anything other than a signed 16-bit integer. @@ -4846,7 +4846,7 @@ ___ ### writeInt32BE -▸ **writeInt32BE**(`value`, `offset?`): `number` +**writeInt32BE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid signed 32-bit integer. Behavior is undefined when `value` is anything other than a signed 32-bit integer. @@ -4908,7 +4908,7 @@ ___ ### writeInt32LE -▸ **writeInt32LE**(`value`, `offset?`): `number` +**writeInt32LE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid signed 32-bit integer. Behavior is undefined when `value` is anything other than a signed 32-bit integer. @@ -4970,7 +4970,7 @@ ___ ### writeInt8 -▸ **writeInt8**(`value`, `offset?`): `number` +**writeInt8**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset`. `value` must be a valid signed 8-bit integer. Behavior is undefined when `value` is anything other than @@ -5034,7 +5034,7 @@ ___ ### writeIntBE -▸ **writeIntBE**(`value`, `offset`, `byteLength`): `number` +**writeIntBE**(`value`, `offset`, `byteLength`): `number` Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined when`value` is anything other than a signed integer. @@ -5102,7 +5102,7 @@ ___ ### writeIntLE -▸ **writeIntLE**(`value`, `offset`, `byteLength`): `number` +**writeIntLE**(`value`, `offset`, `byteLength`): `number` Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined when `value` is anything other than a signed integer. @@ -5170,7 +5170,7 @@ ___ ### writeUInt16BE -▸ **writeUInt16BE**(`value`, `offset?`): `number` +**writeUInt16BE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid unsigned 16-bit integer. Behavior is undefined when `value`is anything other than an unsigned 16-bit integer. @@ -5233,7 +5233,7 @@ ___ ### writeUInt16LE -▸ **writeUInt16LE**(`value`, `offset?`): `number` +**writeUInt16LE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid unsigned 16-bit integer. Behavior is undefined when `value` is anything other than an unsigned 16-bit integer. @@ -5296,7 +5296,7 @@ ___ ### writeUInt32BE -▸ **writeUInt32BE**(`value`, `offset?`): `number` +**writeUInt32BE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as big-endian. The `value`must be a valid unsigned 32-bit integer. Behavior is undefined when `value`is anything other than an unsigned 32-bit integer. @@ -5358,7 +5358,7 @@ ___ ### writeUInt32LE -▸ **writeUInt32LE**(`value`, `offset?`): `number` +**writeUInt32LE**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset` as little-endian. The `value`must be a valid unsigned 32-bit integer. Behavior is undefined when `value` is anything other than an unsigned 32-bit integer. @@ -5420,7 +5420,7 @@ ___ ### writeUInt8 -▸ **writeUInt8**(`value`, `offset?`): `number` +**writeUInt8**(`value`, `offset?`): `number` Writes `value` to `buf` at the specified `offset`. `value` must be a valid unsigned 8-bit integer. Behavior is undefined when `value` is anything @@ -5486,7 +5486,7 @@ ___ ### writeUIntBE -▸ **writeUIntBE**(`value`, `offset`, `byteLength`): `number` +**writeUIntBE**(`value`, `offset`, `byteLength`): `number` Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined when `value` is anything other than an unsigned integer. @@ -5556,7 +5556,7 @@ ___ ### writeUIntLE -▸ **writeUIntLE**(`value`, `offset`, `byteLength`): `number` +**writeUIntLE**(`value`, `offset`, `byteLength`): `number` Writes `byteLength` bytes of `value` to `buf` at the specified `offset`as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined when `value` is anything other than an unsigned integer. @@ -5626,7 +5626,7 @@ ___ ### writeUint16BE -▸ **writeUint16BE**(`value`, `offset?`): `number` +**writeUint16BE**(`value`, `offset?`): `number` #### Parameters @@ -5676,7 +5676,7 @@ ___ ### writeUint16LE -▸ **writeUint16LE**(`value`, `offset?`): `number` +**writeUint16LE**(`value`, `offset?`): `number` #### Parameters @@ -5726,7 +5726,7 @@ ___ ### writeUint32BE -▸ **writeUint32BE**(`value`, `offset?`): `number` +**writeUint32BE**(`value`, `offset?`): `number` #### Parameters @@ -5776,7 +5776,7 @@ ___ ### writeUint32LE -▸ **writeUint32LE**(`value`, `offset?`): `number` +**writeUint32LE**(`value`, `offset?`): `number` #### Parameters @@ -5826,7 +5826,7 @@ ___ ### writeUint8 -▸ **writeUint8**(`value`, `offset?`): `number` +**writeUint8**(`value`, `offset?`): `number` #### Parameters @@ -5876,7 +5876,7 @@ ___ ### writeUintBE -▸ **writeUintBE**(`value`, `offset`, `byteLength`): `number` +**writeUintBE**(`value`, `offset`, `byteLength`): `number` #### Parameters @@ -5934,7 +5934,7 @@ ___ ### writeUintLE -▸ **writeUintLE**(`value`, `offset`, `byteLength`): `number` +**writeUintLE**(`value`, `offset`, `byteLength`): `number` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BufferConstructor.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BufferConstructor.mdx index 561dbac80a..eb67adbc1e 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BufferConstructor.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.BufferConstructor.mdx @@ -29,7 +29,7 @@ Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'bas ### alloc -▸ **alloc**(`size`, `fill?`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**alloc**(`size`, `fill?`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the`Buffer` will be zero-filled. @@ -125,7 +125,7 @@ ___ ### allocUnsafe -▸ **allocUnsafe**(`size`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**allocUnsafe**(`size`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Allocates a new `Buffer` of `size` bytes. If `size` is larger than constants.MAX_LENGTH or smaller than 0, `ERR_OUT_OF_RANGE` is thrown. @@ -195,7 +195,7 @@ ___ ### allocUnsafeSlow -▸ **allocUnsafeSlow**(`size`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**allocUnsafeSlow**(`size`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Allocates a new `Buffer` of `size` bytes. If `size` is larger than constants.MAX_LENGTH or smaller than 0, `ERR_OUT_OF_RANGE` is thrown. A zero-length `Buffer` is created if `size` is 0. @@ -274,7 +274,7 @@ ___ ### byteLength -▸ **byteLength**(`string`, `encoding?`): `number` +**byteLength**(`string`, `encoding?`): `number` Returns the byte length of a string when encoded using `encoding`. This is not the same as [`String.prototype.length`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length), which does not account @@ -344,7 +344,7 @@ ___ ### compare -▸ **compare**(`buf1`, `buf2`): ``0`` \| ``1`` \| ``-1`` +**compare**(`buf1`, `buf2`): ``0`` \| ``1`` \| ``-1`` Compares `buf1` to `buf2`, typically for the purpose of sorting arrays of`Buffer` instances. This is equivalent to calling `buf1.compare(buf2)`. @@ -404,7 +404,7 @@ ___ ### concat -▸ **concat**(`list`, `totalLength?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**concat**(`list`, `totalLength?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Returns a new `Buffer` which is the result of concatenating all the `Buffer`instances in the `list` together. @@ -484,7 +484,7 @@ ___ ### copyBytesFrom -▸ **copyBytesFrom**(`view`, `offset?`, `length?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**copyBytesFrom**(`view`, `offset?`, `length?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Copies the underlying memory of `view` into a new `Buffer`. @@ -549,7 +549,7 @@ ___ ### from -▸ **from**(`arrayBuffer`, `byteOffset?`, `length?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**from**(`arrayBuffer`, `byteOffset?`, `length?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Allocates a new `Buffer` using an `array` of bytes in the range `0` – `255`. Array entries outside that range will be truncated to fit into it. @@ -618,7 +618,7 @@ appropriate for `Buffer.from()` variants. v5.10.0 -▸ **from**(`data`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**from**(`data`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Creates a new Buffer using the passed {data} @@ -650,7 +650,7 @@ Creates a new Buffer using the passed {data} } ]} /> -▸ **from**(`data`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**from**(`data`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) #### Parameters @@ -680,7 +680,7 @@ Creates a new Buffer using the passed {data} } ]} /> -▸ **from**(`str`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**from**(`str`, `encoding?`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Creates a new Buffer containing the given JavaScript string {str}. If provided, the {encoding} parameter identifies the character encoding. @@ -726,7 +726,7 @@ ___ ### isBuffer -▸ **isBuffer**(`obj`): obj is Buffer +**isBuffer**(`obj`): obj is Buffer Returns `true` if `obj` is a `Buffer`, `false` otherwise. @@ -776,7 +776,7 @@ ___ ### isEncoding -▸ **isEncoding**(`encoding`): encoding is BufferEncoding +**isEncoding**(`encoding`): encoding is BufferEncoding Returns `true` if `encoding` is the name of a supported character encoding, or `false` otherwise. @@ -833,7 +833,7 @@ ___ ### of -▸ **of**(`...items`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) +**of**(`...items`): [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer) Creates a new Buffer using the passed {data} diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CallSite.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CallSite.mdx index 31b7592762..25ab361b1e 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CallSite.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.CallSite.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### getColumnNumber -▸ **getColumnNumber**(): ``null`` \| `number` +**getColumnNumber**(): ``null`` \| `number` Current column number [if this function was defined in a script] @@ -35,7 +35,7 @@ ___ ### getEvalOrigin -▸ **getEvalOrigin**(): `undefined` \| `string` +**getEvalOrigin**(): `undefined` \| `string` A call site object representing the location where eval was called [if this function was created using a call to eval] @@ -59,7 +59,7 @@ ___ ### getFileName -▸ **getFileName**(): `undefined` \| `string` +**getFileName**(): `undefined` \| `string` Name of the script [if this function was defined in a script] @@ -82,7 +82,7 @@ ___ ### getFunction -▸ **getFunction**(): `undefined` \| `Function` +**getFunction**(): `undefined` \| `Function` Current function @@ -105,7 +105,7 @@ ___ ### getFunctionName -▸ **getFunctionName**(): ``null`` \| `string` +**getFunctionName**(): ``null`` \| `string` Name of the current function, typically its name property. If a name property is not available an attempt will be made to try @@ -130,7 +130,7 @@ ___ ### getLineNumber -▸ **getLineNumber**(): ``null`` \| `number` +**getLineNumber**(): ``null`` \| `number` Current line number [if this function was defined in a script] @@ -153,7 +153,7 @@ ___ ### getMethodName -▸ **getMethodName**(): ``null`` \| `string` +**getMethodName**(): ``null`` \| `string` Name of the property [of "this" or one of its prototypes] that holds the current function @@ -177,7 +177,7 @@ ___ ### getThis -▸ **getThis**(): `unknown` +**getThis**(): `unknown` Value of "this" @@ -200,7 +200,7 @@ ___ ### getTypeName -▸ **getTypeName**(): ``null`` \| `string` +**getTypeName**(): ``null`` \| `string` Type of "this" as a string. This is the name of the function stored in the constructor field of @@ -226,7 +226,7 @@ ___ ### isConstructor -▸ **isConstructor**(): `boolean` +**isConstructor**(): `boolean` Is this a constructor call? @@ -249,7 +249,7 @@ ___ ### isEval -▸ **isEval**(): `boolean` +**isEval**(): `boolean` Does this call take place in code defined by a call to eval? @@ -272,7 +272,7 @@ ___ ### isNative -▸ **isNative**(): `boolean` +**isNative**(): `boolean` Is this call in native V8 code? @@ -295,7 +295,7 @@ ___ ### isToplevel -▸ **isToplevel**(): `boolean` +**isToplevel**(): `boolean` Is this a toplevel invocation, that is, is "this" the global object? diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.DuplexOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.DuplexOptions.mdx index 89fb4fba3a..51fa880817 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.DuplexOptions.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.DuplexOptions.mdx @@ -129,7 +129,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### construct -▸ `Optional` **construct**(`this`, `callback`): `void` +`Optional` **construct**(`this`, `callback`): `void` #### Parameters @@ -175,7 +175,7 @@ ___ ### destroy -▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` +`Optional` **destroy**(`this`, `error`, `callback`): `void` #### Parameters @@ -229,7 +229,7 @@ ___ ### final -▸ `Optional` **final**(`this`, `callback`): `void` +`Optional` **final**(`this`, `callback`): `void` #### Parameters @@ -275,7 +275,7 @@ ___ ### read -▸ `Optional` **read**(`this`, `size`): `void` +`Optional` **read**(`this`, `size`): `void` #### Parameters @@ -321,7 +321,7 @@ ___ ### write -▸ `Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void` +`Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void` #### Parameters @@ -383,7 +383,7 @@ ___ ### writev -▸ `Optional` **writev**(`this`, `chunks`, `callback`): `void` +`Optional` **writev**(`this`, `chunks`, `callback`): `void` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.EventEmitter-2.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.EventEmitter-2.mdx index 769301e484..0cc93ce5b0 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.EventEmitter-2.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.EventEmitter-2.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addListener -▸ **addListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) +**addListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) Alias for `emitter.on(eventName, listener)`. @@ -60,7 +60,7 @@ ___ ### emit -▸ **emit**(`eventName`, `...args`): `boolean` +**emit**(`eventName`, `...args`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -144,7 +144,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -195,7 +195,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. @@ -223,7 +223,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -273,7 +273,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -321,7 +321,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) +**off**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) Alias for `emitter.removeListener()`. @@ -369,7 +369,7 @@ ___ ### on -▸ **on**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) +**on**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -442,7 +442,7 @@ ___ ### once -▸ **once**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) +**once**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -513,7 +513,7 @@ ___ ### prependListener -▸ **prependListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) +**prependListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) Adds the `listener` function to the _beginning_ of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -572,7 +572,7 @@ ___ ### prependOnceListener -▸ **prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) +**prependOnceListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this listener is removed, and then invoked. @@ -629,7 +629,7 @@ ___ ### rawListeners -▸ **rawListeners**(`eventName`): `Function`[] +**rawListeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`, including any wrappers (such as those created by `.once()`). @@ -695,7 +695,7 @@ ___ ### removeAllListeners -▸ **removeAllListeners**(`event?`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) +**removeAllListeners**(`event?`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) Removes all listeners, or those of the specified `eventName`. @@ -741,7 +741,7 @@ ___ ### removeListener -▸ **removeListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) +**removeListener**(`eventName`, `listener`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) Removes the specified `listener` from the listener array for the event named`eventName`. @@ -867,7 +867,7 @@ ___ ### setMaxListeners -▸ **setMaxListeners**(`n`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) +**setMaxListeners**(`n`): [`EventEmitter`](admin_discounts.internal.EventEmitter-2.mdx) By default `EventEmitter`s will print a warning if more than `10` listeners are added for a particular event. This is a useful default that helps finding diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ICacheService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ICacheService.mdx index 4e4a51dc64..02f3744001 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ICacheService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ICacheService.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### get -▸ **get**<`T`\>(`key`): `Promise`<``null`` \| `T`\> +**get**<`T`\>(`key`): `Promise`<``null`` \| `T`\> +**invalidate**(`key`): `Promise`<`void`\> #### Parameters @@ -100,7 +100,7 @@ ___ ### set -▸ **set**(`key`, `data`, `ttl?`): `Promise`<`void`\> +**set**(`key`, `data`, `ttl?`): `Promise`<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IEventBusModuleService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IEventBusModuleService.mdx index 486f53e72b..3af40fd231 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IEventBusModuleService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IEventBusModuleService.mdx @@ -16,7 +16,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### emit -▸ **emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void`\> +**emit**<`T`\>(`eventName`, `data`, `options?`): `Promise`<`void`\> -▸ **emit**<`T`\>(`data`): `Promise`<`void`\> +**emit**<`T`\>(`data`): `Promise`<`void`\> (`event`, `data`, `options?`): `Promise`<`unknown`\> +**emit**<`T`\>(`event`, `data`, `options?`): `Promise`<`unknown`\> +**adjustInventory**(`inventoryItemId`, `locationId`, `adjustment`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> #### Parameters @@ -100,7 +100,7 @@ ___ ### confirmInventory -▸ **confirmInventory**(`inventoryItemId`, `locationIds`, `quantity`, `context?`): `Promise`<`boolean`\> +**confirmInventory**(`inventoryItemId`, `locationIds`, `quantity`, `context?`): `Promise`<`boolean`\> #### Parameters @@ -167,7 +167,7 @@ ___ ### createInventoryItem -▸ **createInventoryItem**(`input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> +**createInventoryItem**(`input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> #### Parameters @@ -218,7 +218,7 @@ ___ ### createInventoryItems -▸ **createInventoryItems**(`input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[]\> +**createInventoryItems**(`input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[]\> #### Parameters @@ -278,7 +278,7 @@ ___ ### createInventoryLevel -▸ **createInventoryLevel**(`data`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> +**createInventoryLevel**(`data`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> #### Parameters @@ -329,7 +329,7 @@ ___ ### createInventoryLevels -▸ **createInventoryLevels**(`data`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]\> +**createInventoryLevels**(`data`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]\> #### Parameters @@ -389,7 +389,7 @@ ___ ### createReservationItem -▸ **createReservationItem**(`input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\> +**createReservationItem**(`input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\> #### Parameters @@ -440,7 +440,7 @@ ___ ### createReservationItems -▸ **createReservationItems**(`input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[]\> +**createReservationItems**(`input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[]\> #### Parameters @@ -500,7 +500,7 @@ ___ ### deleteInventoryItem -▸ **deleteInventoryItem**(`inventoryItemId`, `context?`): `Promise`<`void`\> +**deleteInventoryItem**(`inventoryItemId`, `context?`): `Promise`<`void`\> #### Parameters @@ -542,7 +542,7 @@ ___ ### deleteInventoryItemLevelByLocationId -▸ **deleteInventoryItemLevelByLocationId**(`locationId`, `context?`): `Promise`<`void`\> +**deleteInventoryItemLevelByLocationId**(`locationId`, `context?`): `Promise`<`void`\> #### Parameters @@ -584,7 +584,7 @@ ___ ### deleteInventoryLevel -▸ **deleteInventoryLevel**(`inventoryLevelId`, `locationId`, `context?`): `Promise`<`void`\> +**deleteInventoryLevel**(`inventoryLevelId`, `locationId`, `context?`): `Promise`<`void`\> #### Parameters @@ -634,7 +634,7 @@ ___ ### deleteReservationItem -▸ **deleteReservationItem**(`reservationItemId`, `context?`): `Promise`<`void`\> +**deleteReservationItem**(`reservationItemId`, `context?`): `Promise`<`void`\> #### Parameters @@ -676,7 +676,7 @@ ___ ### deleteReservationItemByLocationId -▸ **deleteReservationItemByLocationId**(`locationId`, `context?`): `Promise`<`void`\> +**deleteReservationItemByLocationId**(`locationId`, `context?`): `Promise`<`void`\> #### Parameters @@ -718,7 +718,7 @@ ___ ### deleteReservationItemsByLineItem -▸ **deleteReservationItemsByLineItem**(`lineItemId`, `context?`): `Promise`<`void`\> +**deleteReservationItemsByLineItem**(`lineItemId`, `context?`): `Promise`<`void`\> #### Parameters @@ -760,7 +760,7 @@ ___ ### listInventoryItems -▸ **listInventoryItems**(`selector`, `config?`, `context?`): `Promise`<[[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[], `number`]\> +**listInventoryItems**(`selector`, `config?`, `context?`): `Promise`<[[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[], `number`]\> #### Parameters @@ -827,7 +827,7 @@ ___ ### listInventoryLevels -▸ **listInventoryLevels**(`selector`, `config?`, `context?`): `Promise`<[[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[], `number`]\> +**listInventoryLevels**(`selector`, `config?`, `context?`): `Promise`<[[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[], `number`]\> #### Parameters @@ -894,7 +894,7 @@ ___ ### listReservationItems -▸ **listReservationItems**(`selector`, `config?`, `context?`): `Promise`<[[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[], `number`]\> +**listReservationItems**(`selector`, `config?`, `context?`): `Promise`<[[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[], `number`]\> #### Parameters @@ -961,7 +961,7 @@ ___ ### restoreInventoryItem -▸ **restoreInventoryItem**(`inventoryItemId`, `context?`): `Promise`<`void`\> +**restoreInventoryItem**(`inventoryItemId`, `context?`): `Promise`<`void`\> #### Parameters @@ -1003,7 +1003,7 @@ ___ ### retrieveAvailableQuantity -▸ **retrieveAvailableQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\> +**retrieveAvailableQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\> #### Parameters @@ -1062,7 +1062,7 @@ ___ ### retrieveInventoryItem -▸ **retrieveInventoryItem**(`inventoryItemId`, `config?`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> +**retrieveInventoryItem**(`inventoryItemId`, `config?`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> #### Parameters @@ -1121,7 +1121,7 @@ ___ ### retrieveInventoryLevel -▸ **retrieveInventoryLevel**(`inventoryItemId`, `locationId`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> +**retrieveInventoryLevel**(`inventoryItemId`, `locationId`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> #### Parameters @@ -1180,7 +1180,7 @@ ___ ### retrieveReservationItem -▸ **retrieveReservationItem**(`reservationId`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\> +**retrieveReservationItem**(`reservationId`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\> #### Parameters @@ -1231,7 +1231,7 @@ ___ ### retrieveReservedQuantity -▸ **retrieveReservedQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\> +**retrieveReservedQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\> #### Parameters @@ -1290,7 +1290,7 @@ ___ ### retrieveStockedQuantity -▸ **retrieveStockedQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\> +**retrieveStockedQuantity**(`inventoryItemId`, `locationIds`, `context?`): `Promise`<`number`\> #### Parameters @@ -1349,7 +1349,7 @@ ___ ### updateInventoryItem -▸ **updateInventoryItem**(`inventoryItemId`, `input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> +**updateInventoryItem**(`inventoryItemId`, `input`, `context?`): `Promise`<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> #### Parameters @@ -1408,7 +1408,7 @@ ___ ### updateInventoryLevel -▸ **updateInventoryLevel**(`inventoryItemId`, `locationId`, `update`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> +**updateInventoryLevel**(`inventoryItemId`, `locationId`, `update`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)\> #### Parameters @@ -1475,7 +1475,7 @@ ___ ### updateInventoryLevels -▸ **updateInventoryLevels**(`updates`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]\> +**updateInventoryLevels**(`updates`, `context?`): `Promise`<[`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[]\> #### Parameters @@ -1535,7 +1535,7 @@ ___ ### updateReservationItem -▸ **updateReservationItem**(`reservationItemId`, `input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\> +**updateReservationItem**(`reservationItemId`, `input`, `context?`): `Promise`<[`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ISearchService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ISearchService.mdx index 368729c37a..c84cd2f91b 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ISearchService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ISearchService.mdx @@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addDocuments -▸ **addDocuments**(`indexName`, `documents`, `type`): `unknown` +**addDocuments**(`indexName`, `documents`, `type`): `unknown` Used to index documents by the search engine provider @@ -81,7 +81,7 @@ ___ ### createIndex -▸ **createIndex**(`indexName`, `options`): `unknown` +**createIndex**(`indexName`, `options`): `unknown` Used to create an index @@ -125,7 +125,7 @@ ___ ### deleteAllDocuments -▸ **deleteAllDocuments**(`indexName`): `unknown` +**deleteAllDocuments**(`indexName`): `unknown` Used to delete all documents @@ -161,7 +161,7 @@ ___ ### deleteDocument -▸ **deleteDocument**(`indexName`, `document_id`): `unknown` +**deleteDocument**(`indexName`, `document_id`): `unknown` Used to delete document @@ -205,7 +205,7 @@ ___ ### getIndex -▸ **getIndex**(`indexName`): `unknown` +**getIndex**(`indexName`): `unknown` Used to get an index @@ -241,7 +241,7 @@ ___ ### replaceDocuments -▸ **replaceDocuments**(`indexName`, `documents`, `type`): `unknown` +**replaceDocuments**(`indexName`, `documents`, `type`): `unknown` Used to replace documents @@ -293,7 +293,7 @@ ___ ### search -▸ **search**(`indexName`, `query`, `options`): `unknown` +**search**(`indexName`, `query`, `options`): `unknown` Used to search for a document in an index @@ -345,7 +345,7 @@ ___ ### updateSettings -▸ **updateSettings**(`indexName`, `settings`): `unknown` +**updateSettings**(`indexName`, `settings`): `unknown` Used to update the settings of an index diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IStockLocationService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IStockLocationService.mdx index 341e0bfa68..aca1b77972 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IStockLocationService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IStockLocationService.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### \_\_joinerConfig -▸ **__joinerConfig**(): [`ModuleJoinerConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerconfig) +**__joinerConfig**(): [`ModuleJoinerConfig`](../../admin_discounts/modules/admin_discounts.internal.mdx#modulejoinerconfig) #### Returns @@ -33,7 +33,7 @@ ___ ### create -▸ **create**(`input`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\> +**create**(`input`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\> #### Parameters @@ -84,7 +84,7 @@ ___ ### delete -▸ **delete**(`id`, `context?`): `Promise`<`void`\> +**delete**(`id`, `context?`): `Promise`<`void`\> #### Parameters @@ -126,7 +126,7 @@ ___ ### list -▸ **list**(`selector`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[]\> +**list**(`selector`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[]\> #### Parameters @@ -194,7 +194,7 @@ ___ ### listAndCount -▸ **listAndCount**(`selector`, `config?`, `context?`): `Promise`<[[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[], `number`]\> +**listAndCount**(`selector`, `config?`, `context?`): `Promise`<[[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[], `number`]\> #### Parameters @@ -261,7 +261,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\> +**retrieve**(`id`, `config?`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\> #### Parameters @@ -320,7 +320,7 @@ ___ ### update -▸ **update**(`id`, `input`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\> +**update**(`id`, `input`, `context?`): `Promise`<[`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ITransactionBaseService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ITransactionBaseService.mdx index d951cb091c..68b3b62247 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ITransactionBaseService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ITransactionBaseService.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`ITransactionBaseService`](admin_discounts.internal.ITransactionBaseService.mdx) +**withTransaction**(`transactionManager?`): [`ITransactionBaseService`](admin_discounts.internal.ITransactionBaseService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterable.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterable.mdx index 71200593b1..c78efe325a 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterable.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterable.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### [iterator] -▸ **[iterator]**(): [`Iterator`](admin_discounts.internal.Iterator.mdx)<`T`, `any`, `undefined`\> +**[iterator]**(): [`Iterator`](admin_discounts.internal.Iterator.mdx)<`T`, `any`, `undefined`\> #### Returns diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IterableIterator.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IterableIterator.mdx index ed001b4dbf..937f4683aa 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IterableIterator.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.IterableIterator.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### [iterator] -▸ **[iterator]**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`T`\> +**[iterator]**(): [`IterableIterator`](admin_discounts.internal.IterableIterator.mdx)<`T`\> #### Returns @@ -46,7 +46,7 @@ ___ ### next -▸ **next**(`...args`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\> +**next**(`...args`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\> #### Parameters @@ -93,7 +93,7 @@ ___ ### return -▸ `Optional` **return**(`value?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\> +`Optional` **return**(`value?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\> #### Parameters @@ -140,7 +140,7 @@ ___ ### throw -▸ `Optional` **throw**(`e?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\> +`Optional` **throw**(`e?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `any`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterator.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterator.mdx index 407a5b33d8..3e57ee6bb4 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterator.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Iterator.mdx @@ -41,7 +41,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### next -▸ **next**(`...args`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\> +**next**(`...args`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\> #### Parameters @@ -75,7 +75,7 @@ ___ ### return -▸ `Optional` **return**(`value?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\> +`Optional` **return**(`value?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\> #### Parameters @@ -109,7 +109,7 @@ ___ ### throw -▸ `Optional` **throw**(`e?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\> +`Optional` **throw**(`e?`): [`IteratorResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#iteratorresult)<`T`, `TReturn`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Object.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Object.mdx index ea9a88b06d..c263fe99ea 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Object.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.Object.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### hasOwnProperty -▸ **hasOwnProperty**(`v`): `boolean` +**hasOwnProperty**(`v`): `boolean` Determines whether an object has a property with the specified name. @@ -61,7 +61,7 @@ ___ ### isPrototypeOf -▸ **isPrototypeOf**(`v`): `boolean` +**isPrototypeOf**(`v`): `boolean` Determines whether an object exists in another object's prototype chain. @@ -97,7 +97,7 @@ ___ ### propertyIsEnumerable -▸ **propertyIsEnumerable**(`v`): `boolean` +**propertyIsEnumerable**(`v`): `boolean` Determines whether a specified property is enumerable. @@ -133,7 +133,7 @@ ___ ### toLocaleString -▸ **toLocaleString**(): `string` +**toLocaleString**(): `string` Returns a date converted to a string using the current locale. @@ -156,7 +156,7 @@ ___ ### toString -▸ **toString**(): `string` +**toString**(): `string` Returns a string representation of an object. @@ -179,7 +179,7 @@ ___ ### valueOf -▸ **valueOf**(): [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object) +**valueOf**(): [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object) Returns the primitive value of the specified object. diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.OnReadOpts.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.OnReadOpts.mdx index 7941e05588..b585613cb1 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.OnReadOpts.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.OnReadOpts.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### callback -▸ **callback**(`bytesWritten`, `buf`): `boolean` +**callback**(`bytesWritten`, `buf`): `boolean` This function is called for every chunk of incoming data. Two arguments are passed to it: the number of bytes written to buffer and a reference to buffer. diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.PromiseLike.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.PromiseLike.mdx index 10f208ffd4..23450bbf8e 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.PromiseLike.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.PromiseLike.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### then -▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`TResult1` \| `TResult2`\> +**then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`TResult1` \| `TResult2`\> Attaches callbacks for the resolution and/or rejection of the Promise. diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.QueuingStrategySize.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.QueuingStrategySize.mdx index d1a735f798..2f60d5c3ff 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.QueuingStrategySize.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.QueuingStrategySize.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### QueuingStrategySize -▸ **QueuingStrategySize**(`chunk?`): `number` +**QueuingStrategySize**(`chunk?`): `number` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadWriteStream.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadWriteStream.mdx index 940ea01d57..3721981ef2 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadWriteStream.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadWriteStream.mdx @@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### [asyncIterator] -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\> +**[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\> #### Returns @@ -67,7 +67,7 @@ ___ ### addListener -▸ **addListener**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) +**addListener**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) Alias for `emitter.on(eventName, listener)`. @@ -119,7 +119,7 @@ ___ ### emit -▸ **emit**(`eventName`, `...args`): `boolean` +**emit**(`eventName`, `...args`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -207,7 +207,7 @@ ___ ### end -▸ **end**(`cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) +**end**(`cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) #### Parameters @@ -241,7 +241,7 @@ ___ [WritableStream](admin_discounts.internal.WritableStream.mdx).[end](admin_discounts.internal.WritableStream.mdx#end) -▸ **end**(`data`, `cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) +**end**(`data`, `cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) #### Parameters @@ -283,7 +283,7 @@ ___ [WritableStream](admin_discounts.internal.WritableStream.mdx).[end](admin_discounts.internal.WritableStream.mdx#end) -▸ **end**(`str`, `encoding?`, `cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) +**end**(`str`, `encoding?`, `cb?`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) #### Parameters @@ -337,7 +337,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -392,7 +392,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. @@ -424,7 +424,7 @@ ___ ### isPaused -▸ **isPaused**(): `boolean` +**isPaused**(): `boolean` #### Returns @@ -449,7 +449,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -503,7 +503,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -555,7 +555,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) +**off**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) Alias for `emitter.removeListener()`. @@ -607,7 +607,7 @@ ___ ### on -▸ **on**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) +**on**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -684,7 +684,7 @@ ___ ### once -▸ **once**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) +**once**(`eventName`, `listener`): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -759,7 +759,7 @@ ___ ### pause -▸ **pause**(): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) +**pause**(): [`ReadWriteStream`](admin_discounts.internal.ReadWriteStream.mdx) #### Returns @@ -784,7 +784,7 @@ ___ ### pipe -▸ **pipe**<`T`\>(`destination`, `options?`): `T` +**pipe**<`T`\>(`destination`, `options?`): `T` +**ReadableByteStreamControllerCallback**(`controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream-1.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream-1.mdx index 792413b3a6..8f26823e9f 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream-1.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream-1.mdx @@ -40,7 +40,7 @@ This Streams API interface represents a readable stream of byte data. ### [asyncIterator] -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`R`\> +**[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`R`\> #### Returns @@ -61,7 +61,7 @@ ___ ### cancel -▸ **cancel**(`reason?`): `Promise`<`void`\> +**cancel**(`reason?`): `Promise`<`void`\> #### Parameters @@ -95,7 +95,7 @@ ___ ### getReader -▸ **getReader**(): [`ReadableStreamDefaultReader`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestreamdefaultreader)<`R`\> +**getReader**(): [`ReadableStreamDefaultReader`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestreamdefaultreader)<`R`\> #### Returns @@ -116,7 +116,7 @@ ___ ### pipeThrough -▸ **pipeThrough**<`T`\>(`transform`, `options?`): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`T`\> +**pipeThrough**<`T`\>(`transform`, `options?`): [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`T`\> +**pipeTo**(`destination`, `options?`): `Promise`<`void`\> #### Parameters @@ -211,7 +211,7 @@ ___ ### tee -▸ **tee**(): [[`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\>, [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\>] +**tee**(): [[`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\>, [`ReadableStream`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestream)<`R`\>] #### Returns @@ -249,7 +249,7 @@ ___ ### values -▸ **values**(`options?`): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`R`\> +**values**(`options?`): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`R`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream.mdx index a614469875..3851df14f6 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStream.mdx @@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### [asyncIterator] -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\> +**[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`string` \| [`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\> #### Returns @@ -59,7 +59,7 @@ ___ ### addListener -▸ **addListener**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) +**addListener**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) Alias for `emitter.on(eventName, listener)`. @@ -111,7 +111,7 @@ ___ ### emit -▸ **emit**(`eventName`, `...args`): `boolean` +**emit**(`eventName`, `...args`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -199,7 +199,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -254,7 +254,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. @@ -286,7 +286,7 @@ ___ ### isPaused -▸ **isPaused**(): `boolean` +**isPaused**(): `boolean` #### Returns @@ -307,7 +307,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -361,7 +361,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -413,7 +413,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) +**off**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) Alias for `emitter.removeListener()`. @@ -465,7 +465,7 @@ ___ ### on -▸ **on**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) +**on**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -542,7 +542,7 @@ ___ ### once -▸ **once**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) +**once**(`eventName`, `listener`): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -617,7 +617,7 @@ ___ ### pause -▸ **pause**(): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) +**pause**(): [`ReadableStream`](admin_discounts.internal.ReadableStream.mdx) #### Returns @@ -638,7 +638,7 @@ ___ ### pipe -▸ **pipe**<`T`\>(`destination`, `options?`): `T` +**pipe**<`T`\>(`destination`, `options?`): `T` +**cancel**(`reason?`): `Promise`<`void`\> #### Parameters @@ -76,7 +76,7 @@ ___ ### read -▸ **read**(): `Promise`<[`ReadableStreamDefaultReadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestreamdefaultreadresult)<`R`\>\> +**read**(): `Promise`<[`ReadableStreamDefaultReadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#readablestreamdefaultreadresult)<`R`\>\> #### Returns @@ -106,7 +106,7 @@ ___ ### releaseLock -▸ **releaseLock**(): `void` +**releaseLock**(): `void` #### Returns diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamErrorCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamErrorCallback.mdx index 615f0f892b..0564866530 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamErrorCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamErrorCallback.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### ReadableStreamErrorCallback -▸ **ReadableStreamErrorCallback**(`reason`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> +**ReadableStreamErrorCallback**(`reason`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamGenericReader.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamGenericReader.mdx index 797b2ff8af..8736d92fb9 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamGenericReader.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.ReadableStreamGenericReader.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### cancel -▸ **cancel**(`reason?`): `Promise`<`void`\> +**cancel**(`reason?`): `Promise`<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SharedArrayBuffer.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SharedArrayBuffer.mdx index d17344b67a..644a5e1d45 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SharedArrayBuffer.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.SharedArrayBuffer.mdx @@ -41,7 +41,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### slice -▸ **slice**(`begin`, `end?`): [`SharedArrayBuffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedarraybuffer) +**slice**(`begin`, `end?`): [`SharedArrayBuffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#sharedarraybuffer) Returns a section of an SharedArrayBuffer. diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.TransformOptions.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.TransformOptions.mdx index 2eea5fa138..638ff59158 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.TransformOptions.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.TransformOptions.mdx @@ -129,7 +129,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### construct -▸ `Optional` **construct**(`this`, `callback`): `void` +`Optional` **construct**(`this`, `callback`): `void` #### Parameters @@ -175,7 +175,7 @@ ___ ### destroy -▸ `Optional` **destroy**(`this`, `error`, `callback`): `void` +`Optional` **destroy**(`this`, `error`, `callback`): `void` #### Parameters @@ -229,7 +229,7 @@ ___ ### final -▸ `Optional` **final**(`this`, `callback`): `void` +`Optional` **final**(`this`, `callback`): `void` #### Parameters @@ -275,7 +275,7 @@ ___ ### flush -▸ `Optional` **flush**(`this`, `callback`): `void` +`Optional` **flush**(`this`, `callback`): `void` #### Parameters @@ -317,7 +317,7 @@ ___ ### read -▸ `Optional` **read**(`this`, `size`): `void` +`Optional` **read**(`this`, `size`): `void` #### Parameters @@ -363,7 +363,7 @@ ___ ### transform -▸ `Optional` **transform**(`this`, `chunk`, `encoding`, `callback`): `void` +`Optional` **transform**(`this`, `chunk`, `encoding`, `callback`): `void` #### Parameters @@ -421,7 +421,7 @@ ___ ### write -▸ `Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void` +`Optional` **write**(`this`, `chunk`, `encoding`, `callback`): `void` #### Parameters @@ -483,7 +483,7 @@ ___ ### writev -▸ `Optional` **writev**(`this`, `chunks`, `callback`): `void` +`Optional` **writev**(`this`, `chunks`, `callback`): `void` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkAbortCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkAbortCallback.mdx index 06d899d5d2..79ae199ee9 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkAbortCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkAbortCallback.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### UnderlyingSinkAbortCallback -▸ **UnderlyingSinkAbortCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> +**UnderlyingSinkAbortCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkCloseCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkCloseCallback.mdx index e4f8909dfe..9e41e7684d 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkCloseCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkCloseCallback.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### UnderlyingSinkCloseCallback -▸ **UnderlyingSinkCloseCallback**(): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> +**UnderlyingSinkCloseCallback**(): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> #### Returns diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkStartCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkStartCallback.mdx index 026fbaebc3..f58ee9c596 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkStartCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkStartCallback.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### UnderlyingSinkStartCallback -▸ **UnderlyingSinkStartCallback**(`controller`): `any` +**UnderlyingSinkStartCallback**(`controller`): `any` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkWriteCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkWriteCallback.mdx index 06e723f6cb..ca76175209 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkWriteCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSinkWriteCallback.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### UnderlyingSinkWriteCallback -▸ **UnderlyingSinkWriteCallback**(`chunk`, `controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> +**UnderlyingSinkWriteCallback**(`chunk`, `controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceCancelCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceCancelCallback.mdx index 110c97a916..8dd0ba5702 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceCancelCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceCancelCallback.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### UnderlyingSourceCancelCallback -▸ **UnderlyingSourceCancelCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> +**UnderlyingSourceCancelCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourcePullCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourcePullCallback.mdx index b0e90f90c3..7120e33c1f 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourcePullCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourcePullCallback.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### UnderlyingSourcePullCallback -▸ **UnderlyingSourcePullCallback**(`controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> +**UnderlyingSourcePullCallback**(`controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceStartCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceStartCallback.mdx index 6d98ccf55f..7d558739aa 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceStartCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.UnderlyingSourceStartCallback.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### UnderlyingSourceStartCallback -▸ **UnderlyingSourceStartCallback**(`controller`): `any` +**UnderlyingSourceStartCallback**(`controller`): `any` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream-1.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream-1.mdx index d7d8eca2c3..449cdc8c61 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream-1.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream-1.mdx @@ -42,7 +42,7 @@ built-in back pressure and queuing. ### abort -▸ **abort**(`reason?`): `Promise`<`void`\> +**abort**(`reason?`): `Promise`<`void`\> #### Parameters @@ -76,7 +76,7 @@ ___ ### close -▸ **close**(): `Promise`<`void`\> +**close**(): `Promise`<`void`\> #### Returns @@ -97,7 +97,7 @@ ___ ### getWriter -▸ **getWriter**(): [`WritableStreamDefaultWriter`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestreamdefaultwriter)<`W`\> +**getWriter**(): [`WritableStreamDefaultWriter`](../../admin_discounts/modules/admin_discounts.internal.mdx#writablestreamdefaultwriter)<`W`\> #### Returns diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream.mdx index 23d1bf6cba..52b74df072 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStream.mdx @@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addListener -▸ **addListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) +**addListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) Alias for `emitter.on(eventName, listener)`. @@ -81,7 +81,7 @@ ___ ### emit -▸ **emit**(`eventName`, `...args`): `boolean` +**emit**(`eventName`, `...args`): `boolean` Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments to each. @@ -169,7 +169,7 @@ ___ ### end -▸ **end**(`cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) +**end**(`cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) #### Parameters @@ -199,7 +199,7 @@ ___ } ]} /> -▸ **end**(`data`, `cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) +**end**(`data`, `cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) #### Parameters @@ -237,7 +237,7 @@ ___ } ]} /> -▸ **end**(`str`, `encoding?`, `cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) +**end**(`str`, `encoding?`, `cb?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) #### Parameters @@ -287,7 +287,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -342,7 +342,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. @@ -374,7 +374,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -428,7 +428,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -480,7 +480,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) +**off**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) Alias for `emitter.removeListener()`. @@ -532,7 +532,7 @@ ___ ### on -▸ **on**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) +**on**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -609,7 +609,7 @@ ___ ### once -▸ **once**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) +**once**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) Adds a **one-time**`listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -684,7 +684,7 @@ ___ ### prependListener -▸ **prependListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) +**prependListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) Adds the `listener` function to the _beginning_ of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -747,7 +747,7 @@ ___ ### prependOnceListener -▸ **prependOnceListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) +**prependOnceListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) Adds a **one-time**`listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this listener is removed, and then invoked. @@ -808,7 +808,7 @@ ___ ### rawListeners -▸ **rawListeners**(`eventName`): `Function`[] +**rawListeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`, including any wrappers (such as those created by `.once()`). @@ -878,7 +878,7 @@ ___ ### removeAllListeners -▸ **removeAllListeners**(`event?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) +**removeAllListeners**(`event?`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) Removes all listeners, or those of the specified `eventName`. @@ -928,7 +928,7 @@ ___ ### removeListener -▸ **removeListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) +**removeListener**(`eventName`, `listener`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) Removes the specified `listener` from the listener array for the event named`eventName`. @@ -1058,7 +1058,7 @@ ___ ### setMaxListeners -▸ **setMaxListeners**(`n`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) +**setMaxListeners**(`n`): [`WritableStream`](admin_discounts.internal.WritableStream.mdx) By default `EventEmitter`s will print a warning if more than `10` listeners are added for a particular event. This is a useful default that helps finding @@ -1107,7 +1107,7 @@ ___ ### write -▸ **write**(`buffer`, `cb?`): `boolean` +**write**(`buffer`, `cb?`): `boolean` #### Parameters @@ -1145,7 +1145,7 @@ ___ } ]} /> -▸ **write**(`str`, `encoding?`, `cb?`): `boolean` +**write**(`str`, `encoding?`, `cb?`): `boolean` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultController.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultController.mdx index f180b89f6b..da51acf33a 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultController.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultController.mdx @@ -17,7 +17,7 @@ instance to manipulate. ### error -▸ **error**(`e?`): `void` +**error**(`e?`): `void` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultWriter.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultWriter.mdx index ffa5be314a..9407059d74 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultWriter.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.WritableStreamDefaultWriter.mdx @@ -59,7 +59,7 @@ sink. ### abort -▸ **abort**(`reason?`): `Promise`<`void`\> +**abort**(`reason?`): `Promise`<`void`\> #### Parameters @@ -93,7 +93,7 @@ ___ ### close -▸ **close**(): `Promise`<`void`\> +**close**(): `Promise`<`void`\> #### Returns @@ -114,7 +114,7 @@ ___ ### releaseLock -▸ **releaseLock**(): `void` +**releaseLock**(): `void` #### Returns @@ -135,7 +135,7 @@ ___ ### write -▸ **write**(`chunk?`): `Promise`<`void`\> +**write**(`chunk?`): `Promise`<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._DOMEventTarget.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._DOMEventTarget.mdx index be25129ca8..aa6ca75743 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._DOMEventTarget.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._DOMEventTarget.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### addEventListener -▸ **addEventListener**(`eventName`, `listener`, `opts?`): `any` +**addEventListener**(`eventName`, `listener`, `opts?`): `any` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._NodeEventTarget.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._NodeEventTarget.mdx index 3c9e53226a..11e72c35a8 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._NodeEventTarget.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal._NodeEventTarget.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### once -▸ **once**(`eventName`, `listener`): [`_NodeEventTarget`](admin_discounts.internal._NodeEventTarget.mdx) +**once**(`eventName`, `listener`): [`_NodeEventTarget`](admin_discounts.internal._NodeEventTarget.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.FulfillmentService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.FulfillmentService.mdx index 526e50b710..c966439fcb 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.FulfillmentService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.FulfillmentService.mdx @@ -19,7 +19,7 @@ Fullfillment provider plugin services should extend the AbstractFulfillmentServi ### calculatePrice -▸ **calculatePrice**(`optionData`, `data`, `cart`): `Promise`<`number`\> +**calculatePrice**(`optionData`, `data`, `cart`): `Promise`<`number`\> Used to calculate a price for a given shipping option. @@ -80,7 +80,7 @@ ___ ### canCalculate -▸ **canCalculate**(`data`): `Promise`<`boolean`\> +**canCalculate**(`data`): `Promise`<`boolean`\> Used to determine if a shipping option can have a calculated price @@ -125,7 +125,7 @@ ___ ### cancelFulfillment -▸ **cancelFulfillment**(`fulfillmentData`): `Promise`<`any`\> +**cancelFulfillment**(`fulfillmentData`): `Promise`<`any`\> Cancel a fulfillment using data from the fulfillment @@ -170,7 +170,7 @@ ___ ### createFulfillment -▸ **createFulfillment**(`data`, `items`, `order`, `fulfillment`): `Promise`<[`FulfillmentProviderData`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentproviderdata)\> +**createFulfillment**(`data`, `items`, `order`, `fulfillment`): `Promise`<[`FulfillmentProviderData`](../../admin_discounts/modules/admin_discounts.internal.mdx#fulfillmentproviderdata)\> Create a fulfillment using data from shipping method, line items, and fulfillment. All from the order. The returned value of this method will populate the `fulfillment.data` field. @@ -240,7 +240,7 @@ ___ ### createReturn -▸ **createReturn**(`returnOrder`): `Promise`\> +**createReturn**(`returnOrder`): `Promise`\> Used to create a return order. Should return the data necessary for future operations on the return; in particular the data may be used to receive @@ -304,7 +304,7 @@ ___ ### getFulfillmentDocuments -▸ **getFulfillmentDocuments**(`data`): `Promise`<`any`\> +**getFulfillmentDocuments**(`data`): `Promise`<`any`\> Used to retrieve documents associated with a fulfillment. @@ -349,7 +349,7 @@ ___ ### getFulfillmentOptions -▸ **getFulfillmentOptions**(): `Promise`<`any`[]\> +**getFulfillmentOptions**(): `Promise`<`any`[]\> Called before a shipping option is created in Admin. The method should return all of the options that the fulfillment provider can be used with, @@ -395,7 +395,7 @@ ___ ### getIdentifier -▸ **getIdentifier**(): `string` +**getIdentifier**(): `string` Return a unique identifier to retrieve the fulfillment plugin provider @@ -418,7 +418,7 @@ ___ ### getReturnDocuments -▸ **getReturnDocuments**(`data`): `Promise`<`any`\> +**getReturnDocuments**(`data`): `Promise`<`any`\> Used to retrieve documents related to a return order. @@ -463,7 +463,7 @@ ___ ### getShipmentDocuments -▸ **getShipmentDocuments**(`data`): `Promise`<`any`\> +**getShipmentDocuments**(`data`): `Promise`<`any`\> Used to retrieve documents related to a shipment. @@ -508,7 +508,7 @@ ___ ### retrieveDocuments -▸ **retrieveDocuments**(`fulfillmentData`, `documentType`): `Promise`<`any`\> +**retrieveDocuments**(`fulfillmentData`, `documentType`): `Promise`<`any`\> #### Parameters @@ -559,7 +559,7 @@ ___ ### validateFulfillmentData -▸ **validateFulfillmentData**(`optionData`, `data`, `cart`): `Promise`\> +**validateFulfillmentData**(`optionData`, `data`, `cart`): `Promise`\> Called before a shipping method is set on a cart to ensure that the data sent with the shipping method is valid. The data object may contain extra @@ -641,7 +641,7 @@ ___ ### validateOption -▸ **validateOption**(`data`): `Promise`<`boolean`\> +**validateOption**(`data`): `Promise`<`boolean`\> Called before a shipping option is created in Admin. Use this to ensure that a fulfillment option does in fact exist. diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx index 37edc44fb5..d12a191520 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IBatchJobStrategy.mdx @@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -86,7 +86,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -163,7 +163,7 @@ ___ ### buildTemplate -▸ **buildTemplate**(): `Promise`<`string`\> +**buildTemplate**(): `Promise`<`string`\> Builds and returns a template file that can be downloaded and filled in @@ -195,7 +195,7 @@ ___ ### preProcessBatchJob -▸ **preProcessBatchJob**(`batchJobId`): `Promise`<`void`\> +**preProcessBatchJob**(`batchJobId`): `Promise`<`void`\> Method for pre-processing a batch job @@ -231,7 +231,7 @@ ___ ### prepareBatchJobForProcessing -▸ **prepareBatchJobForProcessing**(`batchJobEntity`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\> +**prepareBatchJobForProcessing**(`batchJobEntity`, `req`): `Promise`<[`CreateBatchJobInput`](../modules/admin_discounts.internal.internal.mdx#createbatchjobinput)\> Method for preparing a batch job for processing @@ -284,7 +284,7 @@ ___ ### processJob -▸ **processJob**(`batchJobId`): `Promise`<`void`\> +**processJob**(`batchJobId`): `Promise`<`void`\> Method does the actual processing of the job. Should report back on the progress of the operation. @@ -320,7 +320,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -358,7 +358,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`IBatchJobStrategy`](admin_discounts.internal.internal.IBatchJobStrategy.mdx) +**withTransaction**(`transactionManager?`): [`IBatchJobStrategy`](admin_discounts.internal.internal.IBatchJobStrategy.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ICartCompletionStrategy.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ICartCompletionStrategy.mdx index 404ebd057a..abc3ec47b3 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ICartCompletionStrategy.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ICartCompletionStrategy.mdx @@ -16,7 +16,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### complete -▸ **complete**(`cartId`, `idempotencyKey`, `context`): `Promise`<[`CartCompletionResponse`](../modules/admin_discounts.internal.internal.mdx#cartcompletionresponse)\> +**complete**(`cartId`, `idempotencyKey`, `context`): `Promise`<[`CartCompletionResponse`](../modules/admin_discounts.internal.internal.mdx#cartcompletionresponse)\> Takes a cart id and completes the cart. This for example takes place when creating an order or confirming a swap. diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IFileService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IFileService.mdx index ccb17a298c..4f022b8318 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IFileService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IFileService.mdx @@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -86,7 +86,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -163,7 +163,7 @@ ___ ### delete -▸ **delete**(`fileData`): `Promise`<`void`\> +**delete**(`fileData`): `Promise`<`void`\> remove file from fileservice @@ -199,7 +199,7 @@ ___ ### getDownloadStream -▸ **getDownloadStream**(`fileData`): `Promise`<[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)\> +**getDownloadStream**(`fileData`): `Promise`<[`ReadableStream`](admin_discounts.internal.ReadableStream.mdx)\> download file from fileservice as stream @@ -244,7 +244,7 @@ ___ ### getPresignedDownloadUrl -▸ **getPresignedDownloadUrl**(`fileData`): `Promise`<`string`\> +**getPresignedDownloadUrl**(`fileData`): `Promise`<`string`\> Generate a presigned download url to obtain a file @@ -289,7 +289,7 @@ ___ ### getUploadStreamDescriptor -▸ **getUploadStreamDescriptor**(`fileData`): `Promise`<[`FileServiceGetUploadStreamResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileservicegetuploadstreamresult)\> +**getUploadStreamDescriptor**(`fileData`): `Promise`<[`FileServiceGetUploadStreamResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileservicegetuploadstreamresult)\> upload file to fileservice from stream @@ -334,7 +334,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -372,7 +372,7 @@ ___ ### upload -▸ **upload**(`file`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> +**upload**(`file`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> upload file to fileservice @@ -417,7 +417,7 @@ ___ ### uploadProtected -▸ **uploadProtected**(`file`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> +**uploadProtected**(`file`): `Promise`<[`FileServiceUploadResult`](../../admin_discounts/modules/admin_discounts.internal.mdx#fileserviceuploadresult)\> upload private file to fileservice @@ -462,7 +462,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`IFileService`](admin_discounts.internal.internal.IFileService.mdx) +**withTransaction**(`transactionManager?`): [`IFileService`](admin_discounts.internal.internal.IFileService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.INotificationService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.INotificationService.mdx index 02d8676f2e..1a0f7b5689 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.INotificationService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.INotificationService.mdx @@ -61,7 +61,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -86,7 +86,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -163,7 +163,7 @@ ___ ### resendNotification -▸ **resendNotification**(`notification`, `config`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> +**resendNotification**(`notification`, `config`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> #### Parameters @@ -222,7 +222,7 @@ ___ ### sendNotification -▸ **sendNotification**(`event`, `data`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> +**sendNotification**(`event`, `data`, `attachmentGenerator`): `Promise`<[`ReturnedData`](../../admin_discounts/modules/admin_discounts.internal.mdx#returneddata)\> #### Parameters @@ -281,7 +281,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -319,7 +319,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`INotificationService`](admin_discounts.internal.internal.INotificationService.mdx) +**withTransaction**(`transactionManager?`): [`INotificationService`](admin_discounts.internal.internal.INotificationService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx index 517d2d2345..3a444ebd99 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.IPriceSelectionStrategy.mdx @@ -16,7 +16,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### calculateVariantPrice -▸ **calculateVariantPrice**(`data`, `context`): `Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/admin_discounts.internal.internal.mdx#priceselectionresult)\>\> +**calculateVariantPrice**(`data`, `context`): `Promise`<`Map`<`string`, [`PriceSelectionResult`](../modules/admin_discounts.internal.internal.mdx#priceselectionresult)\>\> Calculate the original and discount price for a given variant in a set of circumstances described in the context. @@ -87,7 +87,7 @@ ___ ### onVariantsPricesUpdate -▸ **onVariantsPricesUpdate**(`variantIds`): `Promise`<`void`\> +**onVariantsPricesUpdate**(`variantIds`): `Promise`<`void`\> Notify price selection strategy that variants prices have been updated. @@ -123,7 +123,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`IPriceSelectionStrategy`](admin_discounts.internal.internal.IPriceSelectionStrategy.mdx) +**withTransaction**(`transactionManager?`): [`IPriceSelectionStrategy`](admin_discounts.internal.internal.IPriceSelectionStrategy.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxCalculationStrategy.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxCalculationStrategy.mdx index c8747b7624..8fd5549cb9 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxCalculationStrategy.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxCalculationStrategy.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### calculate -▸ **calculate**(`items`, `taxLines`, `calculationContext`): `Promise`<`number`\> +**calculate**(`items`, `taxLines`, `calculationContext`): `Promise`<`number`\> Calculates the tax amount for a given set of line items under applicable tax conditions and calculation contexts. diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxService.mdx index f3e3439a1b..00b77f65bc 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.ITaxService.mdx @@ -20,7 +20,7 @@ items and shipping methods. ### getTaxLines -▸ **getTaxLines**(`itemLines`, `shippingLines`, `context`): `Promise`<[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]\> +**getTaxLines**(`itemLines`, `shippingLines`, `context`): `Promise`<[`ProviderTaxLine`](../../admin_discounts/modules/admin_discounts.internal.mdx#providertaxline)[]\> Retrieves the numerical tax lines for a calculation context. diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.MedusaRequest.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.MedusaRequest.mdx index 38203c7c97..ef539d348a 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.MedusaRequest.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.MedusaRequest.mdx @@ -313,7 +313,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### [asyncIterator] -▸ **[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> +**[asyncIterator]**(): [`AsyncIterableIterator`](admin_discounts.internal.AsyncIterableIterator.mdx)<`any`\> #### Returns @@ -347,7 +347,7 @@ ___ ### \_construct -▸ `Optional` **_construct**(`callback`): `void` +`Optional` **_construct**(`callback`): `void` #### Parameters @@ -385,7 +385,7 @@ ___ ### \_destroy -▸ **_destroy**(`error`, `callback`): `void` +**_destroy**(`error`, `callback`): `void` #### Parameters @@ -431,7 +431,7 @@ ___ ### \_read -▸ **_read**(`size`): `void` +**_read**(`size`): `void` #### Parameters @@ -469,7 +469,7 @@ ___ ### addListener -▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) Event emitter The defined events on documents including: @@ -521,7 +521,7 @@ The defined events on documents including: Request.addListener -▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -563,7 +563,7 @@ Request.addListener Request.addListener -▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -605,7 +605,7 @@ Request.addListener Request.addListener -▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -647,7 +647,7 @@ Request.addListener Request.addListener -▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -689,7 +689,7 @@ Request.addListener Request.addListener -▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -731,7 +731,7 @@ Request.addListener Request.addListener -▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -773,7 +773,7 @@ Request.addListener Request.addListener -▸ **addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**addListener**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -819,7 +819,7 @@ ___ ### destroy -▸ **destroy**(`error?`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**destroy**(`error?`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) Calls `destroy()` on the socket that received the `IncomingMessage`. If `error`is provided, an `'error'` event is emitted on the socket and `error` is passed as an argument to any listeners on the event. @@ -864,7 +864,7 @@ ___ ### emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -898,7 +898,7 @@ ___ Request.emit -▸ **emit**(`event`, `chunk`): `boolean` +**emit**(`event`, `chunk`): `boolean` #### Parameters @@ -940,7 +940,7 @@ Request.emit Request.emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -974,7 +974,7 @@ Request.emit Request.emit -▸ **emit**(`event`, `err`): `boolean` +**emit**(`event`, `err`): `boolean` #### Parameters @@ -1016,7 +1016,7 @@ Request.emit Request.emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1050,7 +1050,7 @@ Request.emit Request.emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1084,7 +1084,7 @@ Request.emit Request.emit -▸ **emit**(`event`): `boolean` +**emit**(`event`): `boolean` #### Parameters @@ -1118,7 +1118,7 @@ Request.emit Request.emit -▸ **emit**(`event`, `...args`): `boolean` +**emit**(`event`, `...args`): `boolean` #### Parameters @@ -1164,7 +1164,7 @@ ___ ### eventNames -▸ **eventNames**(): (`string` \| `symbol`)[] +**eventNames**(): (`string` \| `symbol`)[] Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or `Symbol`s. @@ -1219,7 +1219,7 @@ ___ ### getMaxListeners -▸ **getMaxListeners**(): `number` +**getMaxListeners**(): `number` Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to defaultMaxListeners. @@ -1251,7 +1251,7 @@ ___ ### isPaused -▸ **isPaused**(): `boolean` +**isPaused**(): `boolean` The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most typical cases, there will be no reason to @@ -1294,7 +1294,7 @@ ___ ### listenerCount -▸ **listenerCount**(`eventName`, `listener?`): `number` +**listenerCount**(`eventName`, `listener?`): `number` Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -1348,7 +1348,7 @@ ___ ### listeners -▸ **listeners**(`eventName`): `Function`[] +**listeners**(`eventName`): `Function`[] Returns a copy of the array of listeners for the event named `eventName`. @@ -1400,7 +1400,7 @@ ___ ### off -▸ **off**(`eventName`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**off**(`eventName`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) Alias for `emitter.removeListener()`. @@ -1452,7 +1452,7 @@ ___ ### on -▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -1494,7 +1494,7 @@ ___ Request.on -▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -1536,7 +1536,7 @@ Request.on Request.on -▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -1578,7 +1578,7 @@ Request.on Request.on -▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -1620,7 +1620,7 @@ Request.on Request.on -▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -1662,7 +1662,7 @@ Request.on Request.on -▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -1704,7 +1704,7 @@ Request.on Request.on -▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -1746,7 +1746,7 @@ Request.on Request.on -▸ **on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**on**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -1792,7 +1792,7 @@ ___ ### once -▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -1834,7 +1834,7 @@ ___ Request.once -▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -1876,7 +1876,7 @@ Request.once Request.once -▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -1918,7 +1918,7 @@ Request.once Request.once -▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -1960,7 +1960,7 @@ Request.once Request.once -▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -2002,7 +2002,7 @@ Request.once Request.once -▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -2044,7 +2044,7 @@ Request.once Request.once -▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -2086,7 +2086,7 @@ Request.once Request.once -▸ **once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**once**(`event`, `listener`): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) #### Parameters @@ -2132,7 +2132,7 @@ ___ ### pause -▸ **pause**(): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) +**pause**(): [`MedusaRequest`](admin_discounts.internal.internal.MedusaRequest.mdx) The `readable.pause()` method will cause a stream in flowing mode to stop emitting `'data'` events, switching out of flowing mode. Any data that @@ -2180,7 +2180,7 @@ ___ ### pipe -▸ **pipe**<`T`\>(`destination`, `options?`): `T` +**pipe**<`T`\>(`destination`, `options?`): `T` ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> +**authorizePayment**(`paymentSessionData`, `context`): `Promise`<[`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| { `data`: Record<`string`, `unknown`\> ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> Authorize an existing session if it is not already authorized @@ -72,7 +72,7 @@ ___ ### cancelPayment -▸ **cancelPayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> +**cancelPayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> Cancel an existing session @@ -117,7 +117,7 @@ ___ ### capturePayment -▸ **capturePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> +**capturePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> Capture an existing session @@ -162,7 +162,7 @@ ___ ### deletePayment -▸ **deletePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> +**deletePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> Delete an existing session @@ -207,7 +207,7 @@ ___ ### getIdentifier -▸ **getIdentifier**(): `string` +**getIdentifier**(): `string` Return a unique identifier to retrieve the payment plugin provider @@ -230,7 +230,7 @@ ___ ### getPaymentStatus -▸ **getPaymentStatus**(`paymentSessionData`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> +**getPaymentStatus**(`paymentSessionData`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> Return the status of the session @@ -307,7 +307,7 @@ ___ ### initiatePayment -▸ **initiatePayment**(`context`): `Promise`<[`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> +**initiatePayment**(`context`): `Promise`<[`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> Initiate a payment session with the external provider @@ -352,7 +352,7 @@ ___ ### refundPayment -▸ **refundPayment**(`paymentSessionData`, `refundAmount`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> +**refundPayment**(`paymentSessionData`, `refundAmount`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> Refund an existing session @@ -405,7 +405,7 @@ ___ ### retrievePayment -▸ **retrievePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> +**retrievePayment**(`paymentSessionData`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> Retrieve an existing session @@ -450,7 +450,7 @@ ___ ### updatePayment -▸ **updatePayment**(`context`): `Promise`<`void` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> +**updatePayment**(`context`): `Promise`<`void` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx) \| [`PaymentProcessorSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentprocessorsessionresponse)\> Update an existing payment session @@ -495,7 +495,7 @@ ___ ### updatePaymentData -▸ **updatePaymentData**(`sessionId`, `data`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> +**updatePaymentData**(`sessionId`, `data`): `Promise` \| [`PaymentProcessorError`](admin_discounts.internal.internal.PaymentProcessorError.mdx)\> Update the session data for a payment session diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentService.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentService.mdx index c3a7d87a35..03dae83ae6 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentService.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_discounts.internal.internal.PaymentService.mdx @@ -67,7 +67,7 @@ in the near future use the new PaymentProcessor interface instead ### activeManager\_ -• `Protected` `get` **activeManager_**(): `EntityManager` +`Protected` `get` **activeManager_**(): `EntityManager` #### Returns @@ -92,7 +92,7 @@ TransactionBaseService.activeManager\_ ### atomicPhase\_ -▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> +`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\> Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new @@ -169,7 +169,7 @@ ___ ### authorizePayment -▸ **authorizePayment**(`paymentSession`, `context`): `Promise`<{ `data`: [`Data`](../modules/admin_discounts.internal.internal.mdx#data) ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> +**authorizePayment**(`paymentSession`, `context`): `Promise`<{ `data`: [`Data`](../modules/admin_discounts.internal.internal.mdx#data) ; `status`: [`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx) }\> This will be @@ -226,7 +226,7 @@ ___ ### cancelPayment -▸ **cancelPayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +**cancelPayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> This will be @@ -275,7 +275,7 @@ ___ ### capturePayment -▸ **capturePayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +**capturePayment**(`payment`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> This will be @@ -324,7 +324,7 @@ ___ ### createPayment -▸ **createPayment**(`context`): `Promise`<[`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> +**createPayment**(`context`): `Promise`<[`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> This will be @@ -369,7 +369,7 @@ This will be in the near future use PaymentProcessor.initiatePayment instead -▸ **createPayment**(`cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +**createPayment**(`cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> This will be @@ -418,7 +418,7 @@ ___ ### deletePayment -▸ **deletePayment**(`paymentSession`): `Promise`<`void`\> +**deletePayment**(`paymentSession`): `Promise`<`void`\> This will be @@ -458,7 +458,7 @@ ___ ### getIdentifier -▸ **getIdentifier**(): `string` +**getIdentifier**(): `string` #### Returns @@ -479,7 +479,7 @@ ___ ### getPaymentData -▸ **getPaymentData**(`paymentSession`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +**getPaymentData**(`paymentSession`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> This will be @@ -528,7 +528,7 @@ ___ ### getStatus -▸ **getStatus**(`data`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> +**getStatus**(`data`): `Promise`<[`PaymentSessionStatus`](../enums/admin_discounts.internal.internal.PaymentSessionStatus.mdx)\> This will be @@ -609,7 +609,7 @@ ___ ### refundPayment -▸ **refundPayment**(`payment`, `refundAmount`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +**refundPayment**(`payment`, `refundAmount`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> This will be @@ -666,7 +666,7 @@ ___ ### retrievePayment -▸ **retrievePayment**(`paymentData`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +**retrievePayment**(`paymentData`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> This will be @@ -715,7 +715,7 @@ ___ ### retrieveSavedMethods -▸ **retrieveSavedMethods**(`customer`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)[]\> +**retrieveSavedMethods**(`customer`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)[]\> This will be @@ -773,7 +773,7 @@ ___ ### shouldRetryTransaction\_ -▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean` +`Protected` **shouldRetryTransaction_**(`err`): `boolean` #### Parameters @@ -811,7 +811,7 @@ ___ ### updatePayment -▸ **updatePayment**(`paymentSessionData`, `context`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data) \| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> +**updatePayment**(`paymentSessionData`, `context`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data) \| [`PaymentSessionResponse`](../modules/admin_discounts.internal.internal.mdx#paymentsessionresponse)\> #### Parameters @@ -858,7 +858,7 @@ ___ } ]} /> -▸ **updatePayment**(`paymentSessionData`, `cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +**updatePayment**(`paymentSessionData`, `cart`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> This will be @@ -915,7 +915,7 @@ ___ ### updatePaymentData -▸ **updatePaymentData**(`paymentSessionData`, `data`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> +**updatePaymentData**(`paymentSessionData`, `data`): `Promise`<[`Data`](../modules/admin_discounts.internal.internal.mdx#data)\> This will be @@ -972,7 +972,7 @@ ___ ### withTransaction -▸ **withTransaction**(`transactionManager?`): [`PaymentService`](admin_discounts.internal.internal.PaymentService.mdx) +**withTransaction**(`transactionManager?`): [`PaymentService`](admin_discounts.internal.internal.PaymentService.mdx) #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.File.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.File.mdx index c8059a469f..f87702e2ab 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.File.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.File.mdx @@ -69,7 +69,7 @@ Provides information about files and allows JavaScript in a web page to access t ### arrayBuffer -▸ **arrayBuffer**(): `Promise`<`ArrayBuffer`\> +**arrayBuffer**(): `Promise`<`ArrayBuffer`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/arrayBuffer) @@ -96,7 +96,7 @@ ___ ### slice -▸ **slice**(`start?`, `end?`, `contentType?`): `Blob` +**slice**(`start?`, `end?`, `contentType?`): `Blob` [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/slice) @@ -152,7 +152,7 @@ ___ ### stream -▸ **stream**(): [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`Uint8Array`\> +**stream**(): [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`Uint8Array`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/stream) @@ -188,7 +188,7 @@ ___ ### text -▸ **text**(): `Promise`<`string`\> +**text**(): `Promise`<`string`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/Blob/text) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.QueuingStrategySize.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.QueuingStrategySize.mdx index d75c135139..ed68abf66d 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.QueuingStrategySize.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.QueuingStrategySize.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### QueuingStrategySize -▸ **QueuingStrategySize**(`chunk`): `number` +**QueuingStrategySize**(`chunk`): `number` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableByteStreamController.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableByteStreamController.mdx index 536e9c2305..51c1fee335 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableByteStreamController.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableByteStreamController.mdx @@ -35,7 +35,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### close -▸ **close**(): `void` +**close**(): `void` [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/close) @@ -58,7 +58,7 @@ ___ ### enqueue -▸ **enqueue**(`chunk`): `void` +**enqueue**(`chunk`): `void` [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/enqueue) @@ -94,7 +94,7 @@ ___ ### error -▸ **error**(`e?`): `void` +**error**(`e?`): `void` [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableByteStreamController/error) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStream.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStream.mdx index 77efeb0c33..5ec39ef0fe 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStream.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStream.mdx @@ -42,7 +42,7 @@ This Streams API interface represents a readable stream of byte data. The Fetch ### cancel -▸ **cancel**(`reason?`): `Promise`<`void`\> +**cancel**(`reason?`): `Promise`<`void`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/cancel) @@ -78,7 +78,7 @@ ___ ### getReader -▸ **getReader**(`options`): [`ReadableStreamBYOBReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreambyobreader) +**getReader**(`options`): [`ReadableStreamBYOBReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreambyobreader) [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/getReader) @@ -118,7 +118,7 @@ ___ } ]} /> -▸ **getReader**(): [`ReadableStreamDefaultReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\> +**getReader**(): [`ReadableStreamDefaultReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamdefaultreader)<`R`\> #### Returns @@ -135,7 +135,7 @@ ___ } ]} /> -▸ **getReader**(`options?`): [`ReadableStreamReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreader)<`R`\> +**getReader**(`options?`): [`ReadableStreamReader`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreader)<`R`\> #### Parameters @@ -169,7 +169,7 @@ ___ ### pipeThrough -▸ **pipeThrough**<`T`\>(`transform`, `options?`): [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`T`\> +**pipeThrough**<`T`\>(`transform`, `options?`): [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`T`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeThrough) @@ -224,7 +224,7 @@ ___ ### pipeTo -▸ **pipeTo**(`destination`, `options?`): `Promise`<`void`\> +**pipeTo**(`destination`, `options?`): `Promise`<`void`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/pipeTo) @@ -268,7 +268,7 @@ ___ ### tee -▸ **tee**(): [[`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\>, [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\>] +**tee**(): [[`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\>, [`ReadableStream`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestream)<`R`\>] [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStream/tee) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBReader.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBReader.mdx index 98d06cfb63..5fc5569ab6 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBReader.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBReader.mdx @@ -27,7 +27,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### cancel -▸ **cancel**(`reason?`): `Promise`<`void`\> +**cancel**(`reason?`): `Promise`<`void`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) @@ -67,7 +67,7 @@ ___ ### read -▸ **read**<`T`\>(`view`): `Promise`<[`ReadableStreamReadResult`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreadresult)<`T`\>\> +**read**<`T`\>(`view`): `Promise`<[`ReadableStreamReadResult`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreadresult)<`T`\>\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/read) @@ -123,7 +123,7 @@ ___ ### releaseLock -▸ **releaseLock**(): `void` +**releaseLock**(): `void` [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/releaseLock) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBRequest.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBRequest.mdx index ff582dc723..a4ad09307f 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBRequest.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamBYOBRequest.mdx @@ -27,7 +27,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### respond -▸ **respond**(`bytesWritten`): `void` +**respond**(`bytesWritten`): `void` [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respond) @@ -63,7 +63,7 @@ ___ ### respondWithNewView -▸ **respondWithNewView**(`view`): `void` +**respondWithNewView**(`view`): `void` [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBRequest/respondWithNewView) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultController.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultController.mdx index 7afce6bc31..124ceb7611 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultController.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultController.mdx @@ -40,7 +40,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### close -▸ **close**(): `void` +**close**(): `void` [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/close) @@ -63,7 +63,7 @@ ___ ### enqueue -▸ **enqueue**(`chunk?`): `void` +**enqueue**(`chunk?`): `void` [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/enqueue) @@ -99,7 +99,7 @@ ___ ### error -▸ **error**(`e?`): `void` +**error**(`e?`): `void` [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultController/error) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultReader.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultReader.mdx index de7b139743..fdb2420e03 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultReader.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamDefaultReader.mdx @@ -40,7 +40,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### cancel -▸ **cancel**(`reason?`): `Promise`<`void`\> +**cancel**(`reason?`): `Promise`<`void`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) @@ -80,7 +80,7 @@ ___ ### read -▸ **read**(): `Promise`<[`ReadableStreamReadResult`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreadresult)<`R`\>\> +**read**(): `Promise`<[`ReadableStreamReadResult`](../../admin_uploads/modules/admin_uploads.internal.mdx#readablestreamreadresult)<`R`\>\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/read) @@ -112,7 +112,7 @@ ___ ### releaseLock -▸ **releaseLock**(): `void` +**releaseLock**(): `void` [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamDefaultReader/releaseLock) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamGenericReader.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamGenericReader.mdx index 65ac482aae..d6b813d3b6 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamGenericReader.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.ReadableStreamGenericReader.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### cancel -▸ **cancel**(`reason?`): `Promise`<`void`\> +**cancel**(`reason?`): `Promise`<`void`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/cancel) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkAbortCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkAbortCallback.mdx index 45e4e476cb..d244d6bfde 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkAbortCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkAbortCallback.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### UnderlyingSinkAbortCallback -▸ **UnderlyingSinkAbortCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> +**UnderlyingSinkAbortCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkCloseCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkCloseCallback.mdx index 6c4d6d9bbf..b42e7d2bd0 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkCloseCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkCloseCallback.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### UnderlyingSinkCloseCallback -▸ **UnderlyingSinkCloseCallback**(): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> +**UnderlyingSinkCloseCallback**(): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> #### Returns diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkStartCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkStartCallback.mdx index 52c27a7048..414967c2f0 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkStartCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkStartCallback.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### UnderlyingSinkStartCallback -▸ **UnderlyingSinkStartCallback**(`controller`): `any` +**UnderlyingSinkStartCallback**(`controller`): `any` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkWriteCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkWriteCallback.mdx index fd8628bcef..06e7398a8a 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkWriteCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSinkWriteCallback.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### UnderlyingSinkWriteCallback -▸ **UnderlyingSinkWriteCallback**(`chunk`, `controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> +**UnderlyingSinkWriteCallback**(`chunk`, `controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceCancelCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceCancelCallback.mdx index bd703ca614..b4361cc62a 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceCancelCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceCancelCallback.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### UnderlyingSourceCancelCallback -▸ **UnderlyingSourceCancelCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> +**UnderlyingSourceCancelCallback**(`reason?`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourcePullCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourcePullCallback.mdx index 0f831d24a1..fc1abc6c3a 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourcePullCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourcePullCallback.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### UnderlyingSourcePullCallback -▸ **UnderlyingSourcePullCallback**(`controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> +**UnderlyingSourcePullCallback**(`controller`): `void` \| [`PromiseLike`](admin_discounts.internal.PromiseLike.mdx)<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceStartCallback.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceStartCallback.mdx index 18ccc048ee..5edc7697d0 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceStartCallback.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.UnderlyingSourceStartCallback.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### UnderlyingSourceStartCallback -▸ **UnderlyingSourceStartCallback**(`controller`): `any` +**UnderlyingSourceStartCallback**(`controller`): `any` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStream.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStream.mdx index 8abaf700fc..ad9afcc85b 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStream.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStream.mdx @@ -42,7 +42,7 @@ This Streams API interface provides a standard abstraction for writing streamin ### abort -▸ **abort**(`reason?`): `Promise`<`void`\> +**abort**(`reason?`): `Promise`<`void`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/abort) @@ -78,7 +78,7 @@ ___ ### close -▸ **close**(): `Promise`<`void`\> +**close**(): `Promise`<`void`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/close) @@ -101,7 +101,7 @@ ___ ### getWriter -▸ **getWriter**(): [`WritableStreamDefaultWriter`](../../admin_uploads/modules/admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\> +**getWriter**(): [`WritableStreamDefaultWriter`](../../admin_uploads/modules/admin_uploads.internal.mdx#writablestreamdefaultwriter)<`W`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStream/getWriter) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultController.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultController.mdx index 0b192f269f..12fdcd5d8e 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultController.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultController.mdx @@ -29,7 +29,7 @@ This Streams API interface represents a controller allowing control of a Writab ### error -▸ **error**(`e?`): `void` +**error**(`e?`): `void` [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultController/error) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultWriter.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultWriter.mdx index bcf816a254..495b5c9b6d 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultWriter.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/admin_uploads.internal.WritableStreamDefaultWriter.mdx @@ -58,7 +58,7 @@ This Streams API interface is the object returned by WritableStream.getWriter() ### abort -▸ **abort**(`reason?`): `Promise`<`void`\> +**abort**(`reason?`): `Promise`<`void`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/abort) @@ -94,7 +94,7 @@ ___ ### close -▸ **close**(): `Promise`<`void`\> +**close**(): `Promise`<`void`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/close) @@ -117,7 +117,7 @@ ___ ### releaseLock -▸ **releaseLock**(): `void` +**releaseLock**(): `void` [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/releaseLock) @@ -140,7 +140,7 @@ ___ ### write -▸ **write**(`chunk?`): `Promise`<`void`\> +**write**(`chunk?`): `Promise`<`void`\> [MDN Reference](https://developer.mozilla.org/docs/Web/API/WritableStreamDefaultWriter/write) diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosAdapter.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosAdapter.mdx index 0be60ef1d7..7fce44840b 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosAdapter.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosAdapter.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AxiosAdapter -▸ **AxiosAdapter**(`config`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\> +**AxiosAdapter**(`config`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosInstance.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosInstance.mdx index 3929e82291..e52f0f806f 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosInstance.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosInstance.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AxiosInstance -▸ **AxiosInstance**(`config`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\> +**AxiosInstance**(`config`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\> #### Parameters @@ -53,7 +53,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AxiosInstance -▸ **AxiosInstance**(`url`, `config?`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\> +**AxiosInstance**(`url`, `config?`): [`AxiosPromise`](swaps.internal.AxiosPromise.mdx)<`any`\> #### Parameters @@ -141,7 +141,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### delete -▸ **delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> +**delete**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> (`url`, `config?`): `Promise`<`R`\> +**get**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> (`url`, `config?`): `Promise`<`R`\> +**head**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> (`url`, `config?`): `Promise`<`R`\> +**options**<`T`, `R`, `D`\>(`url`, `config?`): `Promise`<`R`\> (`url`, `data?`, `config?`): `Promise`<`R`\> +**patch**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> (`url`, `data?`, `config?`): `Promise`<`R`\> +**post**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> (`url`, `data?`, `config?`): `Promise`<`R`\> +**put**<`T`, `R`, `D`\>(`url`, `data?`, `config?`): `Promise`<`R`\> (`config`): `Promise`<`R`\> +**request**<`T`, `R`, `D`\>(`config`): `Promise`<`R`\> (`onFulfilled?`, `onRejected?`): `number` +**use**<`T`\>(`onFulfilled?`, `onRejected?`): `number` (`onrejected?`): `Promise`<[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`T`, `any`\> \| `TResult`\> +**catch**<`TResult`\>(`onrejected?`): `Promise`<[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`T`, `any`\> \| `TResult`\> Attaches a callback for only the rejection of the Promise. @@ -98,7 +98,7 @@ ___ ### finally -▸ **finally**(`onfinally?`): `Promise`<[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`T`, `any`\>\> +**finally**(`onfinally?`): `Promise`<[`AxiosResponse`](swaps.internal.AxiosResponse.mdx)<`T`, `any`\>\> Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback. @@ -157,7 +157,7 @@ ___ ### then -▸ **then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): `Promise`<`TResult1` \| `TResult2`\> +**then**<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): `Promise`<`TResult1` \| `TResult2`\> Attaches callbacks for the resolution and/or rejection of the Promise. diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosRequestTransformer.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosRequestTransformer.mdx index 2a379a8e7c..7271832e76 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosRequestTransformer.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosRequestTransformer.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AxiosRequestTransformer -▸ **AxiosRequestTransformer**(`data`, `headers?`): `any` +**AxiosRequestTransformer**(`data`, `headers?`): `any` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosResponseTransformer.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosResponseTransformer.mdx index 6447c850a8..30ab415730 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosResponseTransformer.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.AxiosResponseTransformer.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AxiosResponseTransformer -▸ **AxiosResponseTransformer**(`data`, `headers?`): `any` +**AxiosResponseTransformer**(`data`, `headers?`): `any` #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.CancelToken.mdx b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.CancelToken.mdx index a0f04892b0..48f2d8dfaa 100644 --- a/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.CancelToken.mdx +++ b/www/apps/docs/content/references/js-client/internal/interfaces/swaps.internal.CancelToken.mdx @@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### throwIfRequested -▸ **throwIfRequested**(): `void` +**throwIfRequested**(): `void` #### Returns diff --git a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-2.mdx b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-2.mdx index 43b6e6efbb..f2bbb3c7d8 100644 --- a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-2.mdx +++ b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-2.mdx @@ -78,7 +78,7 @@ Re-exports [TransformOptions](../interfaces/admin_discounts.internal.TransformOp ### PipelineCallback -Ƭ **PipelineCallback**<`S`\>: `S` extends [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, infer P\> ? (`err`: [`ErrnoException`](../interfaces/admin_discounts.internal.ErrnoException.mdx) \| ``null``, `value`: `P`) => `void` : (`err`: [`ErrnoException`](../interfaces/admin_discounts.internal.ErrnoException.mdx) \| ``null``) => `void` + **PipelineCallback**<`S`\>: `S` extends [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, infer P\> ? (`err`: [`ErrnoException`](../interfaces/admin_discounts.internal.ErrnoException.mdx) \| ``null``, `value`: `P`) => `void` : (`err`: [`ErrnoException`](../interfaces/admin_discounts.internal.ErrnoException.mdx) \| ``null``) => `void` #### Type parameters @@ -97,7 +97,7 @@ ___ ### PipelineDestination -Ƭ **PipelineDestination**<`S`, `P`\>: `S` extends [`PipelineTransformSource`](admin_discounts.internal.internal-2.mdx#pipelinetransformsource) ? [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`ST`\> \| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`ST`, `P`\> : `never` + **PipelineDestination**<`S`, `P`\>: `S` extends [`PipelineTransformSource`](admin_discounts.internal.internal-2.mdx#pipelinetransformsource) ? [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) \| [`PipelineDestinationIterableFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationiterablefunction)<`ST`\> \| [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`ST`, `P`\> : `never` #### Type parameters @@ -124,7 +124,7 @@ ___ ### PipelineDestinationIterableFunction -Ƭ **PipelineDestinationIterableFunction**<`T`\>: (`source`: [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\>) => [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\> + **PipelineDestinationIterableFunction**<`T`\>: (`source`: [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\>) => [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\> #### Type parameters @@ -141,7 +141,7 @@ ___ #### Type declaration -▸ (`source`): [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\> +(`source`): [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`any`\> ##### Parameters @@ -184,7 +184,7 @@ ___ ### PipelineDestinationPromiseFunction -Ƭ **PipelineDestinationPromiseFunction**<`T`, `P`\>: (`source`: [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\>) => `Promise`<`P`\> + **PipelineDestinationPromiseFunction**<`T`, `P`\>: (`source`: [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\>) => `Promise`<`P`\> #### Type parameters @@ -209,7 +209,7 @@ ___ #### Type declaration -▸ (`source`): `Promise`<`P`\> +(`source`): `Promise`<`P`\> ##### Parameters @@ -243,7 +243,7 @@ ___ ### PipelinePromise -Ƭ **PipelinePromise**<`S`\>: `S` extends [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, infer P\> ? `Promise`<`P`\> : `Promise`<`void`\> + **PipelinePromise**<`S`\>: `S` extends [`PipelineDestinationPromiseFunction`](admin_discounts.internal.internal-2.mdx#pipelinedestinationpromisefunction)<`any`, infer P\> ? `Promise`<`P`\> : `Promise`<`void`\> #### Type parameters @@ -262,7 +262,7 @@ ___ ### PipelineSource -Ƭ **PipelineSource**<`T`\>: [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`T`\> \| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\> \| [`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \| [`PipelineSourceFunction`](admin_discounts.internal.internal-2.mdx#pipelinesourcefunction)<`T`\> + **PipelineSource**<`T`\>: [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`T`\> \| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\> \| [`ReadableStream`](../interfaces/admin_discounts.internal.ReadableStream.mdx) \| [`PipelineSourceFunction`](admin_discounts.internal.internal-2.mdx#pipelinesourcefunction)<`T`\> #### Type parameters @@ -281,7 +281,7 @@ ___ ### PipelineSourceFunction -Ƭ **PipelineSourceFunction**<`T`\>: () => [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`T`\> \| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\> + **PipelineSourceFunction**<`T`\>: () => [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`T`\> \| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\> #### Type parameters @@ -298,7 +298,7 @@ ___ #### Type declaration -▸ (): [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`T`\> \| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\> +(): [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx)<`T`\> \| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`T`\> ##### Returns @@ -319,7 +319,7 @@ ___ ### PipelineTransform -Ƭ **PipelineTransform**<`S`, `U`\>: [`ReadWriteStream`](../interfaces/admin_discounts.internal.ReadWriteStream.mdx) \| (`source`: `S` extends (...`args`: `any`[]) => [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx) \| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx) ? [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`ST`\> : `S`) => [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`U`\> + **PipelineTransform**<`S`, `U`\>: [`ReadWriteStream`](../interfaces/admin_discounts.internal.ReadWriteStream.mdx) \| (`source`: `S` extends (...`args`: `any`[]) => [`Iterable`](../interfaces/admin_discounts.internal.Iterable.mdx) \| [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx) ? [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`ST`\> : `S`) => [`AsyncIterable`](../interfaces/admin_discounts.internal.AsyncIterable.mdx)<`U`\> #### Type parameters @@ -346,7 +346,7 @@ ___ ### PipelineTransformSource -Ƭ **PipelineTransformSource**<`T`\>: [`PipelineSource`](admin_discounts.internal.internal-2.mdx#pipelinesource)<`T`\> \| [`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`any`, `T`\> + **PipelineTransformSource**<`T`\>: [`PipelineSource`](admin_discounts.internal.internal-2.mdx#pipelinesource)<`T`\> \| [`PipelineTransform`](admin_discounts.internal.internal-2.mdx#pipelinetransform)<`any`, `T`\> #### Type parameters @@ -365,19 +365,19 @@ ___ ### consumers -• `Const` **consumers**: typeof [`internal`](admin_discounts.internal.internal-4.mdx) + `Const` **consumers**: typeof [`internal`](admin_discounts.internal.internal-4.mdx) ___ ### promises -• `Const` **promises**: typeof [`internal`](admin_discounts.internal.internal-3.mdx) + `Const` **promises**: typeof [`internal`](admin_discounts.internal.internal-3.mdx) ## Functions ### addAbortSignal -▸ **addAbortSignal**<`T`\>(`signal`, `stream`): `T` +**addAbortSignal**<`T`\>(`signal`, `stream`): `T` A stream to attach a signal to. @@ -500,7 +500,7 @@ ___ ### finished -▸ **finished**(`stream`, `options`, `callback`): () => `void` +**finished**(`stream`, `options`, `callback`): () => `void` A readable and/or writable stream/webstream. @@ -586,7 +586,7 @@ const cleanup = finished(rs, (err) => { } ]} /> -▸ (): `void` +(): `void` ##### Returns @@ -607,7 +607,7 @@ const cleanup = finished(rs, (err) => { v10.0.0 -▸ **finished**(`stream`, `callback`): () => `void` +**finished**(`stream`, `callback`): () => `void` #### Parameters @@ -645,7 +645,7 @@ v10.0.0 } ]} /> -▸ (): `void` +(): `void` ##### Returns @@ -666,7 +666,7 @@ ___ ### getDefaultHighWaterMark -▸ **getDefaultHighWaterMark**(`objectMode`): `number` +**getDefaultHighWaterMark**(`objectMode`): `number` Returns the default highWaterMark used by streams. Defaults to `16384` (16 KiB), or `16` for `objectMode`. @@ -707,7 +707,7 @@ ___ ### isErrored -▸ **isErrored**(`stream`): `boolean` +**isErrored**(`stream`): `boolean` Returns whether the stream has encountered an error. @@ -747,7 +747,7 @@ ___ ### isReadable -▸ **isReadable**(`stream`): `boolean` +**isReadable**(`stream`): `boolean` Returns whether the stream is readable. @@ -787,7 +787,7 @@ ___ ### pipeline -▸ **pipeline**<`A`, `B`\>(`source`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) +**pipeline**<`A`, `B`\>(`source`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) A module method to pipe between streams and generators forwarding errors and properly cleaning up and provide a callback when the pipeline is complete. @@ -918,7 +918,7 @@ const server = http.createServer((req, res) => { v10.0.0 -▸ **pipeline**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) +**pipeline**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) -▸ **pipeline**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) +**pipeline**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) -▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) +**pipeline**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) -▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) +**pipeline**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `callback?`): `B` extends [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) ? `B` : [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) -▸ **pipeline**(`streams`, `callback?`): [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) +**pipeline**(`streams`, `callback?`): [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) #### Parameters @@ -1512,7 +1512,7 @@ v10.0.0 } ]} /> -▸ **pipeline**(`stream1`, `stream2`, `...streams`): [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) +**pipeline**(`stream1`, `stream2`, `...streams`): [`WritableStream`](../interfaces/admin_discounts.internal.WritableStream.mdx) #### Parameters @@ -1698,7 +1698,7 @@ ___ ### setDefaultHighWaterMark -▸ **setDefaultHighWaterMark**(`objectMode`, `value`): `void` +**setDefaultHighWaterMark**(`objectMode`, `value`): `void` Sets the default highWaterMark used by streams. diff --git a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-3.mdx b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-3.mdx index 6eb58b8626..74047f77d9 100644 --- a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-3.mdx +++ b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-3.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### finished -▸ **finished**(`stream`, `options?`): `Promise`<`void`\> +**finished**(`stream`, `options?`): `Promise`<`void`\> #### Parameters @@ -54,7 +54,7 @@ ___ ### pipeline -▸ **pipeline**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> +**pipeline**<`A`, `B`\>(`source`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> -▸ **pipeline**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> +**pipeline**<`A`, `T1`, `B`\>(`source`, `transform1`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> -▸ **pipeline**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> +**pipeline**<`A`, `T1`, `T2`, `B`\>(`source`, `transform1`, `transform2`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> -▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> +**pipeline**<`A`, `T1`, `T2`, `T3`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> -▸ **pipeline**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> +**pipeline**<`A`, `T1`, `T2`, `T3`, `T4`, `B`\>(`source`, `transform1`, `transform2`, `transform3`, `transform4`, `destination`, `options?`): [`PipelinePromise`](admin_discounts.internal.internal-2.mdx#pipelinepromise)<`B`\> -▸ **pipeline**(`streams`, `options?`): `Promise`<`void`\> +**pipeline**(`streams`, `options?`): `Promise`<`void`\> #### Parameters @@ -577,7 +577,7 @@ ___ } ]} /> -▸ **pipeline**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\> +**pipeline**(`stream1`, `stream2`, `...streams`): `Promise`<`void`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-4.mdx b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-4.mdx index 647dfeff45..c1816b44a3 100644 --- a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-4.mdx +++ b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal-4.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### arrayBuffer -▸ **arrayBuffer**(`stream`): `Promise`<`ArrayBuffer`\> +**arrayBuffer**(`stream`): `Promise`<`ArrayBuffer`\> #### Parameters @@ -46,7 +46,7 @@ ___ ### blob -▸ **blob**(`stream`): `Promise`<[`Blob`](../classes/admin_discounts.internal.Blob.mdx)\> +**blob**(`stream`): `Promise`<[`Blob`](../classes/admin_discounts.internal.Blob.mdx)\> #### Parameters @@ -129,7 +129,7 @@ ___ ### buffer -▸ **buffer**(`stream`): `Promise`<[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\> +**buffer**(`stream`): `Promise`<[`Buffer`](../../admin_discounts/modules/admin_discounts.internal.mdx#buffer)\> #### Parameters @@ -172,7 +172,7 @@ ___ ### json -▸ **json**(`stream`): `Promise`<`unknown`\> +**json**(`stream`): `Promise`<`unknown`\> #### Parameters @@ -215,7 +215,7 @@ ___ ### text -▸ **text**(`stream`): `Promise`<`string`\> +**text**(`stream`): `Promise`<`string`\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal.mdx b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal.mdx index 3d011d59cb..41a83c2a4b 100644 --- a/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal.mdx +++ b/www/apps/docs/content/references/js-client/internal/modules/admin_discounts.internal.internal.mdx @@ -1265,13 +1265,13 @@ Re-exports [UserRoles](../enums/admin_auth.internal.UserRoles.mdx) ### AdminAnalyticsConfigDeleteRes -Ƭ **AdminAnalyticsConfigDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminAnalyticsConfigDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) ___ ### AdminAnalyticsConfigRes -Ƭ **AdminAnalyticsConfigRes**: `Object` + **AdminAnalyticsConfigRes**: `Object` #### Type declaration @@ -1290,7 +1290,7 @@ ___ ### AdminCollectionsDeleteRes -Ƭ **AdminCollectionsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminCollectionsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -1317,7 +1317,7 @@ ___ ### AdminCustomerGroupsDeleteRes -Ƭ **AdminCustomerGroupsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminCustomerGroupsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -1344,7 +1344,7 @@ ___ ### AdminDeleteShippingProfileRes -Ƭ **AdminDeleteShippingProfileRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminDeleteShippingProfileRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -1371,7 +1371,7 @@ ___ ### AdminDeleteUploadsRes -Ƭ **AdminDeleteUploadsRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminDeleteUploadsRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -1398,7 +1398,7 @@ ___ ### AdminDeleteUserRes -Ƭ **AdminDeleteUserRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminDeleteUserRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -1425,7 +1425,7 @@ ___ ### AdminDiscountConditionsDeleteRes -Ƭ **AdminDiscountConditionsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) & { `discount`: [`Discount`](../classes/admin_collections.internal.Discount.mdx) } + **AdminDiscountConditionsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) & { `discount`: [`Discount`](../classes/admin_collections.internal.Discount.mdx) } #### Schema @@ -1456,7 +1456,7 @@ ___ ### AdminDiscountsDeleteRes -Ƭ **AdminDiscountsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminDiscountsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -1483,7 +1483,7 @@ ___ ### AdminDraftOrdersDeleteRes -Ƭ **AdminDraftOrdersDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminDraftOrdersDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -1510,7 +1510,7 @@ ___ ### AdminDraftOrdersListRes -Ƭ **AdminDraftOrdersListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `draft_orders`: [`DraftOrder`](../classes/admin_collections.internal.DraftOrder.mdx)[] } + **AdminDraftOrdersListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `draft_orders`: [`DraftOrder`](../classes/admin_collections.internal.DraftOrder.mdx)[] } #### Schema @@ -1548,7 +1548,7 @@ ___ ### AdminDraftOrdersRes -Ƭ **AdminDraftOrdersRes**: `Object` + **AdminDraftOrdersRes**: `Object` #### Schema @@ -1637,7 +1637,7 @@ ___ ### AdminExtendedStoresRes -Ƭ **AdminExtendedStoresRes**: `Object` + **AdminExtendedStoresRes**: `Object` #### Schema @@ -1672,7 +1672,7 @@ ___ ### AdminGetVariantsVariantInventoryRes -Ƭ **AdminGetVariantsVariantInventoryRes**: `Object` + **AdminGetVariantsVariantInventoryRes**: `Object` #### Schema @@ -1695,7 +1695,7 @@ ___ ### AdminGiftCardsDeleteRes -Ƭ **AdminGiftCardsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminGiftCardsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -1722,7 +1722,7 @@ ___ ### AdminGiftCardsListRes -Ƭ **AdminGiftCardsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `gift_cards`: [`GiftCard`](../classes/admin_collections.internal.GiftCard.mdx)[] } + **AdminGiftCardsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `gift_cards`: [`GiftCard`](../classes/admin_collections.internal.GiftCard.mdx)[] } #### Schema @@ -1760,7 +1760,7 @@ ___ ### AdminGiftCardsRes -Ƭ **AdminGiftCardsRes**: `Object` + **AdminGiftCardsRes**: `Object` #### Schema @@ -1783,7 +1783,7 @@ ___ ### AdminInventoryItemsDeleteRes -Ƭ **AdminInventoryItemsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminInventoryItemsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -1810,7 +1810,7 @@ ___ ### AdminInventoryItemsListRes -Ƭ **AdminInventoryItemsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `inventory_items`: [`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[] } + **AdminInventoryItemsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `inventory_items`: [`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[] } #### Schema @@ -1841,7 +1841,7 @@ ___ ### AdminInventoryItemsListWithVariantsAndLocationLevelsRes -Ƭ **AdminInventoryItemsListWithVariantsAndLocationLevelsRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `inventory_items`: [`DecoratedInventoryItemDTO`](admin_discounts.internal.internal.mdx#decoratedinventoryitemdto)[] } + **AdminInventoryItemsListWithVariantsAndLocationLevelsRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `inventory_items`: [`DecoratedInventoryItemDTO`](admin_discounts.internal.internal.mdx#decoratedinventoryitemdto)[] } #### Schema @@ -1872,7 +1872,7 @@ ___ ### AdminInventoryItemsLocationLevelsRes -Ƭ **AdminInventoryItemsLocationLevelsRes**: `Object` + **AdminInventoryItemsLocationLevelsRes**: `Object` #### Schema @@ -1928,7 +1928,7 @@ ___ ### AdminInventoryItemsRes -Ƭ **AdminInventoryItemsRes**: `Object` + **AdminInventoryItemsRes**: `Object` #### Schema @@ -1958,7 +1958,7 @@ ___ ### AdminInviteDeleteRes -Ƭ **AdminInviteDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminInviteDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -1985,7 +1985,7 @@ ___ ### AdminListInvitesRes -Ƭ **AdminListInvitesRes**: `Object` + **AdminListInvitesRes**: `Object` #### Schema @@ -2017,7 +2017,7 @@ ___ ### AdminNotesDeleteRes -Ƭ **AdminNotesDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminNotesDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -2044,7 +2044,7 @@ ___ ### AdminNotesListRes -Ƭ **AdminNotesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `notes`: [`Note`](../classes/admin_discounts.internal.internal.Note.mdx)[] } + **AdminNotesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `notes`: [`Note`](../classes/admin_discounts.internal.internal.Note.mdx)[] } #### Schema @@ -2075,7 +2075,7 @@ ___ ### AdminNotesRes -Ƭ **AdminNotesRes**: `Object` + **AdminNotesRes**: `Object` #### Schema @@ -2105,7 +2105,7 @@ ___ ### AdminNotificationsListRes -Ƭ **AdminNotificationsListRes**: [`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `notifications`: [`Notification`](../classes/admin_discounts.internal.internal.Notification.mdx)[] } + **AdminNotificationsListRes**: [`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `notifications`: [`Notification`](../classes/admin_discounts.internal.internal.Notification.mdx)[] } #### Schema @@ -2137,7 +2137,7 @@ ___ ### AdminNotificationsRes -Ƭ **AdminNotificationsRes**: `Object` + **AdminNotificationsRes**: `Object` #### Schema @@ -2171,7 +2171,7 @@ ___ ### AdminOrderEditDeleteRes -Ƭ **AdminOrderEditDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminOrderEditDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -2198,7 +2198,7 @@ ___ ### AdminOrderEditItemChangeDeleteRes -Ƭ **AdminOrderEditItemChangeDeleteRes**: `Object` + **AdminOrderEditItemChangeDeleteRes**: `Object` #### Schema @@ -2254,7 +2254,7 @@ ___ ### AdminOrderEditsListRes -Ƭ **AdminOrderEditsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `order_edits`: [`OrderEdit`](../classes/admin_collections.internal.OrderEdit.mdx)[] } + **AdminOrderEditsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `order_edits`: [`OrderEdit`](../classes/admin_collections.internal.OrderEdit.mdx)[] } #### Schema @@ -2264,7 +2264,7 @@ ___ ### AdminOrderEditsRes -Ƭ **AdminOrderEditsRes**: `Object` + **AdminOrderEditsRes**: `Object` #### Schema @@ -2287,7 +2287,7 @@ ___ ### AdminOrdersListRes -Ƭ **AdminOrdersListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `orders`: [`Order`](../classes/admin_collections.internal.Order.mdx)[] } + **AdminOrdersListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `orders`: [`Order`](../classes/admin_collections.internal.Order.mdx)[] } #### Schema @@ -2297,7 +2297,7 @@ ___ ### AdminOrdersRes -Ƭ **AdminOrdersRes**: `Object` + **AdminOrdersRes**: `Object` #### Schema @@ -2320,7 +2320,7 @@ ___ ### AdminPaymentCollectionDeleteRes -Ƭ **AdminPaymentCollectionDeleteRes**: `Object` + **AdminPaymentCollectionDeleteRes**: `Object` #### Schema @@ -2376,7 +2376,7 @@ ___ ### AdminPaymentCollectionsRes -Ƭ **AdminPaymentCollectionsRes**: `Object` + **AdminPaymentCollectionsRes**: `Object` #### Schema @@ -2415,7 +2415,7 @@ ___ ### AdminPaymentProvidersList -Ƭ **AdminPaymentProvidersList**: `Object` + **AdminPaymentProvidersList**: `Object` #### Schema @@ -2447,7 +2447,7 @@ ___ ### AdminPaymentRes -Ƭ **AdminPaymentRes**: `Object` + **AdminPaymentRes**: `Object` #### Schema @@ -2470,7 +2470,7 @@ ___ ### AdminPostDraftOrdersDraftOrderRegisterPaymentRes -Ƭ **AdminPostDraftOrdersDraftOrderRegisterPaymentRes**: `Object` + **AdminPostDraftOrdersDraftOrderRegisterPaymentRes**: `Object` #### Schema @@ -2500,7 +2500,7 @@ ___ ### AdminPriceListDeleteBatchRes -Ƭ **AdminPriceListDeleteBatchRes**: `Object` + **AdminPriceListDeleteBatchRes**: `Object` #### Schema @@ -2558,7 +2558,7 @@ ___ ### AdminPriceListDeleteProductPricesRes -Ƭ **AdminPriceListDeleteProductPricesRes**: [`AdminPriceListDeleteBatchRes`](admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres) + **AdminPriceListDeleteProductPricesRes**: [`AdminPriceListDeleteBatchRes`](admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres) #### Schema @@ -2587,7 +2587,7 @@ ___ ### AdminPriceListDeleteRes -Ƭ **AdminPriceListDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminPriceListDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -2614,7 +2614,7 @@ ___ ### AdminPriceListDeleteVariantPricesRes -Ƭ **AdminPriceListDeleteVariantPricesRes**: [`AdminPriceListDeleteBatchRes`](admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres) + **AdminPriceListDeleteVariantPricesRes**: [`AdminPriceListDeleteBatchRes`](admin_discounts.internal.internal.mdx#adminpricelistdeletebatchres) #### Schema @@ -2643,7 +2643,7 @@ ___ ### AdminPriceListRes -Ƭ **AdminPriceListRes**: `Object` + **AdminPriceListRes**: `Object` #### Schema @@ -2666,7 +2666,7 @@ ___ ### AdminPriceListsListRes -Ƭ **AdminPriceListsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `price_lists`: [`PriceList`](../classes/admin_collections.internal.PriceList.mdx)[] } + **AdminPriceListsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `price_lists`: [`PriceList`](../classes/admin_collections.internal.PriceList.mdx)[] } #### Schema @@ -2676,7 +2676,7 @@ ___ ### AdminPriceListsProductsListRes -Ƭ **AdminPriceListsProductsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `products`: [`Product`](../classes/admin_collections.internal.Product.mdx)[] } + **AdminPriceListsProductsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `products`: [`Product`](../classes/admin_collections.internal.Product.mdx)[] } #### Schema @@ -2686,7 +2686,7 @@ ___ ### AdminProductCategoriesCategoryDeleteRes -Ƭ **AdminProductCategoriesCategoryDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminProductCategoriesCategoryDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -2713,7 +2713,7 @@ ___ ### AdminProductCategoriesCategoryRes -Ƭ **AdminProductCategoriesCategoryRes**: `Object` + **AdminProductCategoriesCategoryRes**: `Object` #### Schema @@ -2736,7 +2736,7 @@ ___ ### AdminProductCategoriesListRes -Ƭ **AdminProductCategoriesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_categories`: [`ProductCategory`](../classes/admin_collections.internal.ProductCategory.mdx)[] } + **AdminProductCategoriesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_categories`: [`ProductCategory`](../classes/admin_collections.internal.ProductCategory.mdx)[] } #### Schema @@ -2746,7 +2746,7 @@ ___ ### AdminProductTagsListRes -Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/admin_collections.internal.ProductTag.mdx)[] } + **AdminProductTagsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/admin_collections.internal.ProductTag.mdx)[] } #### Schema @@ -2756,7 +2756,7 @@ ___ ### AdminProductTypesListRes -Ƭ **AdminProductTypesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_types`: [`ProductType`](../classes/admin_collections.internal.ProductType.mdx)[] } + **AdminProductTypesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_types`: [`ProductType`](../classes/admin_collections.internal.ProductType.mdx)[] } #### Schema @@ -2787,7 +2787,7 @@ ___ ### AdminProductsDeleteOptionRes -Ƭ **AdminProductsDeleteOptionRes**: `Object` + **AdminProductsDeleteOptionRes**: `Object` #### Schema @@ -2866,7 +2866,7 @@ ___ ### AdminProductsDeleteRes -Ƭ **AdminProductsDeleteRes**: `Object` + **AdminProductsDeleteRes**: `Object` #### Schema @@ -2922,7 +2922,7 @@ ___ ### AdminProductsDeleteVariantRes -Ƭ **AdminProductsDeleteVariantRes**: `Object` + **AdminProductsDeleteVariantRes**: `Object` #### Schema @@ -3001,7 +3001,7 @@ ___ ### AdminProductsListRes -Ƭ **AdminProductsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `products`: ([`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct) \| [`Product`](../classes/admin_collections.internal.Product.mdx))[] } + **AdminProductsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `products`: ([`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct) \| [`Product`](../classes/admin_collections.internal.Product.mdx))[] } #### Schema @@ -3045,7 +3045,7 @@ ___ ### AdminProductsListTagsRes -Ƭ **AdminProductsListTagsRes**: `Object` + **AdminProductsListTagsRes**: `Object` #### Schema @@ -3091,7 +3091,7 @@ ___ ### AdminProductsListTypesRes -Ƭ **AdminProductsListTypesRes**: `Object` + **AdminProductsListTypesRes**: `Object` #### Schema @@ -3123,7 +3123,7 @@ ___ ### AdminProductsListVariantsRes -Ƭ **AdminProductsListVariantsRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/admin_collections.internal.ProductVariant.mdx)[] } + **AdminProductsListVariantsRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/admin_collections.internal.ProductVariant.mdx)[] } #### Schema @@ -3154,7 +3154,7 @@ ___ ### AdminProductsRes -Ƭ **AdminProductsRes**: `Object` + **AdminProductsRes**: `Object` #### Schema @@ -3195,7 +3195,7 @@ ___ ### AdminPublishableApiKeyDeleteRes -Ƭ **AdminPublishableApiKeyDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminPublishableApiKeyDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -3222,7 +3222,7 @@ ___ ### AdminPublishableApiKeysListRes -Ƭ **AdminPublishableApiKeysListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `publishable_api_keys`: [`PublishableApiKey`](../classes/admin_discounts.internal.internal.PublishableApiKey.mdx)[] } + **AdminPublishableApiKeysListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `publishable_api_keys`: [`PublishableApiKey`](../classes/admin_discounts.internal.internal.PublishableApiKey.mdx)[] } #### Schema @@ -3232,7 +3232,7 @@ ___ ### AdminPublishableApiKeysListSalesChannelsRes -Ƭ **AdminPublishableApiKeysListSalesChannelsRes**: `Object` + **AdminPublishableApiKeysListSalesChannelsRes**: `Object` #### Schema @@ -3255,7 +3255,7 @@ ___ ### AdminPublishableApiKeysRes -Ƭ **AdminPublishableApiKeysRes**: `Object` + **AdminPublishableApiKeysRes**: `Object` #### Schema @@ -3278,7 +3278,7 @@ ___ ### AdminRefundRes -Ƭ **AdminRefundRes**: `Object` + **AdminRefundRes**: `Object` #### Schema @@ -3301,7 +3301,7 @@ ___ ### AdminRegionsDeleteRes -Ƭ **AdminRegionsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminRegionsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -3328,7 +3328,7 @@ ___ ### AdminRegionsListRes -Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `regions`: [`Region`](../classes/admin_collections.internal.Region.mdx)[] } + **AdminRegionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `regions`: [`Region`](../classes/admin_collections.internal.Region.mdx)[] } #### Schema @@ -3338,7 +3338,7 @@ ___ ### AdminReservationsDeleteRes -Ƭ **AdminReservationsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminReservationsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -3365,7 +3365,7 @@ ___ ### AdminReservationsListRes -Ƭ **AdminReservationsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `reservations`: [`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[] } + **AdminReservationsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `reservations`: [`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto)[] } #### Schema @@ -3396,7 +3396,7 @@ ___ ### AdminReservationsRes -Ƭ **AdminReservationsRes**: `Object` + **AdminReservationsRes**: `Object` #### Schema @@ -3426,7 +3426,7 @@ ___ ### AdminReturnReasonsDeleteRes -Ƭ **AdminReturnReasonsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminReturnReasonsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -3453,7 +3453,7 @@ ___ ### AdminReturnReasonsListRes -Ƭ **AdminReturnReasonsListRes**: `Object` + **AdminReturnReasonsListRes**: `Object` #### Schema @@ -3489,7 +3489,7 @@ ___ ### AdminReturnReasonsRes -Ƭ **AdminReturnReasonsRes**: `Object` + **AdminReturnReasonsRes**: `Object` #### Schema @@ -3523,7 +3523,7 @@ ___ ### AdminReturnsCancelRes -Ƭ **AdminReturnsCancelRes**: `Object` + **AdminReturnsCancelRes**: `Object` #### Schema @@ -3601,7 +3601,7 @@ ___ ### AdminReturnsListRes -Ƭ **AdminReturnsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `returns`: [`Return`](../classes/admin_collections.internal.Return.mdx)[] } + **AdminReturnsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `returns`: [`Return`](../classes/admin_collections.internal.Return.mdx)[] } #### Schema @@ -3637,7 +3637,7 @@ ___ ### AdminReturnsRes -Ƭ **AdminReturnsRes**: `Object` + **AdminReturnsRes**: `Object` #### Schema @@ -3671,7 +3671,7 @@ ___ ### AdminSalesChannelsDeleteLocationRes -Ƭ **AdminSalesChannelsDeleteLocationRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminSalesChannelsDeleteLocationRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -3698,7 +3698,7 @@ ___ ### AdminSalesChannelsDeleteRes -Ƭ **AdminSalesChannelsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminSalesChannelsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -3725,7 +3725,7 @@ ___ ### AdminSalesChannelsListRes -Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/admin_collections.internal.SalesChannel.mdx)[] } + **AdminSalesChannelsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/admin_collections.internal.SalesChannel.mdx)[] } #### Schema @@ -3735,7 +3735,7 @@ ___ ### AdminSalesChannelsRes -Ƭ **AdminSalesChannelsRes**: `Object` + **AdminSalesChannelsRes**: `Object` #### Schema @@ -3765,7 +3765,7 @@ ___ ### AdminShippingOptionsDeleteRes -Ƭ **AdminShippingOptionsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminShippingOptionsDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -3792,7 +3792,7 @@ ___ ### AdminShippingOptionsListRes -Ƭ **AdminShippingOptionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/admin_collections.internal.ShippingOption.mdx)[] } + **AdminShippingOptionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/admin_collections.internal.ShippingOption.mdx)[] } #### Schema @@ -3802,7 +3802,7 @@ ___ ### AdminShippingOptionsRes -Ƭ **AdminShippingOptionsRes**: `Object` + **AdminShippingOptionsRes**: `Object` #### Schema @@ -3825,7 +3825,7 @@ ___ ### AdminShippingProfilesListRes -Ƭ **AdminShippingProfilesListRes**: `Object` + **AdminShippingProfilesListRes**: `Object` #### Schema @@ -3857,7 +3857,7 @@ ___ ### AdminShippingProfilesRes -Ƭ **AdminShippingProfilesRes**: `Object` + **AdminShippingProfilesRes**: `Object` #### Schema @@ -3892,7 +3892,7 @@ ___ ### AdminStockLocationsDeleteRes -Ƭ **AdminStockLocationsDeleteRes**: [`DeleteResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#deleteresponse) + **AdminStockLocationsDeleteRes**: [`DeleteResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#deleteresponse) #### Schema @@ -3919,7 +3919,7 @@ ___ ### AdminStockLocationsListRes -Ƭ **AdminStockLocationsListRes**: [`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `stock_locations`: [`StockLocationExpandedDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationexpandeddto)[] } + **AdminStockLocationsListRes**: [`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `stock_locations`: [`StockLocationExpandedDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationexpandeddto)[] } #### Schema @@ -3949,7 +3949,7 @@ ___ ### AdminStockLocationsRes -Ƭ **AdminStockLocationsRes**: `Object` + **AdminStockLocationsRes**: `Object` #### Schema @@ -3972,7 +3972,7 @@ ___ ### AdminStoresRes -Ƭ **AdminStoresRes**: `Object` + **AdminStoresRes**: `Object` #### Schema @@ -4002,7 +4002,7 @@ ___ ### AdminSwapsListRes -Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `swaps`: [`Swap`](../classes/admin_collections.internal.Swap.mdx)[] } + **AdminSwapsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `swaps`: [`Swap`](../classes/admin_collections.internal.Swap.mdx)[] } #### Schema @@ -4012,7 +4012,7 @@ ___ ### AdminSwapsRes -Ƭ **AdminSwapsRes**: `Object` + **AdminSwapsRes**: `Object` #### Schema @@ -4035,7 +4035,7 @@ ___ ### AdminTaxProvidersList -Ƭ **AdminTaxProvidersList**: `Object` + **AdminTaxProvidersList**: `Object` #### Schema @@ -4067,7 +4067,7 @@ ___ ### AdminTaxRatesDeleteRes -Ƭ **AdminTaxRatesDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) + **AdminTaxRatesDeleteRes**: [`DeleteResponse`](admin_discounts.internal.internal.mdx#deleteresponse) #### Schema @@ -4094,7 +4094,7 @@ ___ ### AdminTaxRatesListRes -Ƭ **AdminTaxRatesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/admin_collections.internal.TaxRate.mdx)[] } + **AdminTaxRatesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/admin_collections.internal.TaxRate.mdx)[] } #### Schema @@ -4104,7 +4104,7 @@ ___ ### AdminTaxRatesRes -Ƭ **AdminTaxRatesRes**: `Object` + **AdminTaxRatesRes**: `Object` #### Schema @@ -4127,7 +4127,7 @@ ___ ### AdminUploadsDownloadUrlRes -Ƭ **AdminUploadsDownloadUrlRes**: `Object` + **AdminUploadsDownloadUrlRes**: `Object` #### Schema @@ -4157,7 +4157,7 @@ ___ ### AdminUploadsRes -Ƭ **AdminUploadsRes**: `Object` + **AdminUploadsRes**: `Object` #### Schema @@ -4180,7 +4180,7 @@ ___ ### AdminUserRes -Ƭ **AdminUserRes**: `Object` + **AdminUserRes**: `Object` #### Schema @@ -4203,7 +4203,7 @@ ___ ### AdminUsersListRes -Ƭ **AdminUsersListRes**: `Object` + **AdminUsersListRes**: `Object` #### Schema @@ -4226,7 +4226,7 @@ ___ ### AdminVariantsListRes -Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `variants`: [`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[] } + **AdminVariantsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `variants`: [`PricedVariant`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedvariant)[] } #### Schema @@ -4236,7 +4236,7 @@ ___ ### AdminVariantsRes -Ƭ **AdminVariantsRes**: `Object` + **AdminVariantsRes**: `Object` #### Schema @@ -4259,19 +4259,19 @@ ___ ### BatchJobCreateProps -Ƭ **BatchJobCreateProps**: [`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`BatchJob`](../classes/admin_batch_jobs.internal.BatchJob.mdx), ``"context"`` \| ``"type"`` \| ``"created_by"`` \| ``"dry_run"``\> + **BatchJobCreateProps**: [`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`BatchJob`](../classes/admin_batch_jobs.internal.BatchJob.mdx), ``"context"`` \| ``"type"`` \| ``"created_by"`` \| ``"dry_run"``\> ___ ### BatchJobUpdateProps -Ƭ **BatchJobUpdateProps**: [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`BatchJob`](../classes/admin_batch_jobs.internal.BatchJob.mdx), ``"context"`` \| ``"result"``\>\> + **BatchJobUpdateProps**: [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`BatchJob`](../classes/admin_batch_jobs.internal.BatchJob.mdx), ``"context"`` \| ``"result"``\>\> ___ ### CartCompletionResponse -Ƭ **CartCompletionResponse**: `Object` + **CartCompletionResponse**: `Object` #### Type declaration @@ -4298,7 +4298,7 @@ ___ ### ClassConstructor -Ƭ **ClassConstructor**<`T`\>: (...`args`: `unknown`[]) => `T` + **ClassConstructor**<`T`\>: (...`args`: `unknown`[]) => `T` #### Type parameters @@ -4315,7 +4315,7 @@ ___ #### Type declaration -• **new ClassConstructor**(`...args`): `T` +**new ClassConstructor**(`...args`): `T` ##### Parameters @@ -4340,13 +4340,13 @@ ___ ### ConfigModule -Ƭ **ConfigModule**: [`ConfigModule`](../../admin_discounts/modules/admin_discounts.internal.mdx#configmodule) + **ConfigModule**: [`ConfigModule`](../../admin_discounts/modules/admin_discounts.internal.mdx#configmodule) ___ ### Constructor -Ƭ **Constructor**<`T`\>: `Object` + **Constructor**<`T`\>: `Object` #### Type parameters @@ -4365,7 +4365,7 @@ ___ ### CreateBatchJobInput -Ƭ **CreateBatchJobInput**: `Object` + **CreateBatchJobInput**: `Object` #### Type declaration @@ -4400,7 +4400,7 @@ ___ ### CreatePriceListInput -Ƭ **CreatePriceListInput**: `Object` + **CreatePriceListInput**: `Object` #### Type declaration @@ -4483,13 +4483,13 @@ ___ ### Data -Ƭ **Data**: Record<`string`, `unknown`\> + **Data**: Record<`string`, `unknown`\> ___ ### DecoratedInventoryItemDTO -Ƭ **DecoratedInventoryItemDTO**: [`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto) & { `location_levels?`: [`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[] ; `reserved_quantity`: `number` ; `stocked_quantity`: `number` ; `variants?`: [`ProductVariant`](../classes/admin_collections.internal.ProductVariant.mdx)[] } + **DecoratedInventoryItemDTO**: [`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto) & { `location_levels?`: [`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[] ; `reserved_quantity`: `number` ; `stocked_quantity`: `number` ; `variants?`: [`ProductVariant`](../classes/admin_collections.internal.ProductVariant.mdx)[] } #### Schema @@ -4523,7 +4523,7 @@ ___ ### DeleteResponse -Ƭ **DeleteResponse**: `Object` + **DeleteResponse**: `Object` #### Type declaration @@ -4558,7 +4558,7 @@ ___ ### ExtendedFindConfig -Ƭ **ExtendedFindConfig**<`TEntity`\>: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<`FindOneOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> \| [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<`FindManyOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> & { `order?`: `FindOptionsOrder`<`TEntity`\> ; `relations?`: `FindOptionsRelations`<`TEntity`\> ; `select?`: `FindOptionsSelect`<`TEntity`\> ; `skip?`: `number` ; `take?`: `number` ; `where`: `FindOptionsWhere`<`TEntity`\> \| `FindOptionsWhere`<`TEntity`\>[] } + **ExtendedFindConfig**<`TEntity`\>: [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<`FindOneOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> \| [`Omit`](../../admin_auth/modules/admin_auth.internal.mdx#omit)<`FindManyOptions`<`TEntity`\>, ``"where"`` \| ``"relations"`` \| ``"select"``\> & { `order?`: `FindOptionsOrder`<`TEntity`\> ; `relations?`: `FindOptionsRelations`<`TEntity`\> ; `select?`: `FindOptionsSelect`<`TEntity`\> ; `skip?`: `number` ; `take?`: `number` ; `where`: `FindOptionsWhere`<`TEntity`\> \| `FindOptionsWhere`<`TEntity`\>[] } #### Type parameters @@ -4577,7 +4577,7 @@ ___ ### ExtendedRequest -Ƭ **ExtendedRequest**<`TEntity`\>: `Request` & { `resource`: `TEntity` } + **ExtendedRequest**<`TEntity`\>: `Request` & { `resource`: `TEntity` } #### Type parameters @@ -4596,7 +4596,7 @@ ___ ### ExtendedReservationItem -Ƭ **ExtendedReservationItem**: [`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto) & { `inventory_item?`: [`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto) ; `line_item?`: [`LineItem`](../classes/admin_collections.internal.LineItem.mdx) } + **ExtendedReservationItem**: [`ReservationItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#reservationitemdto) & { `inventory_item?`: [`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto) ; `line_item?`: [`LineItem`](../classes/admin_collections.internal.LineItem.mdx) } #### Schema @@ -4617,7 +4617,7 @@ ___ ### ItemTaxCalculationLine -Ƭ **ItemTaxCalculationLine**: `Object` + **ItemTaxCalculationLine**: `Object` A line item and the tax rates that have been configured to apply to the product contained in the line item. @@ -4647,13 +4647,13 @@ ___ ### LevelWithAvailability -Ƭ **LevelWithAvailability**: [`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto) & { `available_quantity`: `number` } + **LevelWithAvailability**: [`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto) & { `available_quantity`: `number` } ___ ### Logger -Ƭ **Logger**: `Object` + **Logger**: `Object` #### Type declaration @@ -4768,23 +4768,23 @@ ___ ### MedusaContainer -Ƭ **MedusaContainer**: [`MedusaContainer`](../../admin_discounts/modules/admin_discounts.internal.mdx#medusacontainer-1) + **MedusaContainer**: [`MedusaContainer`](../../admin_discounts/modules/admin_discounts.internal.mdx#medusacontainer-1) ___ ### MedusaNextFunction -Ƭ **MedusaNextFunction**: `NextFunction` + **MedusaNextFunction**: `NextFunction` ___ ### MedusaRequestHandler -Ƭ **MedusaRequestHandler**: (`req`: [`MedusaRequest`](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx), `res`: [`MedusaResponse`](admin_discounts.internal.internal.mdx#medusaresponse), `next`: [`MedusaNextFunction`](admin_discounts.internal.internal.mdx#medusanextfunction)) => `Promise`<`void`\> \| `void` + **MedusaRequestHandler**: (`req`: [`MedusaRequest`](../interfaces/admin_discounts.internal.internal.MedusaRequest.mdx), `res`: [`MedusaResponse`](admin_discounts.internal.internal.mdx#medusaresponse), `next`: [`MedusaNextFunction`](admin_discounts.internal.internal.mdx#medusanextfunction)) => `Promise`<`void`\> \| `void` #### Type declaration -▸ (`req`, `res`, `next`): `Promise`<`void`\> \| `void` +(`req`, `res`, `next`): `Promise`<`void`\> \| `void` ##### Parameters @@ -4834,19 +4834,19 @@ ___ ### MedusaResponse -Ƭ **MedusaResponse**: `Response` + **MedusaResponse**: `Response` ___ ### MiddlewareFunction -Ƭ **MiddlewareFunction**: [`MedusaRequestHandler`](admin_discounts.internal.internal.mdx#medusarequesthandler) \| (...`args`: `any`[]) => `any` + **MiddlewareFunction**: [`MedusaRequestHandler`](admin_discounts.internal.internal.mdx#medusarequesthandler) \| (...`args`: `any`[]) => `any` ___ ### MiddlewareRoute -Ƭ **MiddlewareRoute**: `Object` + **MiddlewareRoute**: `Object` #### Type declaration @@ -4881,7 +4881,7 @@ ___ ### MiddlewaresConfig -Ƭ **MiddlewaresConfig**: `Object` + **MiddlewaresConfig**: `Object` #### Type declaration @@ -4900,7 +4900,7 @@ ___ ### PartialPick -Ƭ **PartialPick**<`T`, `K`\>: { [P in K]?: T[P] } + **PartialPick**<`T`, `K`\>: { [P in K]?: T[P] } #### Type parameters @@ -4927,7 +4927,7 @@ ___ ### PaymentContext -Ƭ **PaymentContext**: `Object` + **PaymentContext**: `Object` #### Type declaration @@ -5034,13 +5034,13 @@ ___ ### PaymentData -Ƭ **PaymentData**: [`Data`](admin_discounts.internal.internal.mdx#data) + **PaymentData**: [`Data`](admin_discounts.internal.internal.mdx#data) ___ ### PaymentProcessorContext -Ƭ **PaymentProcessorContext**: `Object` + **PaymentProcessorContext**: `Object` #### Type declaration @@ -5115,7 +5115,7 @@ ___ ### PaymentProcessorSessionResponse -Ƭ **PaymentProcessorSessionResponse**: `Object` + **PaymentProcessorSessionResponse**: `Object` #### Type declaration @@ -5150,13 +5150,13 @@ ___ ### PaymentSessionData -Ƭ **PaymentSessionData**: [`Data`](admin_discounts.internal.internal.mdx#data) + **PaymentSessionData**: [`Data`](admin_discounts.internal.internal.mdx#data) ___ ### PaymentSessionResponse -Ƭ **PaymentSessionResponse**: `Object` + **PaymentSessionResponse**: `Object` #### Type declaration @@ -5191,7 +5191,7 @@ ___ ### PriceListLoadConfig -Ƭ **PriceListLoadConfig**: `Object` + **PriceListLoadConfig**: `Object` #### Type declaration @@ -5242,7 +5242,7 @@ ___ ### PriceListPriceCreateInput -Ƭ **PriceListPriceCreateInput**: `Object` + **PriceListPriceCreateInput**: `Object` #### Type declaration @@ -5301,7 +5301,7 @@ ___ ### PriceListPriceUpdateInput -Ƭ **PriceListPriceUpdateInput**: `Object` + **PriceListPriceUpdateInput**: `Object` #### Type declaration @@ -5368,7 +5368,7 @@ ___ ### PriceSelectionContext -Ƭ **PriceSelectionContext**: `Object` + **PriceSelectionContext**: `Object` #### Type declaration @@ -5443,7 +5443,7 @@ ___ ### PriceSelectionResult -Ƭ **PriceSelectionResult**: `Object` + **PriceSelectionResult**: `Object` #### Type declaration @@ -5502,13 +5502,13 @@ ___ ### PriceType -Ƭ **PriceType**: [`DefaultPriceType`](../enums/admin_discounts.internal.DefaultPriceType.mdx) \| [`PriceListType`](../enums/admin_collections.internal.PriceListType.mdx) + **PriceType**: [`DefaultPriceType`](../enums/admin_discounts.internal.DefaultPriceType.mdx) \| [`PriceListType`](../enums/admin_collections.internal.PriceListType.mdx) ___ ### QueryConfig -Ƭ **QueryConfig**<`TEntity`\>: `Object` + **QueryConfig**<`TEntity`\>: `Object` #### Type parameters @@ -5580,7 +5580,7 @@ ___ ### QuerySelector -Ƭ **QuerySelector**<`TEntity`\>: [`Selector`](admin_discounts.internal.internal.mdx#selector)<`TEntity`\> & { `q?`: `string` } + **QuerySelector**<`TEntity`\>: [`Selector`](admin_discounts.internal.internal.mdx#selector)<`TEntity`\> & { `q?`: `string` } #### Type parameters @@ -5599,7 +5599,7 @@ ___ ### RequestQueryFields -Ƭ **RequestQueryFields**: `Object` + **RequestQueryFields**: `Object` #### Type declaration @@ -5650,7 +5650,7 @@ ___ ### ResponseInventoryItem -Ƭ **ResponseInventoryItem**: [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> & { `location_levels?`: [`LevelWithAvailability`](admin_discounts.internal.internal.mdx#levelwithavailability)[] } + **ResponseInventoryItem**: [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)\> & { `location_levels?`: [`LevelWithAvailability`](admin_discounts.internal.internal.mdx#levelwithavailability)[] } #### Schema @@ -5677,7 +5677,7 @@ ___ ### Selector -Ƭ **Selector**<`TEntity`\>: { [key in keyof TEntity]?: TEntity[key] \| TEntity[key][] \| DateComparisonOperator \| StringComparisonOperator \| NumericalComparisonOperator \| FindOperator } + **Selector**<`TEntity`\>: { [key in keyof TEntity]?: TEntity[key] \| TEntity[key][] \| DateComparisonOperator \| StringComparisonOperator \| NumericalComparisonOperator \| FindOperator } #### Type parameters @@ -5696,7 +5696,7 @@ ___ ### ShippingTaxCalculationLine -Ƭ **ShippingTaxCalculationLine**: `Object` + **ShippingTaxCalculationLine**: `Object` A shipping method and the tax rates that have been configured to apply to the shipping method. @@ -5726,7 +5726,7 @@ ___ ### StoreAuthRes -Ƭ **StoreAuthRes**: `Object` + **StoreAuthRes**: `Object` #### Schema @@ -5749,7 +5749,7 @@ ___ ### StoreBearerAuthRes -Ƭ **StoreBearerAuthRes**: `Object` + **StoreBearerAuthRes**: `Object` #### Schema @@ -5777,7 +5777,7 @@ ___ ### StoreCartShippingOptionsListRes -Ƭ **StoreCartShippingOptionsListRes**: `Object` + **StoreCartShippingOptionsListRes**: `Object` #### Schema @@ -5800,7 +5800,7 @@ ___ ### StoreCartsRes -Ƭ **StoreCartsRes**: `Object` + **StoreCartsRes**: `Object` #### Schema @@ -5823,7 +5823,7 @@ ___ ### StoreCollectionsListRes -Ƭ **StoreCollectionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/admin_collections.internal.ProductCollection.mdx)[] } + **StoreCollectionsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/admin_collections.internal.ProductCollection.mdx)[] } #### Schema @@ -5833,7 +5833,7 @@ ___ ### StoreCollectionsRes -Ƭ **StoreCollectionsRes**: `Object` + **StoreCollectionsRes**: `Object` #### Schema @@ -5856,7 +5856,7 @@ ___ ### StoreCompleteCartRes -Ƭ **StoreCompleteCartRes**: { `data`: [`Cart`](../classes/admin_collections.internal.Cart.mdx) ; `type`: ``"cart"`` } \| { `data`: [`Order`](../classes/admin_collections.internal.Order.mdx) ; `type`: ``"order"`` } \| { `data`: [`Swap`](../classes/admin_collections.internal.Swap.mdx) ; `type`: ``"swap"`` } + **StoreCompleteCartRes**: { `data`: [`Cart`](../classes/admin_collections.internal.Cart.mdx) ; `type`: ``"cart"`` } \| { `data`: [`Order`](../classes/admin_collections.internal.Order.mdx) ; `type`: ``"order"`` } \| { `data`: [`Swap`](../classes/admin_collections.internal.Swap.mdx) ; `type`: ``"swap"`` } #### Schema @@ -5893,7 +5893,7 @@ ___ ### StoreCustomersListOrdersRes -Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `orders`: [`Order`](../classes/admin_collections.internal.Order.mdx)[] } + **StoreCustomersListOrdersRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `orders`: [`Order`](../classes/admin_collections.internal.Order.mdx)[] } #### Schema @@ -5903,7 +5903,7 @@ ___ ### StoreCustomersListPaymentMethodsRes -Ƭ **StoreCustomersListPaymentMethodsRes**: `Object` + **StoreCustomersListPaymentMethodsRes**: `Object` #### Schema @@ -5926,7 +5926,7 @@ ___ ### StoreCustomersRes -Ƭ **StoreCustomersRes**: `Object` + **StoreCustomersRes**: `Object` #### Schema @@ -5949,7 +5949,7 @@ ___ ### StoreCustomersResetPasswordRes -Ƭ **StoreCustomersResetPasswordRes**: `Object` + **StoreCustomersResetPasswordRes**: `Object` #### Schema @@ -5972,7 +5972,7 @@ ___ ### StoreGetAuthEmailRes -Ƭ **StoreGetAuthEmailRes**: `Object` + **StoreGetAuthEmailRes**: `Object` #### Schema @@ -6002,7 +6002,7 @@ ___ ### StoreGetProductCategoriesCategoryRes -Ƭ **StoreGetProductCategoriesCategoryRes**: `Object` + **StoreGetProductCategoriesCategoryRes**: `Object` #### Schema @@ -6025,7 +6025,7 @@ ___ ### StoreGetProductCategoriesRes -Ƭ **StoreGetProductCategoriesRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_categories`: [`ProductCategory`](../classes/admin_collections.internal.ProductCategory.mdx)[] } + **StoreGetProductCategoriesRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_categories`: [`ProductCategory`](../classes/admin_collections.internal.ProductCategory.mdx)[] } #### Schema @@ -6035,7 +6035,7 @@ ___ ### StoreGiftCardsRes -Ƭ **StoreGiftCardsRes**: `Object` + **StoreGiftCardsRes**: `Object` #### Schema @@ -6058,7 +6058,7 @@ ___ ### StoreOrderEditsRes -Ƭ **StoreOrderEditsRes**: `Object` + **StoreOrderEditsRes**: `Object` #### Schema @@ -6081,7 +6081,7 @@ ___ ### StoreOrdersRes -Ƭ **StoreOrdersRes**: `Object` + **StoreOrdersRes**: `Object` #### Schema @@ -6104,7 +6104,7 @@ ___ ### StorePaymentCollectionsRes -Ƭ **StorePaymentCollectionsRes**: `Object` + **StorePaymentCollectionsRes**: `Object` #### Schema @@ -6127,7 +6127,7 @@ ___ ### StorePaymentCollectionsSessionRes -Ƭ **StorePaymentCollectionsSessionRes**: `Object` + **StorePaymentCollectionsSessionRes**: `Object` #### Schema @@ -6150,7 +6150,7 @@ ___ ### StorePostSearchRes -Ƭ **StorePostSearchRes**: { `hits`: `unknown`[] } & Record<`string`, `unknown`\> + **StorePostSearchRes**: { `hits`: `unknown`[] } & Record<`string`, `unknown`\> #### Schema @@ -6160,7 +6160,7 @@ ___ ### StoreProductTagsListRes -Ƭ **StoreProductTagsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/admin_collections.internal.ProductTag.mdx)[] } + **StoreProductTagsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/admin_collections.internal.ProductTag.mdx)[] } #### Schema @@ -6170,7 +6170,7 @@ ___ ### StoreProductTypesListRes -Ƭ **StoreProductTypesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_types`: [`ProductType`](../classes/admin_collections.internal.ProductType.mdx)[] } + **StoreProductTypesListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `product_types`: [`ProductType`](../classes/admin_collections.internal.ProductType.mdx)[] } #### Schema @@ -6180,7 +6180,7 @@ ___ ### StoreProductsListRes -Ƭ **StoreProductsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `products`: [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct)[] } + **StoreProductsListRes**: [`PaginatedResponse`](../../admin_batch_jobs/modules/admin_batch_jobs.internal.mdx#paginatedresponse) & { `products`: [`PricedProduct`](../../admin_discounts/modules/admin_discounts.internal.mdx#pricedproduct)[] } #### Schema @@ -6190,7 +6190,7 @@ ___ ### StoreProductsRes -Ƭ **StoreProductsRes**: `Object` + **StoreProductsRes**: `Object` #### Schema @@ -6213,7 +6213,7 @@ ___ ### StoreRegionsListRes -Ƭ **StoreRegionsListRes**: [`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `regions`: [`Region`](../classes/admin_collections.internal.Region.mdx)[] } + **StoreRegionsListRes**: [`PaginatedResponse`](../../admin_discounts/modules/admin_discounts.internal.mdx#paginatedresponse) & { `regions`: [`Region`](../classes/admin_collections.internal.Region.mdx)[] } #### Schema @@ -6223,7 +6223,7 @@ ___ ### StoreRegionsRes -Ƭ **StoreRegionsRes**: `Object` + **StoreRegionsRes**: `Object` #### Schema @@ -6246,7 +6246,7 @@ ___ ### StoreReturnReasonsListRes -Ƭ **StoreReturnReasonsListRes**: `Object` + **StoreReturnReasonsListRes**: `Object` #### Schema @@ -6269,7 +6269,7 @@ ___ ### StoreReturnReasonsRes -Ƭ **StoreReturnReasonsRes**: `Object` + **StoreReturnReasonsRes**: `Object` #### Schema @@ -6292,7 +6292,7 @@ ___ ### StoreReturnsRes -Ƭ **StoreReturnsRes**: `Object` + **StoreReturnsRes**: `Object` #### Schema @@ -6315,7 +6315,7 @@ ___ ### StoreShippingOptionsListRes -Ƭ **StoreShippingOptionsListRes**: `Object` + **StoreShippingOptionsListRes**: `Object` #### Schema @@ -6338,7 +6338,7 @@ ___ ### StoreSwapsRes -Ƭ **StoreSwapsRes**: `Object` + **StoreSwapsRes**: `Object` #### Schema @@ -6361,7 +6361,7 @@ ___ ### StoreVariantsListRes -Ƭ **StoreVariantsListRes**: `Object` + **StoreVariantsListRes**: `Object` #### Schema @@ -6384,7 +6384,7 @@ ___ ### StoreVariantsRes -Ƭ **StoreVariantsRes**: `Object` + **StoreVariantsRes**: `Object` #### Schema @@ -6407,7 +6407,7 @@ ___ ### TaxCalculationContext -Ƭ **TaxCalculationContext**: `Object` + **TaxCalculationContext**: `Object` Information relevant to a tax calculation, such as the shipping address where the items are going. @@ -6469,13 +6469,13 @@ ___ ### TotalField -Ƭ **TotalField**: ``"shipping_total"`` \| ``"discount_total"`` \| ``"tax_total"`` \| ``"refunded_total"`` \| ``"total"`` \| ``"subtotal"`` \| ``"refundable_amount"`` \| ``"gift_card_total"`` \| ``"gift_card_tax_total"`` + **TotalField**: ``"shipping_total"`` \| ``"discount_total"`` \| ``"tax_total"`` \| ``"refunded_total"`` \| ``"total"`` \| ``"subtotal"`` \| ``"refundable_amount"`` \| ``"gift_card_total"`` \| ``"gift_card_tax_total"`` ___ ### TreeQuerySelector -Ƭ **TreeQuerySelector**<`TEntity`\>: [`QuerySelector`](admin_discounts.internal.internal.mdx#queryselector)<`TEntity`\> & { `include_descendants_tree?`: `boolean` } + **TreeQuerySelector**<`TEntity`\>: [`QuerySelector`](admin_discounts.internal.internal.mdx#queryselector)<`TEntity`\> & { `include_descendants_tree?`: `boolean` } #### Type parameters @@ -6494,13 +6494,13 @@ ___ ### UpdatePriceListInput -Ƭ **UpdatePriceListInput**: [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`PriceList`](../classes/admin_collections.internal.PriceList.mdx), ``"name"`` \| ``"description"`` \| ``"starts_at"`` \| ``"ends_at"`` \| ``"status"`` \| ``"type"`` \| ``"includes_tax"``\>\> & { `customer_groups?`: { `id`: `string` }[] ; `prices?`: [`AdminPriceListPricesUpdateReq`](../classes/admin_discounts.internal.internal.AdminPriceListPricesUpdateReq.mdx)[] } + **UpdatePriceListInput**: [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<[`Pick`](../../admin_auth/modules/admin_auth.internal.mdx#pick)<[`PriceList`](../classes/admin_collections.internal.PriceList.mdx), ``"name"`` \| ``"description"`` \| ``"starts_at"`` \| ``"ends_at"`` \| ``"status"`` \| ``"type"`` \| ``"includes_tax"``\>\> & { `customer_groups?`: { `id`: `string` }[] ; `prices?`: [`AdminPriceListPricesUpdateReq`](../classes/admin_discounts.internal.internal.AdminPriceListPricesUpdateReq.mdx)[] } ___ ### VariantInventory -Ƭ **VariantInventory**: `Object` + **VariantInventory**: `Object` #### Schema @@ -6570,7 +6570,7 @@ ___ ### WithRequiredProperty -Ƭ **WithRequiredProperty**<`T`, `K`\>: `T` & { [Property in K]-?: T[Property] } + **WithRequiredProperty**<`T`, `K`\>: `T` & { [Property in K]-?: T[Property] } Utility type used to remove some optional attributes (coming from K) from a type T @@ -6599,7 +6599,7 @@ ___ ### Writable -Ƭ **Writable**<`T`\>: { -readonly [key in keyof T]: T[key] \| FindOperator \| FindOperator \| FindOperator } + **Writable**<`T`\>: { -readonly [key in keyof T]: T[key] \| FindOperator \| FindOperator \| FindOperator } #### Type parameters @@ -6618,7 +6618,7 @@ ___ ### payload -Ƭ **payload**: `Object` + **payload**: `Object` #### Type declaration @@ -6653,7 +6653,7 @@ ___ ### AvailableOrderIncludes -• `Const` **AvailableOrderIncludes**: `Object` + `Const` **AvailableOrderIncludes**: `Object` #### Type declaration @@ -6672,7 +6672,7 @@ ___ ### PriceType -• **PriceType**: `Object` + **PriceType**: `Object` #### Type declaration @@ -6707,259 +6707,259 @@ ___ ### allowedAdminProductCategoryRelations -• `Const` **allowedAdminProductCategoryRelations**: `string`[] + `Const` **allowedAdminProductCategoryRelations**: `string`[] ___ ### allowedFields -• `Const` **allowedFields**: `string`[] + `Const` **allowedFields**: `string`[] ___ ### allowedOrderIncludes -• `Const` **allowedOrderIncludes**: `string`[] + `Const` **allowedOrderIncludes**: `string`[] ___ ### allowedStoreCustomersFields -• `Const` **allowedStoreCustomersFields**: `string`[] + `Const` **allowedStoreCustomersFields**: `string`[] ___ ### allowedStoreCustomersRelations -• `Const` **allowedStoreCustomersRelations**: `string`[] + `Const` **allowedStoreCustomersRelations**: `string`[] ___ ### allowedStoreGiftCardFields -• `Const` **allowedStoreGiftCardFields**: `string`[] + `Const` **allowedStoreGiftCardFields**: `string`[] ___ ### allowedStoreGiftCardRelations -• `Const` **allowedStoreGiftCardRelations**: `string`[] + `Const` **allowedStoreGiftCardRelations**: `string`[] ___ ### allowedStoreOrdersFields -• `Const` **allowedStoreOrdersFields**: `string`[] + `Const` **allowedStoreOrdersFields**: `string`[] ___ ### allowedStoreOrdersRelations -• `Const` **allowedStoreOrdersRelations**: `string`[] + `Const` **allowedStoreOrdersRelations**: `string`[] ___ ### allowedStoreProductCategoryFields -• `Const` **allowedStoreProductCategoryFields**: `string`[] + `Const` **allowedStoreProductCategoryFields**: `string`[] ___ ### allowedStoreProductTagFields -• `Const` **allowedStoreProductTagFields**: `string`[] + `Const` **allowedStoreProductTagFields**: `string`[] ___ ### allowedStoreProductTypeFields -• `Const` **allowedStoreProductTypeFields**: `string`[] + `Const` **allowedStoreProductTypeFields**: `string`[] ___ ### allowedStoreProductsFields -• `Const` **allowedStoreProductsFields**: `string`[] + `Const` **allowedStoreProductsFields**: `string`[] ___ ### allowedStoreProductsRelations -• `Const` **allowedStoreProductsRelations**: `string`[] + `Const` **allowedStoreProductsRelations**: `string`[] ___ ### allowedStoreVariantRelations -• `Const` **allowedStoreVariantRelations**: `string`[] + `Const` **allowedStoreVariantRelations**: `string`[] ___ ### defaulPaymentCollectionRelations -• `Const` **defaulPaymentCollectionRelations**: `string`[] + `Const` **defaulPaymentCollectionRelations**: `string`[] ___ ### defaultAdminBatchFields -• `Const` **defaultAdminBatchFields**: `string`[] + `Const` **defaultAdminBatchFields**: `string`[] ___ ### defaultAdminCollectionsFields -• `Const` **defaultAdminCollectionsFields**: `string`[] + `Const` **defaultAdminCollectionsFields**: `string`[] ___ ### defaultAdminCollectionsRelations -• `Const` **defaultAdminCollectionsRelations**: `string`[] + `Const` **defaultAdminCollectionsRelations**: `string`[] ___ ### defaultAdminCustomerGroupsRelations -• `Const` **defaultAdminCustomerGroupsRelations**: `never`[] + `Const` **defaultAdminCustomerGroupsRelations**: `never`[] ___ ### defaultAdminCustomersRelations -• `Const` **defaultAdminCustomersRelations**: `string`[] + `Const` **defaultAdminCustomersRelations**: `string`[] ___ ### defaultAdminDiscountConditionFields -• `Const` **defaultAdminDiscountConditionFields**: keyof [`DiscountCondition`](../classes/admin_collections.internal.DiscountCondition.mdx)[] + `Const` **defaultAdminDiscountConditionFields**: keyof [`DiscountCondition`](../classes/admin_collections.internal.DiscountCondition.mdx)[] ___ ### defaultAdminDiscountConditionRelations -• `Const` **defaultAdminDiscountConditionRelations**: `string`[] + `Const` **defaultAdminDiscountConditionRelations**: `string`[] ___ ### defaultAdminDiscountsFields -• `Const` **defaultAdminDiscountsFields**: keyof [`Discount`](../classes/admin_collections.internal.Discount.mdx)[] + `Const` **defaultAdminDiscountsFields**: keyof [`Discount`](../classes/admin_collections.internal.Discount.mdx)[] ___ ### defaultAdminDiscountsRelations -• `Const` **defaultAdminDiscountsRelations**: `string`[] + `Const` **defaultAdminDiscountsRelations**: `string`[] ___ ### defaultAdminDraftOrdersCartFields -• `Const` **defaultAdminDraftOrdersCartFields**: keyof [`Cart`](../classes/admin_collections.internal.Cart.mdx)[] + `Const` **defaultAdminDraftOrdersCartFields**: keyof [`Cart`](../classes/admin_collections.internal.Cart.mdx)[] ___ ### defaultAdminDraftOrdersCartRelations -• `Const` **defaultAdminDraftOrdersCartRelations**: `string`[] + `Const` **defaultAdminDraftOrdersCartRelations**: `string`[] ___ ### defaultAdminDraftOrdersFields -• `Const` **defaultAdminDraftOrdersFields**: keyof [`DraftOrder`](../classes/admin_collections.internal.DraftOrder.mdx)[] + `Const` **defaultAdminDraftOrdersFields**: keyof [`DraftOrder`](../classes/admin_collections.internal.DraftOrder.mdx)[] ___ ### defaultAdminDraftOrdersRelations -• `Const` **defaultAdminDraftOrdersRelations**: `string`[] + `Const` **defaultAdminDraftOrdersRelations**: `string`[] ___ ### defaultAdminGetProductsVariantsFields -• `Const` **defaultAdminGetProductsVariantsFields**: `string`[] + `Const` **defaultAdminGetProductsVariantsFields**: `string`[] ___ ### defaultAdminGiftCardFields -• `Const` **defaultAdminGiftCardFields**: keyof [`GiftCard`](../classes/admin_collections.internal.GiftCard.mdx)[] + `Const` **defaultAdminGiftCardFields**: keyof [`GiftCard`](../classes/admin_collections.internal.GiftCard.mdx)[] ___ ### defaultAdminGiftCardRelations -• `Const` **defaultAdminGiftCardRelations**: `string`[] + `Const` **defaultAdminGiftCardRelations**: `string`[] ___ ### defaultAdminInventoryItemFields -• `Const` **defaultAdminInventoryItemFields**: keyof [`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[] + `Const` **defaultAdminInventoryItemFields**: keyof [`InventoryItemDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryitemdto)[] ___ ### defaultAdminInventoryItemRelations -• `Const` **defaultAdminInventoryItemRelations**: `never`[] + `Const` **defaultAdminInventoryItemRelations**: `never`[] ___ ### defaultAdminLocationLevelFields -• `Const` **defaultAdminLocationLevelFields**: keyof [`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[] + `Const` **defaultAdminLocationLevelFields**: keyof [`InventoryLevelDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#inventoryleveldto)[] ___ ### defaultAdminNotificationsFields -• `Const` **defaultAdminNotificationsFields**: `string`[] + `Const` **defaultAdminNotificationsFields**: `string`[] ___ ### defaultAdminNotificationsRelations -• `Const` **defaultAdminNotificationsRelations**: `string`[] + `Const` **defaultAdminNotificationsRelations**: `string`[] ___ ### defaultAdminPriceListFields -• `Const` **defaultAdminPriceListFields**: `string`[] + `Const` **defaultAdminPriceListFields**: `string`[] ___ ### defaultAdminPriceListRelations -• `Const` **defaultAdminPriceListRelations**: `string`[] + `Const` **defaultAdminPriceListRelations**: `string`[] ___ ### defaultAdminProductCategoryRelations -• `Const` **defaultAdminProductCategoryRelations**: `string`[] + `Const` **defaultAdminProductCategoryRelations**: `string`[] ___ ### defaultAdminProductFields -• `Const` **defaultAdminProductFields**: keyof [`Product`](../classes/admin_collections.internal.Product.mdx)[] + `Const` **defaultAdminProductFields**: keyof [`Product`](../classes/admin_collections.internal.Product.mdx)[] ___ ### defaultAdminProductRelations -• `Const` **defaultAdminProductRelations**: `string`[] + `Const` **defaultAdminProductRelations**: `string`[] ___ ### defaultAdminProductRemoteQueryObject -• `Const` **defaultAdminProductRemoteQueryObject**: `Object` + `Const` **defaultAdminProductRemoteQueryObject**: `Object` This is temporary. @@ -7124,199 +7124,199 @@ ___ ### defaultAdminProductTagsFields -• `Const` **defaultAdminProductTagsFields**: `string`[] + `Const` **defaultAdminProductTagsFields**: `string`[] ___ ### defaultAdminProductTagsRelations -• `Const` **defaultAdminProductTagsRelations**: `never`[] + `Const` **defaultAdminProductTagsRelations**: `never`[] ___ ### defaultAdminProductTypeFields -• `Const` **defaultAdminProductTypeFields**: `string`[] + `Const` **defaultAdminProductTypeFields**: `string`[] ___ ### defaultAdminProductTypeRelations -• `Const` **defaultAdminProductTypeRelations**: `never`[] + `Const` **defaultAdminProductTypeRelations**: `never`[] ___ ### defaultAdminRegionFields -• `Const` **defaultAdminRegionFields**: keyof [`Region`](../classes/admin_collections.internal.Region.mdx)[] + `Const` **defaultAdminRegionFields**: keyof [`Region`](../classes/admin_collections.internal.Region.mdx)[] ___ ### defaultAdminRegionRelations -• `Const` **defaultAdminRegionRelations**: `string`[] + `Const` **defaultAdminRegionRelations**: `string`[] ___ ### defaultAdminReservationRelations -• `Const` **defaultAdminReservationRelations**: `never`[] + `Const` **defaultAdminReservationRelations**: `never`[] ___ ### defaultAdminReturnReasonsFields -• `Const` **defaultAdminReturnReasonsFields**: keyof [`ReturnReason`](../classes/admin_collections.internal.ReturnReason.mdx)[] + `Const` **defaultAdminReturnReasonsFields**: keyof [`ReturnReason`](../classes/admin_collections.internal.ReturnReason.mdx)[] ___ ### defaultAdminReturnReasonsRelations -• `Const` **defaultAdminReturnReasonsRelations**: keyof [`ReturnReason`](../classes/admin_collections.internal.ReturnReason.mdx)[] + `Const` **defaultAdminReturnReasonsRelations**: keyof [`ReturnReason`](../classes/admin_collections.internal.ReturnReason.mdx)[] ___ ### defaultAdminShippingProfilesFields -• `Const` **defaultAdminShippingProfilesFields**: keyof [`ShippingProfile`](../classes/admin_collections.internal.ShippingProfile.mdx)[] + `Const` **defaultAdminShippingProfilesFields**: keyof [`ShippingProfile`](../classes/admin_collections.internal.ShippingProfile.mdx)[] ___ ### defaultAdminShippingProfilesRelations -• `Const` **defaultAdminShippingProfilesRelations**: `string`[] + `Const` **defaultAdminShippingProfilesRelations**: `string`[] ___ ### defaultAdminStockLocationFields -• `Const` **defaultAdminStockLocationFields**: keyof [`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[] + `Const` **defaultAdminStockLocationFields**: keyof [`StockLocationDTO`](../../admin_discounts/modules/admin_discounts.internal.mdx#stocklocationdto)[] ___ ### defaultAdminStockLocationRelations -• `Const` **defaultAdminStockLocationRelations**: `never`[] + `Const` **defaultAdminStockLocationRelations**: `never`[] ___ ### defaultAdminSwapFields -• `Const` **defaultAdminSwapFields**: `string`[] + `Const` **defaultAdminSwapFields**: `string`[] ___ ### defaultAdminSwapRelations -• `Const` **defaultAdminSwapRelations**: `string`[] + `Const` **defaultAdminSwapRelations**: `string`[] ___ ### defaultAdminTaxRatesFields -• `Const` **defaultAdminTaxRatesFields**: keyof [`TaxRate`](../classes/admin_collections.internal.TaxRate.mdx)[] + `Const` **defaultAdminTaxRatesFields**: keyof [`TaxRate`](../classes/admin_collections.internal.TaxRate.mdx)[] ___ ### defaultAdminTaxRatesRelations -• `Const` **defaultAdminTaxRatesRelations**: `never`[] + `Const` **defaultAdminTaxRatesRelations**: `never`[] ___ ### defaultAdminVariantFields -• `Const` **defaultAdminVariantFields**: keyof [`ProductVariant`](../classes/admin_collections.internal.ProductVariant.mdx)[] + `Const` **defaultAdminVariantFields**: keyof [`ProductVariant`](../classes/admin_collections.internal.ProductVariant.mdx)[] ___ ### defaultAdminVariantRelations -• `Const` **defaultAdminVariantRelations**: `string`[] + `Const` **defaultAdminVariantRelations**: `string`[] ___ ### defaultFields -• `Const` **defaultFields**: keyof [`ShippingOption`](../classes/admin_collections.internal.ShippingOption.mdx)[] + `Const` **defaultFields**: keyof [`ShippingOption`](../classes/admin_collections.internal.ShippingOption.mdx)[] ___ ### defaultPaymentCollectionFields -• `Const` **defaultPaymentCollectionFields**: `string`[] + `Const` **defaultPaymentCollectionFields**: `string`[] ___ ### defaultPaymentCollectionRelations -• `Const` **defaultPaymentCollectionRelations**: `string`[] + `Const` **defaultPaymentCollectionRelations**: `string`[] ___ ### defaultPaymentFields -• `Const` **defaultPaymentFields**: `string`[] + `Const` **defaultPaymentFields**: `string`[] ___ ### defaultProductCategoryFields -• `Const` **defaultProductCategoryFields**: `string`[] + `Const` **defaultProductCategoryFields**: `string`[] ___ ### defaultRelations -• `Const` **defaultRelations**: `string`[] + `Const` **defaultRelations**: `string`[] ___ ### defaultRelationsExtended -• `Const` **defaultRelationsExtended**: `string`[] + `Const` **defaultRelationsExtended**: `string`[] ___ ### defaultRelationsList -• `Const` **defaultRelationsList**: `string`[] + `Const` **defaultRelationsList**: `string`[] ___ ### defaultReservationFields -• `Const` **defaultReservationFields**: `string`[] + `Const` **defaultReservationFields**: `string`[] ___ ### defaultReturnCancelFields -• `Const` **defaultReturnCancelFields**: keyof [`Order`](../classes/admin_collections.internal.Order.mdx)[] + `Const` **defaultReturnCancelFields**: keyof [`Order`](../classes/admin_collections.internal.Order.mdx)[] ___ ### defaultReturnCancelRelations -• `Const` **defaultReturnCancelRelations**: `string`[] + `Const` **defaultReturnCancelRelations**: `string`[] ___ ### defaultStoreCartFields -• `Const` **defaultStoreCartFields**: keyof [`Cart`](../classes/admin_collections.internal.Cart.mdx)[] + `Const` **defaultStoreCartFields**: keyof [`Cart`](../classes/admin_collections.internal.Cart.mdx)[] ___ ### defaultStoreCartRelations -• `Const` **defaultStoreCartRelations**: `string`[] + `Const` **defaultStoreCartRelations**: `string`[] ___ ### defaultStoreCategoryScope -• `Const` **defaultStoreCategoryScope**: `Object` + `Const` **defaultStoreCategoryScope**: `Object` #### Type declaration @@ -7343,61 +7343,61 @@ ___ ### defaultStoreCollectionRelations -• `Const` **defaultStoreCollectionRelations**: `never`[] + `Const` **defaultStoreCollectionRelations**: `never`[] ___ ### defaultStoreCustomersFields -• `Const` **defaultStoreCustomersFields**: keyof [`Customer`](../classes/admin_collections.internal.Customer.mdx)[] + `Const` **defaultStoreCustomersFields**: keyof [`Customer`](../classes/admin_collections.internal.Customer.mdx)[] ___ ### defaultStoreCustomersRelations -• `Const` **defaultStoreCustomersRelations**: `string`[] + `Const` **defaultStoreCustomersRelations**: `string`[] ___ ### defaultStoreGiftCardFields -• `Const` **defaultStoreGiftCardFields**: keyof [`GiftCard`](../classes/admin_collections.internal.GiftCard.mdx)[] + `Const` **defaultStoreGiftCardFields**: keyof [`GiftCard`](../classes/admin_collections.internal.GiftCard.mdx)[] ___ ### defaultStoreGiftCardRelations -• `Const` **defaultStoreGiftCardRelations**: `string`[] + `Const` **defaultStoreGiftCardRelations**: `string`[] ___ ### defaultStoreOrdersFields -• `Const` **defaultStoreOrdersFields**: keyof [`Order`](../classes/admin_collections.internal.Order.mdx)[] + `Const` **defaultStoreOrdersFields**: keyof [`Order`](../classes/admin_collections.internal.Order.mdx)[] ___ ### defaultStoreOrdersRelations -• `Const` **defaultStoreOrdersRelations**: `string`[] + `Const` **defaultStoreOrdersRelations**: `string`[] ___ ### defaultStoreProductCategoryFields -• `Const` **defaultStoreProductCategoryFields**: `string`[] + `Const` **defaultStoreProductCategoryFields**: `string`[] ___ ### defaultStoreProductCategoryRelations -• `Const` **defaultStoreProductCategoryRelations**: `string`[] + `Const` **defaultStoreProductCategoryRelations**: `string`[] ___ ### defaultStoreProductRemoteQueryObject -• `Const` **defaultStoreProductRemoteQueryObject**: `Object` + `Const` **defaultStoreProductRemoteQueryObject**: `Object` This is temporary. @@ -7562,79 +7562,79 @@ ___ ### defaultStoreProductTagFields -• `Const` **defaultStoreProductTagFields**: `string`[] + `Const` **defaultStoreProductTagFields**: `string`[] ___ ### defaultStoreProductTagRelations -• `Const` **defaultStoreProductTagRelations**: `never`[] + `Const` **defaultStoreProductTagRelations**: `never`[] ___ ### defaultStoreProductTypeFields -• `Const` **defaultStoreProductTypeFields**: `string`[] + `Const` **defaultStoreProductTypeFields**: `string`[] ___ ### defaultStoreProductTypeRelations -• `Const` **defaultStoreProductTypeRelations**: `never`[] + `Const` **defaultStoreProductTypeRelations**: `never`[] ___ ### defaultStoreProductsFields -• `Const` **defaultStoreProductsFields**: keyof [`Product`](../classes/admin_collections.internal.Product.mdx)[] + `Const` **defaultStoreProductsFields**: keyof [`Product`](../classes/admin_collections.internal.Product.mdx)[] ___ ### defaultStoreProductsRelations -• `Const` **defaultStoreProductsRelations**: `string`[] + `Const` **defaultStoreProductsRelations**: `string`[] ___ ### defaultStoreReturnReasonFields -• `Const` **defaultStoreReturnReasonFields**: keyof [`ReturnReason`](../classes/admin_collections.internal.ReturnReason.mdx)[] + `Const` **defaultStoreReturnReasonFields**: keyof [`ReturnReason`](../classes/admin_collections.internal.ReturnReason.mdx)[] ___ ### defaultStoreReturnReasonRelations -• `Const` **defaultStoreReturnReasonRelations**: keyof [`ReturnReason`](../classes/admin_collections.internal.ReturnReason.mdx)[] + `Const` **defaultStoreReturnReasonRelations**: keyof [`ReturnReason`](../classes/admin_collections.internal.ReturnReason.mdx)[] ___ ### defaultStoreSwapFields -• `Const` **defaultStoreSwapFields**: [`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Swap`](../classes/admin_collections.internal.Swap.mdx)\>[``"select"``] + `Const` **defaultStoreSwapFields**: [`FindConfig`](../interfaces/admin_discounts.internal.internal.FindConfig.mdx)<[`Swap`](../classes/admin_collections.internal.Swap.mdx)\>[``"select"``] ___ ### defaultStoreSwapRelations -• `Const` **defaultStoreSwapRelations**: `string`[] + `Const` **defaultStoreSwapRelations**: `string`[] ___ ### defaultStoreVariantRelations -• `Const` **defaultStoreVariantRelations**: `string`[] + `Const` **defaultStoreVariantRelations**: `string`[] ___ ### filterableAdminOrdersFields -• `Const` **filterableAdminOrdersFields**: `string`[] + `Const` **filterableAdminOrdersFields**: `string`[] ## Functions ### DbAwareColumn -▸ **DbAwareColumn**(`columnOptions`): [`PropertyDecorator`](../../admin_discounts/modules/admin_discounts.internal.mdx#propertydecorator) +**DbAwareColumn**(`columnOptions`): [`PropertyDecorator`](../../admin_discounts/modules/admin_discounts.internal.mdx#propertydecorator) #### Parameters @@ -7668,7 +7668,7 @@ ___ ### IsType -▸ **IsType**(`types`, `validationOptions?`): (`object`: [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object), `propertyName`: `string`) => `void` +**IsType**(`types`, `validationOptions?`): (`object`: [`Object`](../../admin_discounts/modules/admin_discounts.internal.mdx#object), `propertyName`: `string`) => `void` #### Parameters @@ -7706,7 +7706,7 @@ ___ } ]} /> -▸ (`object`, `propertyName`): `void` +(`object`, `propertyName`): `void` ##### Parameters @@ -7748,7 +7748,7 @@ ___ ### addOrderToSelect -▸ **addOrderToSelect**<`TEntity`\>(`order`, `select`): `void` +**addOrderToSelect**<`TEntity`\>(`order`, `select`): `void` +**adjustInventoryForCancelledFulfillment**(`fulfillment`, `context`): `Promise`<`void`\> #### Parameters @@ -7851,7 +7851,7 @@ ___ ### authenticate -▸ **authenticate**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> +**authenticate**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> #### Returns @@ -7914,7 +7914,7 @@ ___ ### authenticateCustomer -▸ **authenticateCustomer**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> +**authenticateCustomer**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> #### Returns @@ -7977,7 +7977,7 @@ ___ ### buildLegacyFieldsListFrom -▸ **buildLegacyFieldsListFrom**<`TEntity`\>(`input?`): keyof `TEntity`[] +**buildLegacyFieldsListFrom**<`TEntity`\>(`input?`): keyof `TEntity`[] Revert new object structure of find options to the legacy structure of previous version @@ -8053,7 +8053,7 @@ ___ ### buildQuery -▸ **buildQuery**<`TWhereKeys`, `TEntity`\>(`selector`, `config?`): [`ExtendedFindConfig`](admin_discounts.internal.internal.mdx#extendedfindconfig)<`TEntity`\> +**buildQuery**<`TWhereKeys`, `TEntity`\>(`selector`, `config?`): [`ExtendedFindConfig`](admin_discounts.internal.internal.mdx#extendedfindconfig)<`TEntity`\> Used to build TypeORM queries. @@ -8116,7 +8116,7 @@ ___ ### calculatePriceTaxAmount -▸ **calculatePriceTaxAmount**(`«destructured»`): `number` +**calculatePriceTaxAmount**(`«destructured»`): `number` Return the tax amount that - is includes in the price if it is tax inclusive @@ -8178,7 +8178,7 @@ ___ ### canAccessBatchJob -▸ **canAccessBatchJob**(`req`, `res`, `next`): `Promise`<`any`\> +**canAccessBatchJob**(`req`, `res`, `next`): `Promise`<`any`\> #### Parameters @@ -8237,7 +8237,7 @@ ___ ### categoryMatchesScope -▸ **categoryMatchesScope**(`category`, `query`): `boolean` +**categoryMatchesScope**(`category`, `query`): `boolean` #### Parameters @@ -8279,7 +8279,7 @@ ___ ### cleanResponseData -▸ **cleanResponseData**<`T`\>(`data`, `fields`): `T` extends [] ? [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<`T`\>[] : [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<`T`\> +**cleanResponseData**<`T`\>(`data`, `fields`): `T` extends [] ? [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<`T`\>[] : [`Partial`](../../admin_discounts/modules/admin_discounts.internal.mdx#partial)<`T`\> Filter response data to contain props specified in the `allowedProperties`. You can read more in the transformQuery middleware utility methods. @@ -8335,7 +8335,7 @@ ___ ### csvCellContentFormatter -▸ **csvCellContentFormatter**(`str`): `string` +**csvCellContentFormatter**(`str`): `string` #### Parameters @@ -8369,7 +8369,7 @@ ___ ### csvRevertCellContentFormatter -▸ **csvRevertCellContentFormatter**(`str`): `string` +**csvRevertCellContentFormatter**(`str`): `string` #### Parameters @@ -8403,7 +8403,7 @@ ___ ### doesConditionBelongToDiscount -▸ **doesConditionBelongToDiscount**(`req`, `res`, `next`): `Promise`<`any`\> +**doesConditionBelongToDiscount**(`req`, `res`, `next`): `Promise`<`any`\> #### Parameters @@ -8462,7 +8462,7 @@ ___ ### errorHandler -▸ **errorHandler**(): (`err`: [`MedusaError`](../classes/admin_discounts.internal.MedusaError.mdx), `req`: `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\>, `res`: `Response`<`any`, Record<`string`, `any`\>\>, `next`: `NextFunction`) => `void` +**errorHandler**(): (`err`: [`MedusaError`](../classes/admin_discounts.internal.MedusaError.mdx), `req`: `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\>, `res`: `Response`<`any`, Record<`string`, `any`\>\>, `next`: `NextFunction`) => `void` #### Returns @@ -8479,7 +8479,7 @@ ___ } ]} /> -▸ (`err`, `req`, `res`, `next`): `void` +(`err`, `req`, `res`, `next`): `void` ##### Parameters @@ -8537,7 +8537,7 @@ ___ ### extendedFindParamsMixin -▸ **extendedFindParamsMixin**(`«destructured»?`): [`ClassConstructor`](admin_discounts.internal.internal.mdx#classconstructor)<[`FindParams`](../classes/admin_customer_groups.internal.FindParams.mdx) & [`FindPaginationParams`](../classes/admin_currencies.internal.FindPaginationParams.mdx)\> +**extendedFindParamsMixin**(`«destructured»?`): [`ClassConstructor`](admin_discounts.internal.internal.mdx#classconstructor)<[`FindParams`](../classes/admin_customer_groups.internal.FindParams.mdx) & [`FindPaginationParams`](../classes/admin_currencies.internal.FindPaginationParams.mdx)\> #### Parameters @@ -8596,7 +8596,7 @@ ___ ### fetchCategoryDescendantsIds -▸ **fetchCategoryDescendantsIds**(`productCategory`, `query`): `string`[] +**fetchCategoryDescendantsIds**(`productCategory`, `query`): `string`[] #### Parameters @@ -8647,7 +8647,7 @@ ___ ### formatException -▸ **formatException**(`err`): [`MedusaError`](../classes/admin_discounts.internal.MedusaError.mdx) +**formatException**(`err`): [`MedusaError`](../classes/admin_discounts.internal.MedusaError.mdx) #### Parameters @@ -8681,7 +8681,7 @@ ___ ### generateEntityId -▸ **generateEntityId**(`idProperty`, `prefix?`): `string` +**generateEntityId**(`idProperty`, `prefix?`): `string` Generate a composed id based on the input parameters and return either the is if it exists or the generated one. @@ -8725,7 +8725,7 @@ ___ ### getRequestedBatchJob -▸ **getRequestedBatchJob**(`req`, `res`, `next`): `Promise`<`any`\> +**getRequestedBatchJob**(`req`, `res`, `next`): `Promise`<`any`\> #### Parameters @@ -8784,7 +8784,7 @@ ___ ### hasChanges -▸ **hasChanges**<`T1`, `T2`\>(`obj1`, `obj2`): `boolean` +**hasChanges**<`T1`, `T2`\>(`obj1`, `obj2`): `boolean` Compare two objects and return true if there is changes detected from obj2 compared to obj1 @@ -8847,7 +8847,7 @@ ___ ### isBatchJobStrategy -▸ **isBatchJobStrategy**(`object`): object is IBatchJobStrategy +**isBatchJobStrategy**(`object`): object is IBatchJobStrategy #### Parameters @@ -8881,7 +8881,7 @@ ___ ### isCartCompletionStrategy -▸ **isCartCompletionStrategy**(`obj`): `boolean` +**isCartCompletionStrategy**(`obj`): `boolean` #### Parameters @@ -8915,7 +8915,7 @@ ___ ### isDate -▸ **isDate**(`value`): value is Date +**isDate**(`value`): value is Date #### Parameters @@ -8949,7 +8949,7 @@ ___ ### isFileService -▸ **isFileService**(`object`): `boolean` +**isFileService**(`object`): `boolean` #### Parameters @@ -8983,7 +8983,7 @@ ___ ### isNotificationService -▸ **isNotificationService**(`obj`): `boolean` +**isNotificationService**(`obj`): `boolean` #### Parameters @@ -9017,7 +9017,7 @@ ___ ### isObject -▸ **isObject**(`obj`): obj is object +**isObject**(`obj`): obj is object #### Parameters @@ -9051,7 +9051,7 @@ ___ ### isPaymentProcessor -▸ **isPaymentProcessor**(`obj`): `boolean` +**isPaymentProcessor**(`obj`): `boolean` Return if the input object is AbstractPaymentProcessor @@ -9087,7 +9087,7 @@ ___ ### isPaymentProcessorError -▸ **isPaymentProcessorError**(`obj`): obj is PaymentProcessorError +**isPaymentProcessorError**(`obj`): obj is PaymentProcessorError Utility function to determine if an object is a processor error @@ -9123,7 +9123,7 @@ ___ ### isPaymentService -▸ **isPaymentService**(`obj`): `boolean` +**isPaymentService**(`obj`): `boolean` Return if the input object is one of AbstractPaymentService or PaymentService or AbstractPaymentPluginService @@ -9159,7 +9159,7 @@ ___ ### isPriceSelectionStrategy -▸ **isPriceSelectionStrategy**(`object`): object is IPriceSelectionStrategy +**isPriceSelectionStrategy**(`object`): object is IPriceSelectionStrategy #### Parameters @@ -9193,7 +9193,7 @@ ___ ### isString -▸ **isString**(`val`): val is string +**isString**(`val`): val is string #### Parameters @@ -9227,7 +9227,7 @@ ___ ### isTaxCalculationStrategy -▸ **isTaxCalculationStrategy**(`object`): object is ITaxCalculationStrategy +**isTaxCalculationStrategy**(`object`): object is ITaxCalculationStrategy #### Parameters @@ -9261,7 +9261,7 @@ ___ ### normalizeQuery -▸ **normalizeQuery**(): (`req`: `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\>, `res`: `Response`<`any`, Record<`string`, `any`\>\>, `next`: `NextFunction`) => `void` +**normalizeQuery**(): (`req`: `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\>, `res`: `Response`<`any`, Record<`string`, `any`\>\>, `next`: `NextFunction`) => `void` Normalize an input query, especially from array like query params to an array type e.g: /admin/orders/?fields[]=id,status,cart_id becomes { fields: ["id", "status", "cart_id"] } @@ -9281,7 +9281,7 @@ e.g: /admin/orders/?fields[]=id,status,cart_id becomes { fields: ["id", "status" } ]} /> -▸ (`req`, `res`, `next`): `void` +(`req`, `res`, `next`): `void` ##### Parameters @@ -9331,7 +9331,7 @@ ___ ### nullableValue -▸ **nullableValue**(`value`): `FindOperator`<`any`\> +**nullableValue**(`value`): `FindOperator`<`any`\> #### Parameters @@ -9374,7 +9374,7 @@ ___ ### omitDeep -▸ **omitDeep**<`T`\>(`input`, `excludes`): `T` +**omitDeep**<`T`\>(`input`, `excludes`): `T` `Promise`<`any`\> +**remoteQueryFetchData**(`container`): (`expand`: `any`, `keyField`: `any`, `ids`: `any`, `relationship`: `any`) => `Promise`<`any`\> #### Parameters @@ -9501,7 +9501,7 @@ ___ } ]} /> -▸ (`expand`, `keyField`, `ids`, `relationship`): `Promise`<`any`\> +(`expand`, `keyField`, `ids`, `relationship`): `Promise`<`any`\> ##### Parameters @@ -9568,7 +9568,7 @@ ___ ### removeUndefinedProperties -▸ **removeUndefinedProperties**<`T`\>(`inputObj`): `T` +**removeUndefinedProperties**<`T`\>(`inputObj`): `T` \> +**requireCustomerAuthentication**(): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> #### Returns @@ -9667,7 +9667,7 @@ ___ ### reserveQuantityForDraftOrder -▸ **reserveQuantityForDraftOrder**(`order`, `context`): `Promise`<`void`\> +**reserveQuantityForDraftOrder**(`order`, `context`): `Promise`<`void`\> #### Parameters @@ -9725,7 +9725,7 @@ ___ ### resolveDbGenerationStrategy -▸ **resolveDbGenerationStrategy**(`pgSqlType`): ``"increment"`` \| ``"uuid"`` \| ``"rowid"`` +**resolveDbGenerationStrategy**(`pgSqlType`): ``"increment"`` \| ``"uuid"`` \| ``"rowid"`` #### Parameters @@ -9759,7 +9759,7 @@ ___ ### resolveDbType -▸ **resolveDbType**(`pgSqlType`): `ColumnType` +**resolveDbType**(`pgSqlType`): `ColumnType` #### Parameters @@ -9784,7 +9784,7 @@ ___ ### setMetadata -▸ **setMetadata**(`obj`, `metadata`): Record<`string`, `unknown`\> +**setMetadata**(`obj`, `metadata`): Record<`string`, `unknown`\> Dedicated method to set metadata. @@ -9845,7 +9845,7 @@ ___ ### transformBody -▸ **transformBody**<`T`\>(`plainToClass`, `config?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\> +**transformBody**<`T`\>(`plainToClass`, `config?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\> -▸ (`req`, `res`, `next`): `Promise`<`void`\> +(`req`, `res`, `next`): `Promise`<`void`\> ##### Parameters @@ -9944,7 +9944,7 @@ ___ ### transformIncludesOptions -▸ **transformIncludesOptions**(`allowedIncludes?`, `expectedIncludes?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `void` +**transformIncludesOptions**(`allowedIncludes?`, `expectedIncludes?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `void` Retrieve the includes options from the fields query param. If the include option is present then assigned it to includes on req @@ -9985,7 +9985,7 @@ If the include option is present then assigned it to includes on req } ]} /> -▸ (`req`, `res`, `next`): `void` +(`req`, `res`, `next`): `void` ##### Parameters @@ -10035,7 +10035,7 @@ ___ ### transformQuery -▸ **transformQuery**<`T`, `TEntity`\>(`plainToClass`, `queryConfig?`, `config?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\> +**transformQuery**<`T`, `TEntity`\>(`plainToClass`, `queryConfig?`, `config?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\> Middleware that transform the query input for the admin end points @@ -10102,7 +10102,7 @@ Middleware that transform the query input for the admin end points } ]} /> -▸ (`req`, `res`, `next`): `Promise`<`void`\> +(`req`, `res`, `next`): `Promise`<`void`\> ##### Parameters @@ -10152,7 +10152,7 @@ ___ ### transformStoreQuery -▸ **transformStoreQuery**<`T`, `TEntity`\>(`plainToClass`, `queryConfig?`, `config?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\> +**transformStoreQuery**<`T`, `TEntity`\>(`plainToClass`, `queryConfig?`, `config?`): (`req`: `Request`, `res`: `Response`, `next`: `NextFunction`) => `Promise`<`void`\> Middleware that transform the query input for the store endpoints @@ -10219,7 +10219,7 @@ Middleware that transform the query input for the store endpoints } ]} /> -▸ (`req`, `res`, `next`): `Promise`<`void`\> +(`req`, `res`, `next`): `Promise`<`void`\> ##### Parameters @@ -10269,7 +10269,7 @@ ___ ### unauthenticatedInviteRoutes -▸ **unauthenticatedInviteRoutes**(`app`): `void` +**unauthenticatedInviteRoutes**(`app`): `void` #### Parameters @@ -10303,7 +10303,7 @@ ___ ### unauthenticatedUserRoutes -▸ **unauthenticatedUserRoutes**(`app`): `void` +**unauthenticatedUserRoutes**(`app`): `void` #### Parameters @@ -10337,7 +10337,7 @@ ___ ### updateInventoryAndReservations -▸ **updateInventoryAndReservations**(`fulfillments`, `context`): `Promise`<`void`\> +**updateInventoryAndReservations**(`fulfillments`, `context`): `Promise`<`void`\> #### Parameters @@ -10395,7 +10395,7 @@ ___ ### validateId -▸ **validateId**(`rawId`, `config?`): `string` +**validateId**(`rawId`, `config?`): `string` #### Parameters @@ -10453,7 +10453,7 @@ ___ ### validator -▸ **validator**<`T`, `V`\>(`typedClass`, `plain`, `config?`): `Promise`<`T`\> +**validator**<`T`, `V`\>(`typedClass`, `plain`, `config?`): `Promise`<`T`\> \> +**wrapHandler**(`fn`): `RequestHandler`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, Record<`string`, `any`\>\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/line_items/classes/line_items.LineItemsResource.mdx b/www/apps/docs/content/references/js-client/line_items/classes/line_items.LineItemsResource.mdx index fc8ce6d479..53e674f686 100644 --- a/www/apps/docs/content/references/js-client/line_items/classes/line_items.LineItemsResource.mdx +++ b/www/apps/docs/content/references/js-client/line_items/classes/line_items.LineItemsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### create -▸ **create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> +**create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> Creates a line-item for a cart @@ -73,7 +73,7 @@ ___ ### delete -▸ **delete**(`cart_id`, `line_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> +**delete**(`cart_id`, `line_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> Remove a line-item from a cart @@ -134,7 +134,7 @@ ___ ### update -▸ **update**(`cart_id`, `line_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> +**update**(`cart_id`, `line_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCartsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecartsres)\> Updates a line-item. Only quantity updates are allowed diff --git a/www/apps/docs/content/references/js-client/order_edits/classes/order_edits.OrderEditsResource.mdx b/www/apps/docs/content/references/js-client/order_edits/classes/order_edits.OrderEditsResource.mdx index 6a21337a11..e30482379d 100644 --- a/www/apps/docs/content/references/js-client/order_edits/classes/order_edits.OrderEditsResource.mdx +++ b/www/apps/docs/content/references/js-client/order_edits/classes/order_edits.OrderEditsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### complete -▸ **complete**(`id`, `customHeaders?`): `Promise`<`any`\> +**complete**(`id`, `customHeaders?`): `Promise`<`any`\> #### Parameters @@ -63,7 +63,7 @@ ___ ### decline -▸ **decline**(`id`, `payload`, `customHeaders?`): `Promise`<`any`\> +**decline**(`id`, `payload`, `customHeaders?`): `Promise`<`any`\> #### Parameters @@ -122,7 +122,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordereditsres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrderEditsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordereditsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/orders/classes/orders.OrdersResource.mdx b/www/apps/docs/content/references/js-client/orders/classes/orders.OrdersResource.mdx index 1d8fc50e51..20628fa3d1 100644 --- a/www/apps/docs/content/references/js-client/orders/classes/orders.OrdersResource.mdx +++ b/www/apps/docs/content/references/js-client/orders/classes/orders.OrdersResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### confirmRequest -▸ **confirmRequest**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) +**confirmRequest**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) #### Parameters @@ -58,7 +58,7 @@ ___ ### lookupOrder -▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordersres)\> +**lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordersres)\> #### Parameters @@ -113,7 +113,7 @@ ___ ### requestCustomerOrders -▸ **requestCustomerOrders**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) +**requestCustomerOrders**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise) #### Parameters @@ -159,7 +159,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordersres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordersres)\> #### Parameters @@ -214,7 +214,7 @@ ___ ### retrieveByCartId -▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordersres)\> +**retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreOrdersRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeordersres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx b/www/apps/docs/content/references/js-client/payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx index cf411df13d..de935d9060 100644 --- a/www/apps/docs/content/references/js-client/payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx +++ b/www/apps/docs/content/references/js-client/payment_collections/classes/payment_collections.PaymentCollectionsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### authorizePaymentSession -▸ **authorizePaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> +**authorizePaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> #### Parameters @@ -71,7 +71,7 @@ ___ ### authorizePaymentSessionsBatch -▸ **authorizePaymentSessionsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> +**authorizePaymentSessionsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> #### Parameters @@ -130,7 +130,7 @@ ___ ### managePaymentSession -▸ **managePaymentSession**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> +**managePaymentSession**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> #### Parameters @@ -189,7 +189,7 @@ ___ ### managePaymentSessionsBatch -▸ **managePaymentSessionsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> +**managePaymentSessionsBatch**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> #### Parameters @@ -248,7 +248,7 @@ ___ ### refreshPaymentSession -▸ **refreshPaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsSessionRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionssessionres)\> +**refreshPaymentSession**(`id`, `session_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsSessionRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionssessionres)\> #### Parameters @@ -307,7 +307,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> +**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePaymentCollectionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepaymentcollectionsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource.mdx b/www/apps/docs/content/references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource.mdx index d4afe8cea7..8e24cdc071 100644 --- a/www/apps/docs/content/references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource.mdx +++ b/www/apps/docs/content/references/js-client/payment_methods/classes/payment_methods.PaymentMethodsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomerslistpaymentmethodsres)\> +**list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storecustomerslistpaymentmethodsres)\> Lists customer payment methods diff --git a/www/apps/docs/content/references/js-client/product_categories/classes/product_categories.ProductCategoriesResource.mdx b/www/apps/docs/content/references/js-client/product_categories/classes/product_categories.ProductCategoriesResource.mdx index bfa8779ce2..b82068b379 100644 --- a/www/apps/docs/content/references/js-client/product_categories/classes/product_categories.ProductCategoriesResource.mdx +++ b/www/apps/docs/content/references/js-client/product_categories/classes/product_categories.ProductCategoriesResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGetProductCategoriesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegetproductcategoriesres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGetProductCategoriesRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegetproductcategoriesres)\> #### Parameters @@ -67,7 +67,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGetProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegetproductcategoriescategoryres)\> +**retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreGetProductCategoriesCategoryRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storegetproductcategoriescategoryres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/product_tags/classes/product_tags.ProductTagsResource.mdx b/www/apps/docs/content/references/js-client/product_tags/classes/product_tags.ProductTagsResource.mdx index ca180efa01..e52c8e9b6e 100644 --- a/www/apps/docs/content/references/js-client/product_tags/classes/product_tags.ProductTagsResource.mdx +++ b/www/apps/docs/content/references/js-client/product_tags/classes/product_tags.ProductTagsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductTagsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproducttagslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductTagsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproducttagslistres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/product_types/classes/product_types.ProductTypesResource.mdx b/www/apps/docs/content/references/js-client/product_types/classes/product_types.ProductTypesResource.mdx index 31d338f635..5a84ff4184 100644 --- a/www/apps/docs/content/references/js-client/product_types/classes/product_types.ProductTypesResource.mdx +++ b/www/apps/docs/content/references/js-client/product_types/classes/product_types.ProductTypesResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductTypesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproducttypeslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductTypesListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproducttypeslistres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/product_variants/classes/product_variants.ProductVariantsResource.mdx b/www/apps/docs/content/references/js-client/product_variants/classes/product_variants.ProductVariantsResource.mdx index 196b8db234..3694102f5f 100644 --- a/www/apps/docs/content/references/js-client/product_variants/classes/product_variants.ProductVariantsResource.mdx +++ b/www/apps/docs/content/references/js-client/product_variants/classes/product_variants.ProductVariantsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreVariantsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storevariantslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreVariantsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storevariantslistres)\> #### Parameters @@ -67,7 +67,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreVariantsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storevariantsres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreVariantsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storevariantsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/products/classes/products.ProductsResource.mdx b/www/apps/docs/content/references/js-client/products/classes/products.ProductsResource.mdx index 6a30b83957..edb4e2714f 100644 --- a/www/apps/docs/content/references/js-client/products/classes/products.ProductsResource.mdx +++ b/www/apps/docs/content/references/js-client/products/classes/products.ProductsResource.mdx @@ -25,7 +25,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproductslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproductslistres)\> #### Parameters @@ -80,7 +80,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproductsres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreProductsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeproductsres)\> #### Parameters @@ -135,7 +135,7 @@ ___ ### search -▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePostSearchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepostsearchres)\> +**search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StorePostSearchRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storepostsearchres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/regions/classes/regions.RegionsResource.mdx b/www/apps/docs/content/references/js-client/regions/classes/regions.RegionsResource.mdx index eb787ae0f6..79b0dba0b7 100644 --- a/www/apps/docs/content/references/js-client/regions/classes/regions.RegionsResource.mdx +++ b/www/apps/docs/content/references/js-client/regions/classes/regions.RegionsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreRegionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeregionslistres)\> +**list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreRegionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeregionslistres)\> #### Parameters @@ -59,7 +59,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreRegionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeregionsres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreRegionsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeregionsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/return_reasons/classes/return_reasons.ReturnReasonsResource.mdx b/www/apps/docs/content/references/js-client/return_reasons/classes/return_reasons.ReturnReasonsResource.mdx index 03991af42c..30d2ecec01 100644 --- a/www/apps/docs/content/references/js-client/return_reasons/classes/return_reasons.ReturnReasonsResource.mdx +++ b/www/apps/docs/content/references/js-client/return_reasons/classes/return_reasons.ReturnReasonsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### list -▸ **list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreReturnReasonsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storereturnreasonslistres)\> +**list**(`customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreReturnReasonsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storereturnreasonslistres)\> Lists return reasons defined in Medusa Admin @@ -57,7 +57,7 @@ ___ ### retrieve -▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storereturnreasonsres)\> +**retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreReturnReasonsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storereturnreasonsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/returns/classes/returns.ReturnsResource.mdx b/www/apps/docs/content/references/js-client/returns/classes/returns.ReturnsResource.mdx index 191c8a1723..100e44fb68 100644 --- a/www/apps/docs/content/references/js-client/returns/classes/returns.ReturnsResource.mdx +++ b/www/apps/docs/content/references/js-client/returns/classes/returns.ReturnsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreReturnsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storereturnsres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreReturnsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storereturnsres)\> Creates a return request diff --git a/www/apps/docs/content/references/js-client/shipping_options/classes/shipping_options.ShippingOptionsResource.mdx b/www/apps/docs/content/references/js-client/shipping_options/classes/shipping_options.ShippingOptionsResource.mdx index a722ec342a..49ad5be9bf 100644 --- a/www/apps/docs/content/references/js-client/shipping_options/classes/shipping_options.ShippingOptionsResource.mdx +++ b/www/apps/docs/content/references/js-client/shipping_options/classes/shipping_options.ShippingOptionsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### list -▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreShippingOptionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeshippingoptionslistres)\> +**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreShippingOptionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeshippingoptionslistres)\> #### Parameters @@ -67,7 +67,7 @@ ___ ### listCartOptions -▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreShippingOptionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeshippingoptionslistres)\> +**listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../../swaps/modules/swaps.internal.mdx#responsepromise)<[`StoreShippingOptionsListRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeshippingoptionslistres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/swaps/classes/swaps.SwapsResource.mdx b/www/apps/docs/content/references/js-client/swaps/classes/swaps.SwapsResource.mdx index f393ef1fda..f75276802f 100644 --- a/www/apps/docs/content/references/js-client/swaps/classes/swaps.SwapsResource.mdx +++ b/www/apps/docs/content/references/js-client/swaps/classes/swaps.SwapsResource.mdx @@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### create -▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/swaps.internal.mdx#responsepromise)<[`StoreSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeswapsres)\> +**create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/swaps.internal.mdx#responsepromise)<[`StoreSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeswapsres)\> #### Parameters @@ -67,7 +67,7 @@ ___ ### retrieveByCartId -▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/swaps.internal.mdx#responsepromise)<[`StoreSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeswapsres)\> +**retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/swaps.internal.mdx#responsepromise)<[`StoreSwapsRes`](../../internal/modules/admin_discounts.internal.internal.mdx#storeswapsres)\> #### Parameters diff --git a/www/apps/docs/content/references/js-client/swaps/modules/swaps.internal.mdx b/www/apps/docs/content/references/js-client/swaps/modules/swaps.internal.mdx index 371eb86449..877bcc40c7 100644 --- a/www/apps/docs/content/references/js-client/swaps/modules/swaps.internal.mdx +++ b/www/apps/docs/content/references/js-client/swaps/modules/swaps.internal.mdx @@ -36,31 +36,31 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ### AxiosRequestHeaders -Ƭ **AxiosRequestHeaders**: Record<`string`, `string`\> + **AxiosRequestHeaders**: Record<`string`, `string`\> ___ ### AxiosResponseHeaders -Ƭ **AxiosResponseHeaders**: Record<`string`, `string`\> & { `set-cookie?`: `string`[] } + **AxiosResponseHeaders**: Record<`string`, `string`\> & { `set-cookie?`: `string`[] } ___ ### Method -Ƭ **Method**: ``"get"`` \| ``"GET"`` \| ``"delete"`` \| ``"DELETE"`` \| ``"head"`` \| ``"HEAD"`` \| ``"options"`` \| ``"OPTIONS"`` \| ``"post"`` \| ``"POST"`` \| ``"put"`` \| ``"PUT"`` \| ``"patch"`` \| ``"PATCH"`` \| ``"purge"`` \| ``"PURGE"`` \| ``"link"`` \| ``"LINK"`` \| ``"unlink"`` \| ``"UNLINK"`` + **Method**: ``"get"`` \| ``"GET"`` \| ``"delete"`` \| ``"DELETE"`` \| ``"head"`` \| ``"HEAD"`` \| ``"options"`` \| ``"OPTIONS"`` \| ``"post"`` \| ``"POST"`` \| ``"put"`` \| ``"PUT"`` \| ``"patch"`` \| ``"PATCH"`` \| ``"purge"`` \| ``"PURGE"`` \| ``"link"`` \| ``"LINK"`` \| ``"unlink"`` \| ``"UNLINK"`` ___ ### RequestMethod -Ƭ **RequestMethod**: ``"DELETE"`` \| ``"POST"`` \| ``"GET"`` + **RequestMethod**: ``"DELETE"`` \| ``"POST"`` \| ``"GET"`` ___ ### Response -Ƭ **Response**<`T`\>: `T` & { `response`: [`HTTPResponse`](../../internal/interfaces/swaps.internal.HTTPResponse.mdx) } + **Response**<`T`\>: `T` & { `response`: [`HTTPResponse`](../../internal/interfaces/swaps.internal.HTTPResponse.mdx) } #### Type parameters @@ -79,7 +79,7 @@ ___ ### ResponsePromise -Ƭ **ResponsePromise**<`T`\>: `Promise`<[`Response`](swaps.internal.mdx#response)<`T`\>\> + **ResponsePromise**<`T`\>: `Promise`<[`Response`](swaps.internal.mdx#response)<`T`\>\> #### Type parameters @@ -98,4 +98,4 @@ ___ ### ResponseType -Ƭ **ResponseType**: ``"arraybuffer"`` \| ``"blob"`` \| ``"document"`` \| ``"json"`` \| ``"text"`` \| ``"stream"`` + **ResponseType**: ``"arraybuffer"`` \| ``"blob"`` \| ``"document"`` \| ``"json"`` \| ``"text"`` \| ``"stream"`` diff --git a/www/apps/docs/src/components/ParameterTypes/Items/index.tsx b/www/apps/docs/src/components/ParameterTypes/Items/index.tsx index 693ae7934a..139689b0e6 100644 --- a/www/apps/docs/src/components/ParameterTypes/Items/index.tsx +++ b/www/apps/docs/src/components/ParameterTypes/Items/index.tsx @@ -47,7 +47,7 @@ const ParameterTypesItems = ({ ) : undefined } - expandable={parameter.children.length > 0} + expandable={parameter.children?.length > 0} className={clsx( getItemClassNames(false), level < 3 && "!p-1", @@ -100,7 +100,7 @@ const ParameterTypesItems = ({ {parameters.map((parameter, key) => { return ( <> - {parameter.children.length > 0 && ( + {parameter.children?.length > 0 && (
)} - {parameter.children.length === 0 && + {(parameter.children?.length || 0) === 0 && getSummary(parameter, key, false)} )