chore(docs): Generated References (#6222)

Generated the following references:
- `entities`
- `file`
- `fulfillment`
- `inventory`
- `js_client`
- `medusa`
- `medusa_config`
- `medusa_react`
- `modules`
- `notification`
- `payment`
- `price_selection`
- `pricing`
- `product`
- `search`
- `services`
- `stock_location`
- `tax`
- `tax_calculation`
- `types`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>

www/apps/docs/content/references/entities/classes/entities.Address.mdx

@@ -11,4 +11,4 @@ An address is used across the Medusa backend within other schemas and object typ
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="Address"/>

www/apps/docs/content/references/entities/classes/entities.AnalyticsConfig.mdx

@@ -9,4 +9,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"anonymize","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"opt_out","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"opt_out","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"anonymize","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="AnalyticsConfig"/>

www/apps/docs/content/references/entities/classes/entities.BatchJob.mdx

@@ -11,4 +11,4 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"context","type":"`Record<string, unknown>`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record<string, unknown>`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CREATED","type":"`\"created\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRE_PROCESSED","type":"`\"pre_processed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"chiLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"context","type":"`Record<string, unknown>`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record<string, unknown>`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CREATED","type":"`\"created\"`","description":""Line truncated

www/apps/docs/content/references/entities/classes/entities.Cart.mdx

@@ -11,4 +11,4 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The billing address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date with timezone at which the cart was completed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, unknown>`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"",Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The billing address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"discounts","type":"[Discount](entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date with timezone at which the cart was completed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, unknown>`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,Line truncated

www/apps/docs/content/references/entities/classes/entities.ClaimImage.mdx

@@ -11,4 +11,4 @@ The details of an image attached to a claim.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"claim_item","type":"[ClaimItem](entities.ClaimItem.mdx)","description":"The details of the claim item this image is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim this item belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the claim this item is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The claim item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[ClaimImage](entities.ClaimImage.mdx)[]","description":"The claim images that are attached to the claim item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item in the original order that this claim item refers to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the line item that the claim item refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"An optional note about the claim, for additional information","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ClaimReason](../enums/entities.ClaimReason.mdx)","description":"The reason for the claim","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ClaimTag](entities.ClaimTag.mdx)[]","description":"User defined tags for easy filtering and grouping.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](entities.ProductVariant.mdx)","description":"The details of the product variant to potentially replace the item in the original order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the product variant that is claimed.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim_item_id","type":"`string`","description":"The ID of the claim item associated with the image","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The claim image's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the image","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The claim image's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_item_id","type":"`string`","description":"The ID of the claim item associated with the image","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_item","type":"[ClaimItem](entities.ClaimItem.mdx)","description":"The details of the claim item this image is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The claim item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[ClaimImage](entities.ClaimImage.mdx)[]","description":"The claim images that are attached to the claim item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the claim this item is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim this item belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the line item that the claim item refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item in the original order that this claim item refers to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the product variant that is claimed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](entities.ProductVariant.mdx)","description":"The details of the product variant to potentially replace the item in the original order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"reason","type":"[ClaimReason](../enums/entities.ClaimReason.mdx)","description":"The reason for the claim","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"An optional note about the claim, for additional information","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ClaimTag](entities.ClaimTag.mdx)[]","description":"User defined tags for easy filtering and grouping.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"url","type":"`string`","description":"The URL of the image","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="ClaimImage"/>

www/apps/docs/content/references/entities/classes/entities.ClaimItem.mdx

@@ -11,4 +11,4 @@ A claim item is an item created as part of a claim. It references an item in the
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim this item belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"additional_items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The details of the new items to be shipped when the claim's type is `replace`","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the claim was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[ClaimItem](entities.ClaimItem.mdx)[]","description":"The details of the items that should be replaced or refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[ClaimFulfillmentStatus](../enums/entities.ClaimFulfillmentStatus.mdx)","description":"The claim's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](entities.Fulfillment.mdx)[]","description":"The fulfillments of the new items to be shipped","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The claim's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that this claim was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the claim comes from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[ClaimPaymentStatus](../enums/entities.ClaimPaymentStatus.mdx)","description":"The status of the claim's payment","optional":false,"defaultValue":"na","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount that will be refunded in conjunction with the claim","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](entities.Return.mdx)","description":"The details of the return associated with the claim if the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address","type":"[Address](entities.Address.mdx)","description":"The details of the address that new items should be shipped to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the address that the new items should be shipped to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods that the claim order will be shipped with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[ClaimType](../enums/entities.ClaimType.mdx)","description":"The claim's type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim_order_id","type":"`string`","description":"The ID of the claim this item is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"naLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The claim item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[ClaimImage](entities.ClaimImage.mdx)[]","description":"The claim images that are attached to the claim item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The claim image's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_item_id","type":"`string`","description":"The ID of the claim item associated with the image","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_item","type":"[ClaimItem](entities.ClaimItem.mdx)","description":"The details of the claim item this image is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"url","type":"`string`","description":"The URL of the image","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim_order_id","type":"`string`","description":"The ID of the claim this item is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim this item belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The claim's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[ClaimPaymentStatus](../enums/entities.ClaimPaymentStatus.mdx)","description":"The status of the claim's payment","optional":false,"defaultValue":"na","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[ClaimFulfillmentStatus](../enums/entities.ClaimFulfillmentStatus.mdx)","description":"The claim's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"claim_items","type":"[ClaimItem](entities.ClaimItem.mdx)[]","description":"The details of the items that should be replaced or refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"additional_items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The details of the new items to be shipped when the claim's type is `replace`","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[ClaimType](../enums/entities.ClaimType.mdx)","description":"The claim's type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the claim comes from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that this claim was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[Return](entities.Return.mdx)","description":"The details of the return associated with the claim if the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the address that the new items should be shipped to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](entities.Address.mdx)","description":"The details of the address that new items should be shipped to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](entities.ShippingMethod.mdx)[]","deLine truncated

www/apps/docs/content/references/entities/classes/entities.ClaimOrder.mdx

@@ -11,4 +11,4 @@ A Claim represents a group of faulty or missing items. It consists of claim item
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"additional_items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The details of the new items to be shipped when the claim's type is `replace`","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the claim was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[ClaimItem](entities.ClaimItem.mdx)[]","description":"The details of the items that should be replaced or refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[ClaimFulfillmentStatus](../enums/entities.ClaimFulfillmentStatus.mdx)","description":"The claim's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](entities.Fulfillment.mdx)[]","description":"The fulfillments of the new items to be shipped","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The claim's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that this claim was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the claim comes from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[ClaimPaymentStatus](../enums/entities.ClaimPaymentStatus.mdx)","description":"The status of the claim's payment","optional":false,"defaultValue":"na","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount that will be refunded in conjunction with the claim","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](entities.Return.mdx)","description":"The details of the return associated with the claim if the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address","type":"[Address](entities.Address.mdx)","description":"The details of the address that new items should be shipped to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the address that the new items should be shipped to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods that the claim order will be shipped with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[ClaimType](../enums/entities.ClaimType.mdx)","description":"The claim's type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The claim's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[ClaimPaymentStatus](../enums/entities.ClaimPaymentStatus.mdx)","description":"The status of the claim's payment","optional":false,"defaultValue":"na","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[ClaimFulfillmentStatus](../enums/entities.ClaimFulfillmentStatus.mdx)","description":"The claim's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"claim_items","type":"[ClaimItem](entities.ClaimItem.mdx)[]","description":"The details of the items that should be replaced or refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"additional_items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The details of the new items to be shipped when the claim's type is `replace`","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[ClaimType](../enums/entities.ClaimType.mdx)","description":"The claim's type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the claim comes from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that this claim was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[Return](entities.Return.mdx)","description":"The details of the return associated with the claim if the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the address that the new items should be shipped to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](entities.Address.mdx)","description":"The details of the address that new items should be shipped to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods that the claim order will be shipped with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillments","type":"[Fulfillment](entities.Fulfillment.mdx)[]","description":"The fulfillments of the new items to be shipped","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount that will be refunded in conjunction with the claim","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the claim was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="ClaimOrder"/>

www/apps/docs/content/references/entities/classes/entities.ClaimTag.mdx

@@ -11,4 +11,4 @@ Claim Tags are user defined tags that can be assigned to claim items for easy fi
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The claim tag's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the claim tag holds","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The claim tag's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the claim tag holds","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="ClaimTag"/>

www/apps/docs/content/references/entities/classes/entities.Country.mdx

@@ -11,4 +11,4 @@ Country details
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"display_name","type":"`string`","description":"The country name appropriate for display.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`number`","description":"The country's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_2","type":"`string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The normalized country name in upper case.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`number`","description":"The numerical ISO code for the country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region the country is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at whicLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`number`","description":"The country's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_2","type":"`string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`number`","description":"The numerical ISO code for the country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The normalized country name in upper case.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`string`","description":"The country name appropriate for display.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The region ID this country is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region the country is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optioLine truncated

www/apps/docs/content/references/entities/classes/entities.Currency.mdx

@@ -11,4 +11,4 @@ Currency
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="Currency"/>

www/apps/docs/content/references/entities/classes/entities.CustomShippingOption.mdx

@@ -11,4 +11,4 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart this shipping option belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The billing address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date with timezone at which the cart was completed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, unknown>`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optiLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The custom shipping option's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price","type":"`number`","description":"The custom price set that will override the shipping option's original price","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the Shipping Option that the custom shipping option overrides","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"[ShippingOption](entities.ShippingOption.mdx)","description":"The details of the overridden shipping options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The shipping option's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name given to the Shipping Option - this may be displayed to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this shipping option can be used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region this shipping option can be used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the Shipping Profile that the shipping option belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the shipping option belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)","description":"The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)","description":"The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`null` \\| `number`","description":"The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_return","type":"`boolean`","description":"Flag to indicate if the Shipping Option can be used for Return shipments.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"admin_only","type":"`boolean`","description":"Flag to indicate if the Shipping Option usage is restricted to admin users.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"requirements","type":"[ShippingOptionRequirement](entities.ShippingOptionRequirement.mdx)[]","description":"The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"data","type":"`Record<strinLine truncated

www/apps/docs/content/references/entities/classes/entities.Customer.mdx

@@ -11,4 +11,4 @@ A customer can make purchases in your store and manage their profile.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"AnLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_addresses","type":"[Address](entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":Line truncated

www/apps/docs/content/references/entities/classes/entities.CustomerGroup.mdx

@@ -11,4 +11,4 @@ A customer group that can be used to organize customers into groups of similar t
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":fLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_addresses","type":"[Address](entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"orders","type":"[Order](entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"price_lists","type":"[PriceList](entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValLine truncated

www/apps/docs/content/references/entities/classes/entities.Discount.mdx

@@ -11,4 +11,4 @@ A discount can be applied to a cart for promotional purposes.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum nuLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allocation","type":"[AllocationType](../enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","Line truncated

www/apps/docs/content/references/entities/classes/entities.DiscountCondition.mdx

@@ -11,4 +11,4 @@ Holds rule conditions for when a discount is applicable
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"Customer groups associated with this condition if `type` is `customer\\_groups`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[DiscountConditionOperator](../eLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)","description":"The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"PRODUCTS","type":"`\"products\"`","description":"The discount condition is used for products.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCT_TYPES","type":"`\"product_types\"`","description":"The discount condition is used for product types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCT_COLLECTIONS","type":"`\"product_collections\"`","description":"The discount condition is used for product collections.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCT_TAGS","type":"`\"product_tags\"`","description":"The discount condition is used for product tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CUSTOMER_GROUPS","type":"`\"customer_groups\"`","description":"The discount condition is used for customer groups.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"operator","type":"[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"IN","type":"`\"in\"`","description":"The discountable resources are within the specified resources.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_IN","type":"`\"not_in\"`","description":"The discountable resources are everything but the specified resources.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allocation","type":"[AllocationType](../enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](entities.DiscountCondition.mdx)[]","description":"The deLine truncated

www/apps/docs/content/references/entities/classes/entities.DiscountConditionCustomerGroup.mdx

@@ -11,4 +11,4 @@ Associates a discount condition with a customer group
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"condition_id","type":"`string`","description":"The ID of the Discount Condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_group_id","type":"`string`","description":"The ID of the Product Tag","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_group","type":"[CustomerGroup](entities.CustomerGroup.mdx)","description":"Available if the relation `customer\\_group` is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_condition","type":"[DiscountCondition](entities.DiscountCondition.mdx)","description":"Available if the relation `discount\\_condition` is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"Customer groups associated with this condition if `type` is `customer\\_groups`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collections","type":"[ProductCollection](entities.ProductCollection.mdx)[]","description":"Product collections associated with this condition if `type` is `product\\_collections`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_tags","type":"[ProductTag](entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":falLine truncated
+<ParameterTypes parameters={[{"name":"customer_group_id","type":"`string`","description":"The ID of the Product Tag","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"condition_id","type":"`string`","description":"The ID of the Discount Condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_group","type":"[CustomerGroup](entities.CustomerGroup.mdx)","description":"Available if the relation `customer\\_group` is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_lists","type":"[PriceList](entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_condition","type":"[DiscountCondition](entities.DiscountCondition.mdx)","description":"Available if the relation `discount\\_condition` is expanded.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)","description":"The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](Line truncated

www/apps/docs/content/references/entities/classes/entities.DiscountConditionProduct.mdx

@@ -11,4 +11,4 @@ This represents the association between a discount condition and a product
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"condition_id","type":"`string`","description":"The ID of the Discount Condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the Product Tag","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_condition","type":"[DiscountCondition](entities.DiscountCondition.mdx)","description":"The details of the discount condition.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"Customer groups associated with this condition if `type` is `customer\\_groups`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collections","type":"[ProductCollection](entities.ProductCollection.mdx)[]","description":"Product collections associated with this condition if `type` is `product\\_collections`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_tags","type":"[ProductTag](entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)","description":"The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product","type":"[Product](entities.Product.mdx)","description":"The details of the product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](entities.ProductCollection.mdx)","description":"The details of the product collection that the prodLine truncated
+<ParameterTypes parameters={[{"name":"product_id","type":"`string`","description":"The ID of the Product Tag","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"condition_id","type":"`string`","description":"The ID of the Discount Condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"[Product](entities.Product.mdx)","description":"The details of the product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"images","type":"[Image](entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariant](entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"categories","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profiles","type":"[ShippingProfile](entities.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional"Line truncated

www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductCollection.mdx

@@ -11,4 +11,4 @@ This represents the association between a discount condition and a product colle
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"condition_id","type":"`string`","description":"The ID of the Discount Condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection_id","type":"`string`","description":"The ID of the Product Collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_condition","type":"[DiscountCondition](entities.DiscountCondition.mdx)","description":"The details of the discount condition.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"Customer groups associated with this condition if `type` is `customer\\_groups`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collections","type":"[ProductCollection](entities.ProductCollection.mdx)[]","description":"Product collections associated with this condition if `type` is `product\\_collections`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_tags","type":"[ProductTag](entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)","description":"The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_collection","type":"[ProductCollection](entities.ProductCollection.mdx)","description":"The details of the product collection.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":falseLine truncated
+<ParameterTypes parameters={[{"name":"product_collection_id","type":"`string`","description":"The ID of the Product Collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"condition_id","type":"`string`","description":"The ID of the Discount Condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collection","type":"[ProductCollection](entities.ProductCollection.mdx)","description":"The details of the product collection.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"A unique string that identifies the Product Collection - can for example be used in slug structures.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_condition","type":"[DiscountCondition](entities.DiscountCondition.mdx)","description":"The details of the discount condition.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)","description":"The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","typeLine truncated

www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductTag.mdx

@@ -11,4 +11,4 @@ This represents the association between a discount condition and a product tag
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"condition_id","type":"`string`","description":"The ID of the Discount Condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_tag_id","type":"`string`","description":"The ID of the Product Tag","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_condition","type":"[DiscountCondition](entities.DiscountCondition.mdx)","description":"The details of the discount condition.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"Customer groups associated with this condition if `type` is `customer\\_groups`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collections","type":"[ProductCollection](entities.ProductCollection.mdx)[]","description":"Product collections associated with this condition if `type` is `product\\_collections`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_tags","type":"[ProductTag](entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)","description":"The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_tag","type":"[ProductTag](entities.ProductTag.mdx)","description":"The details of the product tag.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`striLine truncated
+<ParameterTypes parameters={[{"name":"product_tag_id","type":"`string`","description":"The ID of the Product Tag","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"condition_id","type":"`string`","description":"The ID of the Discount Condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_tag","type":"[ProductTag](entities.ProductTag.mdx)","description":"The details of the product tag.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product tag's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Tag represents","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_condition","type":"[DiscountCondition](entities.DiscountCondition.mdx)","description":"The details of the discount condition.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)","description":"The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_tags","type":"[ProductTag](entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_collections","type":"[ProductCollection](enLine truncated

www/apps/docs/content/references/entities/classes/entities.DiscountConditionProductType.mdx

@@ -11,4 +11,4 @@ This represents the association between a discount condition and a product type
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"condition_id","type":"`string`","description":"The ID of the Discount Condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`string`","description":"The ID of the Product Tag","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_condition","type":"[DiscountCondition](entities.DiscountCondition.mdx)","description":"The details of the discount condition.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"Customer groups associated with this condition if `type` is `customer\\_groups`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collections","type":"[ProductCollection](entities.ProductCollection.mdx)[]","description":"Product collections associated with this condition if `type` is `product\\_collections`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_tags","type":"[ProductTag](entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)","description":"The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_type","type":"[ProductType](entities.ProductType.mdx)","description":"The details of the product type.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"Line truncated
+<ParameterTypes parameters={[{"name":"product_type_id","type":"`string`","description":"The ID of the Product Tag","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"condition_id","type":"`string`","description":"The ID of the Discount Condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"[ProductType](entities.ProductType.mdx)","description":"The details of the product type.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product type's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Type represents.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_condition","type":"[DiscountCondition](entities.DiscountCondition.mdx)","description":"The details of the discount condition.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)","description":"The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_tags","type":"[ProductTag](entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_collections","type":"[ProductCollecLine truncated

www/apps/docs/content/references/entities/classes/entities.DiscountRule.mdx

@@ -11,4 +11,4 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"allocation","type":"[AllocationType](../enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"ITEM","type":"`\"item\"`","description":"The discount should be applied to applicable items in the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"TOTAL","type":"`\"total\"`","description":"The discount should be applied to the checkout total.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"conditions","type":"[DiscountCondition](entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"Customer groups associated with this condition if `type` is `customer\\_groups`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collections","type":"[ProductCollection](entities.ProductCollection.mdx)[]","description":"Product collections associated with this condition if `type` is `product\\_collections`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_tags","type":"[ProductTag](entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)","description":"The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details"Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"FIXED","type":"`\"fixed\"`","description":"Discounts that reduce the price by a fixed amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PERCENTAGE","type":"`\"percentage\"`","description":"Discounts that reduce the price by a percentage reduction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FREE_SHIPPING","type":"`\"free_shipping\"`","description":"Discounts that sets the shipping price to `0`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allocation","type":"[AllocationType](../enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"TOTAL","type":"`\"total\"`","description":"The discount should be applied to the checkout total.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ITEM","type":"`\"item\"`","description":"The discount should be applied to applicable items in the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"conditions","type":"[DiscountCondition](entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountConditionType](../enums/entities.DiscountConditionType.mdx)","description":"The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[DiscountConditionOperator](../enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"prodLine truncated

www/apps/docs/content/references/entities/classes/entities.DraftOrder.mdx

@@ -11,4 +11,4 @@ A draft order is created by an admin without direct involvement of the customer.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"canceled_at","type":"`Date`","description":"The date the draft order was canceled at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the draft order was canceled at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="DraftOrder"/>

www/apps/docs/content/references/entities/classes/entities.Fulfillment.mdx

@@ -11,4 +11,4 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the Fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"additional_items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The details of the new items to be shipped when the claim's type is `replace`","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the claim was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[ClaimItem](entities.ClaimItem.mdx)[]","description":"The details of the items that should be replaced or refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[ClaimFulfillmentStatus](../enums/entities.ClaimFulfillmentStatus.mdx)","description":"The claim's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](entities.Fulfillment.mdx)[]","description":"The fulfillments of the new items to be shipped","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The claim's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that this claim was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the claim comes from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[ClaimPaymentStatus](../enums/entities.ClaimPaymentStatus.mdx)","description":"The status of the claim's payment","optional":false,"defaultValue":"na","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount that will be refunded in conjunction with the claim","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](entities.Return.mdx)","description":"The details of the return associated with the claim if the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address","type":"[Address](entities.Address.mdx)","description":"The details of the address that new items should be shipped to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the address that the new items should be shipped to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods that the claim order will be shipped with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[ClaimType](../enums/entities.ClaimType.mdx)","description":"The claim's type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim_order_id","type":"`string`","description":"The ID of the Claim that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"childreLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The fulfillment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the Claim that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The claim's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[ClaimPaymentStatus](../enums/entities.ClaimPaymentStatus.mdx)","description":"The status of the claim's payment","optional":false,"defaultValue":"na","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[ClaimFulfillmentStatus](../enums/entities.ClaimFulfillmentStatus.mdx)","description":"The claim's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"claim_items","type":"[ClaimItem](entities.ClaimItem.mdx)[]","description":"The details of the items that should be replaced or refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"additional_items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The details of the new items to be shipped when the claim's type is `replace`","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[ClaimType](../enums/entities.ClaimType.mdx)","description":"The claim's type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the claim comes from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that this claim was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[Return](entities.Return.mdx)","description":"The details of the return associated with the claim if the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the address that the new items should be shipped to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](entities.Address.mdx)","description":"The details of the address that new items should be shipped to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods that the claim order will be shipped with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillments","type":"[Fulfillment](entities.Fulfillment.mdx)[]","description":"The fulfillments of the new items to be shipped","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount that will be refunded in conjunction with the claim","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the claim was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the coLine truncated

www/apps/docs/content/references/entities/classes/entities.FulfillmentItem.mdx

@@ -11,4 +11,4 @@ This represents the association between a Line Item and a Fulfillment.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"fulfillment","type":"[Fulfillment](entities.Fulfillment.mdx)","description":"The details of the fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the Fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the Claim that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"This contains all the data necessary for the Fulfillment provider to handle the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The fulfillment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the fulfillment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItem](entities.FulfillmentItem.mdx)[]","description":"The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"location_id","type":"`null` \\| `string`","description":"The ID of the stock location the fulfillment will be shipped from","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be sent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the Order that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)","description":"The details of the fulfillment provider responsible for handling the fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the Fulfillment Provider responsible for handling the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`Date`","description":"The date with timezone at which the Fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](entities.Swap.mdx)","description":"The details of the swap that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the Swap that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_links","type":"[TrackingLink](entities.TrackingLink.mdx)[]","description":"The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tracking_numbers","type":"`string`[]","description":"The tracking numbers that can be used to track the status of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fulfillment_id","type":"`string`","description":"The ID of the Fulfillment that the Fulfillment Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"adjustments","type":"[LineItemAdjustment](entities.LineItemAdjustment.mdx)[]","description":"The details of the item's adjusLine truncated
+<ParameterTypes parameters={[{"name":"fulfillment_id","type":"`string`","description":"The ID of the Fulfillment that the Fulfillment Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the Line Item that the Fulfillment Item references.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"[Fulfillment](entities.Fulfillment.mdx)","description":"The details of the fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The fulfillment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the Claim that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the Swap that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](entities.Swap.mdx)","description":"The details of the swap that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the Order that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be sent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the Fulfillment Provider responsible for handling the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`null` \\| `string`","description":"The ID of the stock location the fulfillment will be shipped from","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)","description":"The details of the fulfillment provider responsible for handling the fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"[FulfillmentItem](entities.FulfillmentItem.mdx)[]","description":"The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tracking_links","type":"[TrackingLink](entities.TrackingLink.mdx)[]","description":"The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tracking_numbers","type":"`string`[]","description":"The tracking numbers that can be used to track the status of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"This contains all the data necessary for the Fulfillment provider to handle the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`Date`","description":"The date with timezone at which the Fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the Fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the fulfillment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item.","optional":falsLine truncated

www/apps/docs/content/references/entities/classes/entities.FulfillmentProvider.mdx

@@ -11,4 +11,4 @@ A fulfillment provider represents a fulfillment service installed in the Medusa
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the fulfillment provider as given by the fulfillment service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_installed","type":"`boolean`","description":"Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is\\_installed` attribute is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the fulfillment provider as given by the fulfillment service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_installed","type":"`boolean`","description":"Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is\\_installed` attribute is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="FulfillmentProvider"/>

www/apps/docs/content/references/entities/classes/entities.GiftCard.mdx

@@ -11,4 +11,4 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"balance","type":"`number`","description":"The remaining value on the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`Date`","description":"The time at which the Gift Card can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The gift card's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The gift card's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the Gift Card represents.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"balance","type":"`number`","description":"The remaining value on the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be usLine truncated

www/apps/docs/content/references/entities/classes/entities.GiftCardTransaction.mdx

@@ -11,4 +11,4 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"amount","type":"`number`","description":"The amount that was used from the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card","type":"[GiftCard](entities.GiftCard.mdx)","description":"The details of the gift card associated used in this transaction.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"balance","type":"`number`","description":"The remaining value on the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`Date`","description":"The time at which the Gift Card can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The gift card's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The gift card's tax rate that will be applied on calculating totals","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the Gift Card represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"gift_card_id","type":"`string`","description":"The ID of the Gift Card that was used in the transaction.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The gift card transaction's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_taxable","type":"`boolean`","description":"Whether the transaction is taxable or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the gift card was used for payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaiLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The gift card transaction's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_id","type":"`string`","description":"The ID of the Gift Card that was used in the transaction.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card","type":"[GiftCard](entities.GiftCard.mdx)","description":"The details of the gift card associated used in this transaction.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The gift card's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the Gift Card represents.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"balance","type":"`number`","description":"The remaining value on the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"ends_at","type":"`Date`","description":"The time at which the Gift Card can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The gift card's tax rate that will be applied on calculating totals","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was used for payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the gift card was used for payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"display_id","typeLine truncated

www/apps/docs/content/references/entities/classes/entities.IdempotencyKey.mdx

@@ -11,4 +11,4 @@ Idempotency Key is used to continue a process in case of any failure that might
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"Date which the idempotency key was locked.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The idempotency key's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"The unique randomly generated key used to determine the state of a process.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"locked_at","type":"`Date`","description":"Date which the idempotency key was locked.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"recovery_point","type":"`string`","description":"Where to continue from.","optional":false,"defaultValue":"started","expandable":false,"children":[]},{"name":"request_method","type":"`string`","description":"The method of the request","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"request_params","type":"`Record<string, unknown>`","description":"The parameters passed to the request","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"request_path","type":"`string`","description":"The request's path","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"response_body","type":"`Record<string, unknown>`","description":"The response's body","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"response_code","type":"`number`","description":"The response's code.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The idempotency key's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"The unique randomly generated key used to determine the state of a process.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"Date which the idempotency key was locked.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"locked_at","type":"`Date`","description":"Date which the idempotency key was locked.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"request_method","type":"`string`","description":"The method of the request","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"request_params","type":"`Record<string, unknown>`","description":"The parameters passed to the request","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"request_path","type":"`string`","description":"The request's path","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"response_code","type":"`number`","description":"The response's code.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"response_body","type":"`Record<string, unknown>`","description":"The response's body","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"recovery_point","type":"`string`","description":"Where to continue from.","optional":false,"defaultValue":"started","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="IdempotencyKey"/>

www/apps/docs/content/references/entities/classes/entities.Image.mdx

@@ -11,4 +11,4 @@ An Image is used to store details about uploaded images. Images are uploaded by
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The image's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL at which the image file can be found.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The image's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL at which the image file can be found.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="Image"/>

www/apps/docs/content/references/entities/classes/entities.Invite.mdx

@@ -11,4 +11,4 @@ An invite is created when an admin user invites a new user to join the store's t
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"accepted","type":"`boolean`","description":"Whether the invite was accepted or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"expires_at","type":"`Date`","description":"The date the invite expires at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The invite's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't change the privileges of the user.","optional":false,"defaultValue":"member","expandable":false,"children":[{"name":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"token","type":"`string`","description":"The token used to accept the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user_email","type":"`string`","description":"The email of the user being invited.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The invite's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user_email","type":"`string`","description":"The email of the user being invited.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't change the privileges of the user.","optional":false,"defaultValue":"member","expandable":false,"children":[{"name":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"accepted","type":"`boolean`","description":"Whether the invite was accepted or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token used to accept the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"expires_at","type":"`Date`","description":"The date the invite expires at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="Invite"/>

www/apps/docs/content/references/entities/classes/entities.LineItem.mdx

@@ -11,4 +11,4 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"adjustments","type":"[LineItemAdjustment](entities.LineItemAdjustment.mdx)[]","description":"The details of the item's adjustments, which are available when a discount is applied on the item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"allow_discounts","type":"`boolean`","description":"Flag to indicate if the Line Item should be included when doing discount calculations.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the claim that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A more detailed description of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been fulfilled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_shipping","type":"`null` \\| `boolean`","description":"Flag to indicate if the Line Item has fulfillment associated with it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The line item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Indicates if the line item unit\\_price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Flag to indicate if the Line Item is a Gift Card.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_return","type":"`boolean`","description":"Is the item being returned","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":""Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The line item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the claim that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"adjustments","type":"[LineItemAdjustment](entities.LineItemAdjustment.mdx)[]","description":"The details of the item's adjustments, which are available when a discount is applied on the item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A more detailed description of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_return","type":"`boolean`","description":"Is the item being returned","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Flag to indicate if the Line Item is a Gift Card.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"allow_discounts","type":"`boolean`","description":"Flag to indicate if the Line Item should be included when doing discount calculations.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"has_shipping","type":"`null` \\| `boolean`","description":"Flag to indicate if the Line Item has fulfillment associated with it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional"Line truncated

www/apps/docs/content/references/entities/classes/entities.LineItemAdjustment.mdx

@@ -11,4 +11,4 @@ A Line Item Adjustment includes details on discounts applied on a line item.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"amount","type":"`number`","description":"The adjustment amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The line item's adjustment description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount","type":"[Discount](entities.Discount.mdx)","description":"The details of the discount associated with the adjustment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"discount_id","type":"`string`","description":"The ID of the discount associated with the adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The Line Item Adjustment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The Line Item Adjustment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"description","type":"`string`","description":"The line item's adjustment description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount","type":"[Discount](entities.Discount.mdx)","description":"The details of the discount associated with the adjustment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"discount_id","type":"`string`","description":"The ID of the discount associated with the adjustment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The adjustment amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="LineItemAdjustment"/>

www/apps/docs/content/references/entities/classes/entities.LineItemTaxLine.mdx

@@ -11,4 +11,4 @@ A Line Item Tax Line represents the taxes applied on a line item.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"code","type":"`null` \\| `string`","description":"A code to identify the tax type by","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The line item tax line's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"A human friendly name for the tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The numeric rate to charge tax by","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The line item tax line's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rate","type":"`number`","description":"The numeric rate to charge tax by","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"A human friendly name for the tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"A code to identify the tax type by","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="LineItemTaxLine"/>

www/apps/docs/content/references/entities/classes/entities.MoneyAmount.mdx

@@ -11,4 +11,4 @@ A Money Amount represent a price amount, for example, a product variant's price
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"amount","type":"`number`","description":"The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The money amount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](entities.PriceList.mdx)","description":"The details of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](entities.ProductVariant.mdx)","description":"The details of the product variant that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allow_backorder","type":"`boolean`","description":"Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"A generic field for a GTIN number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"An EAN barcode number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product variant's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_items","type":"[ProductVariantInventoryItem](entities.ProductVariantInventoryItem.mdx)[]","description":"The details inventory items of the product variant.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"inventory_quantity","type":"`number`","description":"The current quantity of the item that is stocked.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether Medusa should manage inventory for the Product Variant.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"ThLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The money amount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](entities.PriceList.mdx)","description":"The details of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariant](entities.ProductVariant.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product variant's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the product that the product variant belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"[Product](entities.Product.mdx)","description":"The details of the product that the product variant belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"prices","type":"[MoneyAmount](entities.MoneyAmount.mdx)[]","description":"The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"A generic field for a GTIN number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"An EAN barcode number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"A UPC barcode number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"The ranking of this variant","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"inventory_quantity","type":"`number`",Line truncated

www/apps/docs/content/references/entities/classes/entities.Note.mdx

@@ -11,4 +11,4 @@ A Note is an element that can be used in association with different resources to
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"author","type":"[User](entities.User.mdx)","description":"The details of the user that created the note.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The note's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The note's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"author","type":"[User](entities.User.mdx)","description":"The details of the user that created the note.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="Note"/>

www/apps/docs/content/references/entities/classes/entities.Notification.mdx

@@ -11,4 +11,4 @@ A notification is an alert sent, typically to customers, using the installed Not
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event that the notification was sent for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The notification's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string`","description":"The notification's parent ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_notification","type":"[Notification](entities.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data that the NotificLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The notification's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event that the notification was sent for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_addresses","type":"[Address](entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"orders","type":"[Order](entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"to","type":"`string`","description":"The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string`","description":"The notification's parent ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_notification","type":"[Notification](entities.NotificatLine truncated

www/apps/docs/content/references/entities/classes/entities.NotificationProvider.mdx

@@ -11,4 +11,4 @@ A notification provider represents a notification service installed in the Medus
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the notification provider as given by the notification service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_installed","type":"`boolean`","description":"Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is\\_installed` attribute is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the notification provider as given by the notification service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_installed","type":"`boolean`","description":"Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is\\_installed` attribute is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="NotificationProvider"/>

www/apps/docs/content/references/entities/classes/entities.Oauth.mdx

@@ -9,4 +9,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"application_name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"install_url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"uninstall_url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"application_name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"install_url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"uninstall_url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="Oauth"/>

www/apps/docs/content/references/entities/classes/entities.Order.mdx

@@ -11,4 +11,4 @@ An order is a purchase made by a customer. It holds details about payment and fu
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillments","type":"[Fulfillment](entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","exLine truncated

www/apps/docs/content/references/entities/classes/entities.OrderEdit.mdx

@@ -11,4 +11,4 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"changes","type":"[OrderItemChange](entities.OrderItemChange.mdx)[]","description":"The details of all the changes on the original order's line items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The unique identifier of the user or customer who created the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"The difference between the total amount of the order and total amount of edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of the gift card tax amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of the gift card amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order edit's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why  the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","opLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The order edit's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"changes","type":"[OrderItemChange](entities.OrderItemChange.mdx)[]","description":"The details of all the changes on the original order's line items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_by","type":"`string`","description":"The unique identifier of the user or customer who created the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of the gift card amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of the gift card tax amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"The difference between the total amount of the order and total amount of edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why  the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","Line truncated

www/apps/docs/content/references/entities/classes/entities.OrderItemChange.mdx

@@ -11,4 +11,4 @@ An order item change is a change made within an order edit to an order's items.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order item change's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"[OrderEdit](entities.OrderEdit.mdx)","description":"The details of the order edit the item change is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`string`","description":"The ID of the order edit","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderEditItemChangeType](../enums/entities.OrderEditItemChangeType.mdx)","description":"The order item change's status","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the resulting line item after the item change. This line item is then used in the original order once the order edit is confirmed.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"line_item_id","type":"`string`","description":"The ID of the cloned line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_line_item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the original line item this item change references. This is used if the item change updates or deletes the original item.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"original_line_item_id","type":"`string`","description":"The ID of the original line item in the order","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The order item change's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderEditItemChangeType](../enums/entities.OrderEditItemChangeType.mdx)","description":"The order item change's status","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit_id","type":"`string`","description":"The ID of the order edit","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"[OrderEdit](entities.OrderEdit.mdx)","description":"The details of the order edit the item change is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"original_line_item_id","type":"`string`","description":"The ID of the original line item in the order","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_line_item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the original line item this item change references. This is used if the item change updates or deletes the original item.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"line_item_id","type":"`string`","description":"The ID of the cloned line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the resulting line item after the item change. This line item is then used in the original order once the order edit is confirmed.","optional":true,"defaultValue":"","expandable":true,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="OrderItemChange"/>

www/apps/docs/content/references/entities/classes/entities.Payment.mdx

@@ -11,4 +11,4 @@ A payment is originally created from a payment session. Once a payment session i
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"amount","type":"`number`","description":"The amount that the Payment has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount_refunded","type":"`number`","description":"The amount of the original Payment amount that has been refunded back to the Customer.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The billing address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date with timezone at which the cart was completed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, unknown>`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region associLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The swap's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[SwapFulfillmentStatus](../enums/entities.SwapFulfillmentStatus.mdx)","description":"The status of the Fulfillment of the Swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[SwapPaymentStatus](../enums/entities.SwapPaymentStatus.mdx)","description":"The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"additional_items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The details of the new products to send to the customer, represented as line items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[Return](entities.Return.mdx)","description":"The details of the return that belongs to the swap, which holds the details on the items being returned.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillments","type":"[Fulfillment](entities.Fulfillment.mdx)[]","description":"The details of the fulfillments that are used to send the new items to the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment","type":"[Payment](entities.Payment.mdx)","description":"The details of the additional payment authorized by the customer when `difference\\_due` is positive.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"difference_due","type":"`number`","description":"The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](entities.Address.mdx)","description":"The details of the shipping address that the new items should be sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used to fulfill the additional items purchased.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":true,"children"Line truncated

www/apps/docs/content/references/entities/classes/entities.PaymentCollection.mdx

@@ -11,4 +11,4 @@ A payment collection allows grouping and managing a list of payments at one. Thi
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment Session has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"The ID of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment session's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_initiated","type":"`boolean`","description":"A flag to indicate if a communication with the third party provider has been initiated.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_selected","type":"`null` \\| `boolean`","description":"A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description"Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"NOT_PAID","type":"`\"not_paid\"`","description":"The payment collection isn't paid.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"AWAITING","type":"`\"awaiting\"`","description":"The payment collection is awaiting payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"AUTHORIZED","type":"`\"authorized\"`","description":"The payment colleciton is authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_AUTHORIZED","type":"`\"partially_authorized\"`","description":"Some of the payments in the payment collection are authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The payment collection is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxableLine truncated

www/apps/docs/content/references/entities/classes/entities.PaymentProvider.mdx

@@ -11,4 +11,4 @@ A payment provider represents a payment service installed in the Medusa backend,
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the payment provider as given by the payment service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_installed","type":"`boolean`","description":"Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is\\_installed` attribute is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the payment provider as given by the payment service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_installed","type":"`boolean`","description":"Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is\\_installed` attribute is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="PaymentProvider"/>

www/apps/docs/content/references/entities/classes/entities.PaymentSession.mdx

@@ -11,4 +11,4 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"amount","type":"`number`","description":"The amount that the Payment Session has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The billing address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date with timezone at which the cart was completed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, unknown>`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expanLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The payment session's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"The ID of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The billing address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"discounts","type":"[Discount](entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../enums/entities.CartType.mdx)Line truncated

www/apps/docs/content/references/entities/classes/entities.PriceList.mdx

@@ -11,4 +11,4 @@ A Price List represents a set of prices that override the default price for one
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The money amount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](entities.PriceList.mdx)","description":"The details of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the price list that the money amount may belong to.","optional":false,"defaultValue":"",Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[{"name":"SALE","type":"`\"sale\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OVERRIDE","type":"`\"override\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_lists","type":"[PriceList](entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"prices","type":"[MoneyAmount](entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The money amount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","descripLine truncated

www/apps/docs/content/references/entities/classes/entities.Product.mdx

@@ -11,4 +11,4 @@ A product is a saleable item that holds general information such as name or desc
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"categories","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[{"name":"category_children","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the category's children.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The product category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"A unique string that identifies the Product Category - can for example be used in slug structures.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product category's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`Boolean`","description":"A flag to make product category visible/hidden in the store front","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_internal","type":"`Boolean`","description":"A flag to make product category an internal category for admins","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The product category's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategory](entities.ProductCategory.mdx)","description":"The details of the parent of this category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the parent category.","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"The details of the products that belong to this category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rank","type":"`number`","description":"An integer that depicts the rank of category in a tree node","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productCategoryProductJoinTable","type":"`string`","description":"","optional":false,"defaultValue":"\"product_category_product\"","expandable":false,"children":[]},{"name":"treeRelations","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"collection","type":"[ProductCollection](entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"A unique string that identifies the Product Collection - can for example be used in slug structures.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ILine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[{"name":"DRAFT","type":"`\"draft\"`","description":"The product is a draft. It's not viewable by customers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROPOSED","type":"`\"proposed\"`","description":"The product is proposed, but not yet published.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PUBLISHED","type":"`\"published\"`","description":"The product is published.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REJECTED","type":"`\"rejected\"`","description":"The product is rejected. It's not viewable by customers.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"images","type":"[Image](entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The image's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL at which the image file can be found.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product option's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optionaLine truncated

www/apps/docs/content/references/entities/classes/entities.ProductCategory.mdx

@@ -11,4 +11,4 @@ A product category can be used to categorize products into a hierarchy of catego
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"category_children","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the category's children.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"category_children","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the category's children.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The product category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"A unique string that identifies the Product Category - can for example be used in slug structures.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product category's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`Boolean`","description":"A flag to make product category visible/hidden in the store front","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_internal","type":"`Boolean`","description":"A flag to make product category an internal category for admins","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The product category's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategory](entities.ProductCategory.mdx)","description":"The details of the parent of this category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the parent category.","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"The details of the products that belong to this category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rank","type":"`number`","description":"An integer that depicts the rank of category in a tree node","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productCategoryProductJoinTable","type":"`string`","description":"","optional":false,"defaultValue":"\"product_category_product\"","expandable":false,"children":[]},{"name":"treeRelations","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The product category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"A unique string that identifies the Product Category - can for example be used in slug structures.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product category's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`Boolean`","description":"A flag to make product category visible/hidden in the store front","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_internal","type":"`Boolean`","description":"A flag to make product category an internal category for admins","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The product category's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategory](entities.ProductCategory.mdx)","description":"The details of the parent of this category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the parent category.","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"products","type":"[Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The product category's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productCategoryProductJoinTable","type":"`string`","description":"","optional":false,"defaultValue":"\"product_category_product\"","expandable":false,"children":[]},{"name":"treeRelations","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The product category's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The product category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"A unique string that identifies the Product Category - can for example be used in slug structures.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`Boolean`","description":"A flag to make product category visible/hidden in the store front","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_internal","type":"`Boolean`","description":"A flag to make product category an internal category for admins","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategory](entities.ProductCategory.mdx)","description":"The details of the parent of this category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the parent category.","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the category's children.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product category's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productCategoryProductJoinTable","type":"`string`","description":"","optional":false,"defaultValue":"\"product_category_product\"","expandable":false,"children":[]},{"name":"treeRelations","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The product category's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The product category's description.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"A unique string that identifies the Product Category - can for example be used in slug structures.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_active","type":"`Boolean`","description":"A flag to make product category visible/hidden in the store front","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_internal","type":"`Boolean`","description":"A flag to make product category an internal category for admins","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"parent_category","type":"`null` \\| [ProductCategory](entities.ProductCategory.mdx)","description":"The details of the parent of this category.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_category_id","type":"`null` \\| `string`","description":"The ID of the parent category.","optional":false,"defaultValue":"null","expandable":false,"children":[]},{"name":"category_children","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the category's children.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rank","type":"`number`","description":"An integer that depicts the rank of category in a tree node","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optionaLine truncated

www/apps/docs/content/references/entities/classes/entities.ProductCollection.mdx

@@ -11,4 +11,4 @@ A Product Collection allows grouping together products for promotional purposes.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"A unique string that identifies the Product Collection - can for example be used in slug structures.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers tLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The product collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"A unique string that identifies the Product Collection - can for example be used in slug structures.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"images","type":"[Image](entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariant](entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"categories","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipLine truncated

www/apps/docs/content/references/entities/classes/entities.ProductOption.mdx

@@ -11,4 +11,4 @@ A Product Option defines properties that may vary between different variants of
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product option's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"[Product](entities.Product.mdx)","description":"The details of the product that this product option belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](entities.ProductOption.mdx)[]","description":"The details of the ProducLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The product option's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title that the Product Option is defined by (e.g. `Size`).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValue](entities.ProductOptionValue.mdx)[]","description":"The details of the values of the product option.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product option value's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Variant has defined for the specific Product Option (e.g. if the Product Option is \"Size\" this value could be `Small`, `Medium` or `Large`).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`string`","description":"The ID of the Product Option that the Product Option Value belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"[ProductOption](entities.ProductOption.mdx)","description":"The details of the product option that the Product Option Value belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the product variant that uses this product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](entities.ProductVariant.mdx)","description":"The details of the product variant that uses this product option value.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_id","type":"`string`","description":"The ID of the product that this product option belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"[Product](entities.Product.mdx)","description":"The details of the product that this product option belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolLine truncated

www/apps/docs/content/references/entities/classes/entities.ProductOptionValue.mdx

@@ -11,4 +11,4 @@ An option value is one of the possible values of a Product Option. Product Varia
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product option value's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"[ProductOption](entities.ProductOption.mdx)","description":"The details of the product option that the Product Option Value belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product option's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"[Product](entities.Product.mdx)","description":"The details of the product that this product option belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the product that this product option belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title that the Product Option is defined by (e.g. `Size`).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValue](entities.ProductOptionValue.mdx)[]","description":"The details of the values of the product option.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"option_id","type":"`string`","description":"The ID of the Product Option that the Product Option Value belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Variant has defined for the specific Product Option (e.g. if the Product Option is \"Size\" this value could be `Small`, `Medium` or `Large`).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](entities.ProductVariant.mdx)","description":"The details of the product variant that uses this product option value.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allow_backorder","type":"`boolean`","description":"Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"A generic field for a GTIN number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"An EAN barcode number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"childrenLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The product option value's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Variant has defined for the specific Product Option (e.g. if the Product Option is \"Size\" this value could be `Small`, `Medium` or `Large`).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option_id","type":"`string`","description":"The ID of the Product Option that the Product Option Value belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"option","type":"[ProductOption](entities.ProductOption.mdx)","description":"The details of the product option that the Product Option Value belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product option's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title that the Product Option is defined by (e.g. `Size`).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"values","type":"[ProductOptionValue](entities.ProductOptionValue.mdx)[]","description":"The details of the values of the product option.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the product that this product option belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"[Product](entities.Product.mdx)","description":"The details of the product that this product option belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variant_id","type":"`string`","description":"The ID of the product variant that uses this product option value.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](entities.ProductVariant.mdx)","description":"The details of the product variant that uses this product option value.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product variant's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the product that the product variant belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"[Product](entities.Product.mdx)","description":"The details of the product that the product variant belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"prices","type":"[MoneyAmount](entities.MoneyAmount.mdx)[]","description":"The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents Line truncated

www/apps/docs/content/references/entities/classes/entities.ProductTag.mdx

@@ -11,4 +11,4 @@ A Product Tag can be added to Products for easy filtering and grouping.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product tag's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Tag represents","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The product tag's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Tag represents","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="ProductTag"/>

www/apps/docs/content/references/entities/classes/entities.ProductTaxRate.mdx

@@ -11,4 +11,4 @@ This represents the association between a tax rate and a product to indicate tha
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the Product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate_id","type":"`string`","description":"The ID of the Tax Rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"[Product](entities.Product.mdx)","description":"The details of the product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"opLine truncated
+<ParameterTypes parameters={[{"name":"product_id","type":"`string`","description":"The ID of the Product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate_id","type":"`string`","description":"The ID of the Tax Rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"[Product](entities.Product.mdx)","description":"The details of the product.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"images","type":"[Image](entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariant](entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"categories","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profiles","type":"[ShippingProfile](entities.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValuLine truncated

www/apps/docs/content/references/entities/classes/entities.ProductType.mdx

@@ -11,4 +11,4 @@ A Product Type can be added to Products for filtering and reporting purposes.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product type's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Type represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The product type's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Type represents.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="ProductType"/>

www/apps/docs/content/references/entities/classes/entities.ProductTypeTaxRate.mdx

@@ -11,4 +11,4 @@ This represents the association between a tax rate and a product type to indicat
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_id","type":"`string`","description":"The ID of the Product type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate_id","type":"`string`","description":"The id of the Tax Rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"[ProductType](entities.ProductType.mdx)","description":"The details of the product type.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product type's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Type represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_rate","type":"[TaxRate](entities.TaxRate.mdx)","description":"The details of the tax rate.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`null` \\| `string`","description":"A code to identify the tax type by","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The tax rate's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"A human friendly name for the tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"The details of the product types that belong to this tax rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"The details of the products that belong to this tax rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The numeric rate to charge","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region that the rate belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region that the rate belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[ShippingOption](entities.ShippingOption.mdx)[]","description":"The details of the shipping options that belong to this tax rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_count","type":"`number`","description":"The count of products","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_count","type":"`number`","description":"The count of product types","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_count","type":"`number`","description":"The count of shipping options","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#reLine truncated
+<ParameterTypes parameters={[{"name":"product_type_id","type":"`string`","description":"The ID of the Product type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate_id","type":"`string`","description":"The id of the Tax Rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type","type":"[ProductType](entities.ProductType.mdx)","description":"The details of the product type.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product type's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Type represents.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_rate","type":"[TaxRate](entities.TaxRate.mdx)","description":"The details of the tax rate.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The tax rate's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The numeric rate to charge","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"A code to identify the tax type by","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"A human friendly name for the tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region that the rate belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region that the rate belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"The details of the products that belong to this tax rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"The details of the product types that belong to this tax rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_options","type":"[ShippingOption](entities.ShippingOption.mdx)[]","description":"The details of the shipping options that belong to this tax rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_count","type":"`number`","description":"The count of products","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_type_count","type":"`number`","description":"The count of product types","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_count","type":"`number`","description":"The count of shipping options","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#reLine truncated

www/apps/docs/content/references/entities/classes/entities.ProductVariant.mdx

@@ -11,4 +11,4 @@ A Product Variant represents a Product with a specific set of Product Option con
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"allow_backorder","type":"`boolean`","description":"Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"A generic field for a GTIN number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"An EAN barcode number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product variant's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_items","type":"[ProductVariantInventoryItem](entities.ProductVariantInventoryItem.mdx)[]","description":"The details inventory items of the product variant.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product variant inventory item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The id of the inventory item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"required_quantity","type":"`number`","description":"The quantity of an inventory item required for the variant.","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](entities.ProductVariant.mdx)","description":"The details of the product variant.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`string`","description":"The id of the variant.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"inventory_quantity","type":"`number`","description":"The current quantity of the item that is stocked.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether Medusa should manage inventory for the Product Variant.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValue](entities.ProductOptionValue.mdx)[]","description":"The details of the product options that this product variant defines values for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date withLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The product variant's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the product that the product variant belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"[Product](entities.Product.mdx)","description":"The details of the product that the product variant belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"images","type":"[Image](entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariant](entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"categories","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be uLine truncated

www/apps/docs/content/references/entities/classes/entities.ProductVariantInventoryItem.mdx

@@ -11,4 +11,4 @@ A Product Variant Inventory Item links variants with inventory items and denotes
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product variant inventory item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The id of the inventory item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"required_quantity","type":"`number`","description":"The quantity of an inventory item required for the variant.","optional":false,"defaultValue":"1","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](entities.ProductVariant.mdx)","description":"The details of the product variant.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allow_backorder","type":"`boolean`","description":"Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"A generic field for a GTIN number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"An EAN barcode number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product variant's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_items","type":"[ProductVariantInventoryItem](entities.ProductVariantInventoryItem.mdx)[]","description":"The details inventory items of the product variant.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"inventory_quantity","type":"`number`","description":"The current quantity of the item that is stocked.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether Medusa should manage inventory for the Product Variant.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValue](entities.ProductOptionValue.mdx)[]","description":"The details of the product options that this product variant defines values for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers."Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The product variant inventory item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`string`","description":"The id of the inventory item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"The id of the variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](entities.ProductVariant.mdx)","description":"The details of the product variant.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product variant's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the product that the product variant belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product","type":"[Product](entities.Product.mdx)","description":"The details of the product that the product variant belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"prices","type":"[MoneyAmount](entities.MoneyAmount.mdx)[]","description":"The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"A generic field for a GTIN number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"An EAN barcode number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"A UPC barcode number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"The ranking of this variant","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"inventory_quantity","type":"`number`","description":"The current quantity of the item that is stocked.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether Medusa should manage inventory for the Product Variant.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shippingLine truncated

www/apps/docs/content/references/entities/classes/entities.ProductVariantMoneyAmount.mdx

@@ -9,4 +9,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"money_amount_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"money_amount_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="ProductVariantMoneyAmount"/>

www/apps/docs/content/references/entities/classes/entities.PublishableApiKey.mdx

@@ -11,4 +11,4 @@ A Publishable API key defines scopes that resources are available in. Then, it c
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The key's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"The unique identifier of the user that revoked the key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The key's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`Date`","description":"The date with timezone at which the key was revoked.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The key's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"The unique identifier of the user that revoked the key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The key's title.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`Date`","description":"The date with timezone at which the key was revoked.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="PublishableApiKey"/>

www/apps/docs/content/references/entities/classes/entities.PublishableApiKeySalesChannel.mdx

@@ -11,4 +11,4 @@ This represents the association between the Publishable API keys and Sales Chann
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The relation's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"publishable_key_id","type":"`string`","description":"The publishable API key's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The sales channel's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The relation's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The sales channel's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"publishable_key_id","type":"`string`","description":"The publishable API key's ID","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="PublishableApiKeySalesChannel"/>

www/apps/docs/content/references/entities/classes/entities.Refund.mdx

@@ -11,4 +11,4 @@ A refund represents an amount of money transfered back to the customer for a giv
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"amount","type":"`number`","description":"The amount that has be refunded to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The refund's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the refund in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"An optional note explaining why the amount was refunded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order this refund was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The refund's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order this refund was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID, if available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order this refund was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"chilLine truncated

www/apps/docs/content/references/entities/classes/entities.Region.mdx

@@ -11,4 +11,4 @@ A region holds settings specific to a geographical location, including the curre
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"display_name","type":"`string`","description":"The country name appropriate for display.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`number`","description":"The country's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_2","type":"`string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The normalized country name in upper case.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`number`","description":"The numerical ISO code for the country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region the country is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The region ID this country is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the fulfillment provider as given by the fulfillment service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_installed","type":"`boolean`","description":"Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is\\_installed` attribute is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the ReLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`number`","description":"The country's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_2","type":"`string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`number`","description":"The numerical ISO code for the country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The normalized country name in upper case.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`string`","description":"The country name appropriate for display.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The region ID this country is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region the country is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]}]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvLine truncated

www/apps/docs/content/references/entities/classes/entities.Return.mdx

@@ -11,4 +11,4 @@ A Return holds information about Line Items that a Customer wishes to send back,
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim that the return may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"additional_items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The details of the new items to be shipped when the claim's type is `replace`","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the claim was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[ClaimItem](entities.ClaimItem.mdx)[]","description":"The details of the items that should be replaced or refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[ClaimFulfillmentStatus](../enums/entities.ClaimFulfillmentStatus.mdx)","description":"The claim's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](entities.Fulfillment.mdx)[]","description":"The fulfillments of the new items to be shipped","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The claim's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that this claim was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the claim comes from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[ClaimPaymentStatus](../enums/entities.ClaimPaymentStatus.mdx)","description":"The status of the claim's payment","optional":false,"defaultValue":"na","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount that will be refunded in conjunction with the claim","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](entities.Return.mdx)","description":"The details of the return associated with the claim if the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address","type":"[Address](entities.Address.mdx)","description":"The details of the address that new items should be shipped to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the address that the new items should be shipped to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods that the claim order will be shipped with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[ClaimType](../enums/entities.ClaimType.mdx)","description":"The claim's type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"claim_order_id","type":"`null` \\| `string`","description":"The ID of the claim that the return may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The return's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`null` \Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The return's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../enums/entities.ReturnStatus.mdx)","description":"Status of the Return.","optional":false,"defaultValue":"requested","expandable":false,"children":[{"name":"REQUESTED","type":"`\"requested\"`","description":"The return is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"RECEIVED","type":"`\"received\"`","description":"The return is received.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The return is awaiting action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The return is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"[ReturnItem](entities.ReturnItem.mdx)[]","description":"The details of the items that the customer is returning.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"return_id","type":"`string`","description":"The ID of the Return that the Return Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the Line Item that the Return Item references.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](entities.Return.mdx)","description":"Details of the Return that the Return Item belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item in the original order to be returned.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the Line Item to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_requested","type":"`boolean`","description":"Whether the Return Item was requested initially or received unexpectedly in the warehouse.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"requested_quantity","type":"`number`","description":"The quantity that was originally requested to be returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The quantity that was received in the warehouse.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`string`","description":"The ID of the reason for returning the item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"[ReturnReason](entities.ReturnReason.mdx)","description":"The details of the reason for returning the item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"note","type":"`string`","description":"An optional note with additional details about the Return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"swap_id","type":"`null` \\| `string`","description":"The ID of the swap that the return may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](entities.Swap.mdx)","description":"The details of the swap that the return may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The swap's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[SwapFulfillmentStatus](../enums/entities.SwapFulfillmentStatus.mdx)","description":"The status of the FuLine truncated

www/apps/docs/content/references/entities/classes/entities.ReturnItem.mdx

@@ -11,4 +11,4 @@ A return item represents a line item in an order that is to be returned. It incl
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"is_requested","type":"`boolean`","description":"Whether the Return Item was requested initially or received unexpectedly in the warehouse.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item in the original order to be returned.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"adjustments","type":"[LineItemAdjustment](entities.LineItemAdjustment.mdx)[]","description":"The details of the item's adjustments, which are available when a discount is applied on the item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"allow_discounts","type":"`boolean`","description":"Flag to indicate if the Line Item should be included when doing discount calculations.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the claim that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A more detailed description of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been fulfilled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_shipping","type":"`null` \\| `boolean`","description":"Flag to indicate if the Line Item has fulfillment associated with it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The line item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Indicates if the line item unit\\_price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Flag to indicate if the Line Item is a Gift Card.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_return","type":"`boolean`","description":"Is the item being returned","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optLine truncated
+<ParameterTypes parameters={[{"name":"return_id","type":"`string`","description":"The ID of the Return that the Return Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The ID of the Line Item that the Return Item references.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](entities.Return.mdx)","description":"Details of the Return that the Return Item belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The return's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../enums/entities.ReturnStatus.mdx)","description":"Status of the Return.","optional":false,"defaultValue":"requested","expandable":false,"children":[]},{"name":"items","type":"[ReturnItem](entities.ReturnItem.mdx)[]","description":"The details of the items that the customer is returning.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`null` \\| `string`","description":"The ID of the swap that the return may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](entities.Swap.mdx)","description":"The details of the swap that the return may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`null` \\| `string`","description":"The ID of the claim that the return may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim that the return may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the return was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the return was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_method","type":"[ShippingMethod](entities.ShippingMethod.mdx)","description":"The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"location_id","type":"`null` \\| `string`","description":"The ID of the stock location the return will be added back.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_data","type":"`Record<string, unknown>`","description":"Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount that should be refunded as a result of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`Date`","description":"The date with timezone at which the return was received.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"When set to true, no notification will be sent related to this return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`null` \\| `string`","description":"Randomly generated key used to continue the completion of the return in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item","type":"[LineItem](entities.LineItem.mdx)","description":"The details of the line item in the original order to be returned.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The line item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at whichLine truncated

www/apps/docs/content/references/entities/classes/entities.ReturnReason.mdx

@@ -11,4 +11,4 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The return reason's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The return reason's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The return reason's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The return reason's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value to identify the reason by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"A text that can be displayed to the Customer as a reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A description of the Reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason_id","type":"`null` \\| `string`","description":"The ID of the parent reason.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_return_reason","type":"`null` \\| [ReturnReason](entities.ReturnReason.mdx)","description":"The details of the parent reason.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_reason_children","type":"[ReturnReason](entities.ReturnReason.mdx)[]","description":"The details of the child reasons.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="ReturnReason"/>

www/apps/docs/content/references/entities/classes/entities.SalesChannel.mdx

@@ -11,4 +11,4 @@ A Sales Channel is a method a business offers its products for purchase for the
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"carts","type":"[Cart](entities.Cart.mdx)[]","description":"The associated carts.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The billing address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date with timezone at which the cart was completed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, unknown>`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The sales channel's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Specify if the sales channel is enabled or disabled.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"images","type":"[Image](entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariant](entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"categories","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValueLine truncated

www/apps/docs/content/references/entities/classes/entities.SalesChannelLocation.mdx

@@ -11,4 +11,4 @@ This represents the association between a sales channel and a stock locations.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The Sales Channel Stock Location's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the Location Stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](entities.SalesChannel.mdx)","description":"The details of the sales channel the location is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"carts","type":"[Cart](entities.Cart.mdx)[]","description":"The associated carts.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The sales channel's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Specify if the sales channel is enabled or disabled.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"locations","type":"[SalesChannelLocation](entities.SalesChannelLocation.mdx)[]","description":"The details of the stock locations related to the sales channel.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](entities.Order.mdx)[]","description":"The associated orders.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"publishableKeys","type":"[PublishableApiKey](entities.PublishableApiKey.mdx)[]","description":"The associated publishable API keys.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channel_id","type":"`string`","description":"The ID of the Sales Channel","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The Sales Channel Stock Location's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`","description":"The ID of the Sales Channel","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the Location Stock.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](entities.SalesChannel.mdx)","description":"The details of the sales channel the location is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The sales channel's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Specify if the sales channel is enabled or disabled.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"carts","type":"[Cart](entities.Cart.mdx)[]","description":"The associated carts.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"orders","type":"[Order](entities.Order.mdx)[]","description":"The associated orders.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"publishableKeys","type":"[PublishableApiKey](entities.PublishableApiKey.mdx)[]","description":"The associated publishable API keys.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"locations","type":"[SalesChannelLocation](entities.SalesChannelLocation.mdx)[]","description":"The details of the stock locations related to the sales channel.","optional":false,"defaultValue":"","expandable":true,"children":[]}]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="SalesChannelLocation"/>

www/apps/docs/content/references/entities/classes/entities.ShippingMethod.mdx

@@ -11,4 +11,4 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The billing address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date with timezone at which the cart was completed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, unknown>`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The shipping method's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the Shipping Option that the Shipping Method is built from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"[Address](entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](entities.GiftCard.mdx)[]","description"Line truncated

www/apps/docs/content/references/entities/classes/entities.ShippingMethodTaxLine.mdx

@@ -11,4 +11,4 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"code","type":"`null` \\| `string`","description":"A code to identify the tax type by","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The line item tax line's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"A human friendly name for the tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number`","description":"The numeric rate to charge tax by","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[ShippingMethod](entities.ShippingMethod.mdx)","description":"The details of the associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`null` \\| `string`","description":"The ID of the claim that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The shipping method's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the shipping method price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price","type":"`number`","description":"The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the return that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](entities.Return.mdx)","description":"The details of the return that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_option","type":"[ShippingOption](entities.ShippingOption.mdx)","description":"The details of the shipping option the method was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the Shipping Option that the Shipping Method is built from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](entities.Swap.mdx)","description":"The details of the swap that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[ShippingMethodTaxLine](entities.ShippingMethodTaxLine.mdx)[]","description":"The details of the tax lines applied on the shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`number`","description":"The total of tax","optioLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The line item tax line's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method_id","type":"`string`","description":"The ID of the line item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[ShippingMethod](entities.ShippingMethod.mdx)","description":"The details of the associated shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The shipping method's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the Shipping Option that the Shipping Method is built from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`null` \\| `string`","description":"The ID of the claim that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](entities.Swap.mdx)","description":"The details of the swap that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the return that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](entities.Return.mdx)","description":"The details of the return that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_option","type":"[ShippingOption](entities.ShippingOption.mdx)","description":"The details of the shipping option the method was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_lines","type":"[ShippingMethodTaxLine](entities.ShippingMethodTaxLine.mdx)[]","description":"The details of the tax lines applied on the shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price","type":"`number`","description":"The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the shipping method price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rate","type":"`number`","description":"The numeric rate to charge tax by","optional":false,"defauLine truncated

www/apps/docs/content/references/entities/classes/entities.ShippingOption.mdx

@@ -11,4 +11,4 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"admin_only","type":"`boolean`","description":"Flag to indicate if the Shipping Option usage is restricted to admin users.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"amount","type":"`null` \\| `number`","description":"The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data needed for the Fulfillment Provider to identify the Shipping Option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The shipping option's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the shipping option price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"is_return","type":"`boolean`","description":"Flag to indicate if the Shipping Option can be used for Return shipments.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name given to the Shipping Option - this may be displayed to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)","description":"The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CALCULATED","type":"`\"calculated\"`","description":"The shipping option's price is calculated. In this case, the `amount` field is typically `null`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FLAT_RATE","type":"`\"flat_rate\"`","description":"The shipping option's price is a flat rate.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"profile","type":"[ShippingProfile](entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the shipping option belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The shipping profile's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name given to the Shipping profile - this may be displayed to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_options","type":"[ShippingOption](entities.ShippingOption.mdx)[]","description":"The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[ShippingProfileType](../enums/entities.ShippingProfileType.mdx)","description":"The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"profile_id","type":"`string`","description":"The ID of the Shipping PrLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The shipping option's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name given to the Shipping Option - this may be displayed to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this shipping option can be used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region this shipping option can be used in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inclLine truncated

www/apps/docs/content/references/entities/classes/entities.ShippingOptionRequirement.mdx

@@ -11,4 +11,4 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"amount","type":"`number`","description":"The amount to compare the Cart subtotal to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The shipping option requirement's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"[ShippingOption](entities.ShippingOption.mdx)","description":"The details of the shipping option that the requirements belong to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"admin_only","type":"`boolean`","description":"Flag to indicate if the Shipping Option usage is restricted to admin users.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"amount","type":"`null` \\| `number`","description":"The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data needed for the Fulfillment Provider to identify the Shipping Option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The shipping option's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the shipping option price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"is_return","type":"`boolean`","description":"Flag to indicate if the Shipping Option can be used for Return shipments.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name given to the Shipping Option - this may be displayed to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)","description":"The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the shipping option belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the Shipping Profile that the shipping option belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)","description":"The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region this shipping option can be used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this shipping option can be used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requirements","type":"[ShippingOptionRequirement](entities.ShippingOptionRequirement.mdx)[]","description":"The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The shipping option requirement's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option that the requirements belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"[ShippingOption](entities.ShippingOption.mdx)","description":"The details of the shipping option that the requirements belong to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The shipping option's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name given to the Shipping Option - this may be displayed to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this shipping option can be used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region this shipping option can be used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the Shipping Profile that the shipping option belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the shipping option belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)","description":"The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)","description":"The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`null` \\| `number`","description":"The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_return","type":"`boolean`","description":"Flag to indicate if the Shipping Option can be used for Return shipments.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"admin_only","type":"`boolean`","description":"Flag to indicate if the Shipping Option usage is restricted to admin users.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"requirements","type":"[ShippingOptionRequirement](entities.ShippingOptionRequirement.mdx)[]","description":"The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data needed for the Fulfillment Provider to identify the Shipping Option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the shipping option price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"type","type":"[RequirementType](../enums/entities.RequirementType.mdx)","description":"The type of the requirement, this defines how the vLine truncated

www/apps/docs/content/references/entities/classes/entities.ShippingProfile.mdx

@@ -11,4 +11,4 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The shipping profile's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name given to the Shipping profile - this may be displayed to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product VarianLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The shipping profile's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name given to the Shipping profile - this may be displayed to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ShippingProfileType](../enums/entities.ShippingProfileType.mdx)","description":"The type of the Shipping Profile, may be `default`, `gift\\_card` or `custom`.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"DEFAULT","type":"`\"default\"`","description":"The default profile used to ship item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"GIFT_CARD","type":"`\"gift_card\"`","description":"The profile used to ship gift cards.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CUSTOM","type":"`\"custom\"`","description":"The profile used to ship custom items.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"images","type":"[Image](entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variants","type":"[ProductVariant](entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"categories","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the product categories that thisLine truncated

www/apps/docs/content/references/entities/classes/entities.ShippingTaxRate.mdx

@@ -11,4 +11,4 @@ This represents the tax rates applied on a shipping option.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate_id","type":"`string`","description":"The ID of the associated tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"[ShippingOption](entities.ShippingOption.mdx)","description":"The details of the shipping option.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"admin_only","type":"`boolean`","description":"Flag to indicate if the Shipping Option usage is restricted to admin users.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"amount","type":"`null` \\| `number`","description":"The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data needed for the Fulfillment Provider to identify the Shipping Option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The shipping option's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the shipping option price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"is_return","type":"`boolean`","description":"Flag to indicate if the Shipping Option can be used for Return shipments.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name given to the Shipping Option - this may be displayed to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)","description":"The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the shipping option belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the Shipping Profile that the shipping option belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)","description":"The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region this shipping option can be used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this shipping option can be used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"requirements","type":"[ShippingOptionRequirement](entities.ShippingOptionRequirement.mdx)[]","description":"The details of the requiremLine truncated
+<ParameterTypes parameters={[{"name":"shipping_option_id","type":"`string`","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate_id","type":"`string`","description":"The ID of the associated tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option","type":"[ShippingOption](entities.ShippingOption.mdx)","description":"The details of the shipping option.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The shipping option's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name given to the Shipping Option - this may be displayed to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this shipping option can be used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region this shipping option can be used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the Shipping Profile that the shipping option belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the shipping option belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)","description":"The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../enums/entities.ShippingOptionPriceType.mdx)","description":"The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat\\_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount","type":"`null` \\| `number`","description":"The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_return","type":"`boolean`","description":"Flag to indicate if the Shipping Option can be used for Return shipments.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"admin_only","type":"`boolean`","description":"Flag to indicate if the Shipping Option usage is restricted to admin users.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"requirements","type":"[ShippingOptionRequirement](entities.ShippingOptionRequirement.mdx)[]","description":"The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"The data needed for the Fulfillment Provider to identify the Shipping Option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description"Line truncated

www/apps/docs/content/references/entities/classes/entities.StagedJob.mdx

@@ -11,4 +11,4 @@ A staged job resource
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"data","type":"`Record<string, unknown>`","description":"Data necessary for the job","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The staged job's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The staged job's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"Data necessary for the job","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="StagedJob"/>

www/apps/docs/content/references/entities/classes/entities.Store.mdx

@@ -11,4 +11,4 @@ A store holds the main settings of the commerce shop. By default, only one store
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currencies","type":"[Currency](entities.Currency.mdx)[]","description":"The details of the enabled currencies in the store.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"default_currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the store's default currency.","optional":false,"defaultValue":"usd","expandable":true,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"default_currency_code","type":"`string`","description":"The three character currency code that is the default of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`string`","description":"The location ID the store is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel","type":"[SalesChannel](entities.SalesChannel.mdx)","description":"The details of the store's default sales channel.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"carts","type":"[Cart](entities.Cart.mdx)[]","description":"The associated carts.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The sales channel's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Specify if the sales channel is enabled or disabled.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"locations","type":"[SalesChannelLocation](entities.SalesChannelLocation.mdx)[]","description":"The details of the stock locations related to the sales channel.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](entities.Order.mdx)[]","description":"The associated orders.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"publishableKeys","type":"[PublishableApiKey](entities.PublishableApiKey.mdx)[]","descripLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The store's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Store - this may be displayed to the Customer.","optional":false,"defaultValue":"Medusa Store","expandable":false,"children":[]},{"name":"default_currency_code","type":"`string`","description":"The three character currency code that is the default of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the store's default currency.","optional":false,"defaultValue":"usd","expandable":true,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"currencies","type":"[Currency](entities.Currency.mdx)[]","description":"The details of the enabled currencies in the store.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"swap_link_template","type":"`null` \\| `string`","description":"A template to generate Swap links from. Use &#123;&#123;cart\\_id&#125;&#125; to include the Swap's `cart\\_id` in the link.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_link_template","type":"`null` \\| `string`","description":"A template to generate Payment links from. Use &#123;&#123;cart\\_id&#125;&#125; to include the payment's `cart\\_id` in the link.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invite_link_template","type":"`null` \\| `string`","description":"A template to generate Invite links from","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`string`","description":"The location ID the store is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel_id","type":"`null` \\| `string`","description":"The ID of the store's default sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"default_sales_channel","type":"[SalesChannel](entities.SalesChannel.mdx)","description":"The details of the store's default sales channel.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The sales channel's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":falsLine truncated

www/apps/docs/content/references/entities/classes/entities.Swap.mdx

@@ -11,4 +11,4 @@ A swap can be created when a Customer wishes to exchange Products that they have
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"additional_items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The details of the new products to send to the customer, represented as line items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"If true, swaps can be completed with items out of stock","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the Swap was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the Swap was confirmed by the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[SwapFulfillmentStatus](../enums/entities.SwapFulfillmentStatus.mdx)","description":"The status of the Fulfillment of the Swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](entities.Fulfillment.mdx)[]","description":"The details of the fulfillments that are used to send the new items to the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The swap's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the swap in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true, no notification will be sent related to this swap","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](entities.Payment.mdx)","description":"The details of the additional payment authorized by the customer when `difference\\_due` is positive.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_status","type":"[SwapPaymentStatus](../enums/entities.SwapPaymentStatus.mdx)","description":"The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](entities.Return.mdx)","description":"The details of the return that belongs to the swap, which holds the details on the items being returned.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address","type":"[Address](entities.Address.mdx)","description":"The details of the shipping address that the new items should be sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used to Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The swap's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[SwapFulfillmentStatus](../enums/entities.SwapFulfillmentStatus.mdx)","description":"The status of the Fulfillment of the Swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[SwapPaymentStatus](../enums/entities.SwapPaymentStatus.mdx)","description":"The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"additional_items","type":"[LineItem](entities.LineItem.mdx)[]","description":"The details of the new products to send to the customer, represented as line items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"return_order","type":"[Return](entities.Return.mdx)","description":"The details of the return that belongs to the swap, which holds the details on the items being returned.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillments","type":"[Fulfillment](entities.Fulfillment.mdx)[]","description":"The details of the fulfillments that are used to send the new items to the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment","type":"[Payment](entities.Payment.mdx)","description":"The details of the additional payment authorized by the customer when `difference\\_due` is positive.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"difference_due","type":"`number`","description":"The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](entities.Address.mdx)","description":"The details of the shipping address that the new items should be sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used to fulfill the additional items purchased.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](entities.Cart.mdx)","description":"The details of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the Swap was confirmed by the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the Swap was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true, no notification will be sent related to this swap","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"If true, swaps can be completed with items out of stock","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion ofLine truncated

www/apps/docs/content/references/entities/classes/entities.TaxProvider.mdx

@@ -11,4 +11,4 @@ A tax provider represents a tax service installed in the Medusa backend, either
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the tax provider as given by the tax service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_installed","type":"`boolean`","description":"Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is\\_installed` attribute is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The ID of the tax provider as given by the tax service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_installed","type":"`boolean`","description":"Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is\\_installed` attribute is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="TaxProvider"/>

www/apps/docs/content/references/entities/classes/entities.TaxRate.mdx

@@ -11,4 +11,4 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"code","type":"`null` \\| `string`","description":"A code to identify the tax type by","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The tax rate's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"A human friendly name for the tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_types","type":"[ProductType](entities.ProductType.mdx)[]","description":"The details of the product types that belong to this tax rate.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product type's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Type represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"products","type":"[Product](entities.Product.mdx)[]","description":"The details of the products that belong to this tax rate.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`booleLine truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The tax rate's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The numeric rate to charge","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"A code to identify the tax type by","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"A human friendly name for the tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region that the rate belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region that the rate belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultVaLine truncated

www/apps/docs/content/references/entities/classes/entities.TrackingLink.mdx

@@ -11,4 +11,4 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"[Fulfillment](entities.Fulfillment.mdx)","description":"The details of the fulfillment that the tracking link belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the Fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the Claim that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"This contains all the data necessary for the Fulfillment provider to handle the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The fulfillment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the fulfillment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItem](entities.FulfillmentItem.mdx)[]","description":"The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"location_id","type":"`null` \\| `string`","description":"The ID of the stock location the fulfillment will be shipped from","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be sent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the Order that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)","description":"The details of the fulfillment provider responsible for handling the fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the Fulfillment Provider responsible for handling the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`Date`","description":"The date with timezone at which the Fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](entities.Swap.mdx)","description":"The details of the swap that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the Swap that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_links","type":"[TrackingLink](entities.TrackingLink.mdx)[]","description":"The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tracking_numbers","type":"`string`[]","description":"The tracking numbers that can be used to track the status of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fulfillment_id","type":"`string`","description":"The ID of the fulfillment that Line truncated
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The tracking link's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL at which the status of the shipment can be tracked.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_number","type":"`string`","description":"The tracking number given by the shipping carrier.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_id","type":"`string`","description":"The ID of the fulfillment that the tracking link belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment","type":"[Fulfillment](entities.Fulfillment.mdx)","description":"The details of the fulfillment that the tracking link belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The fulfillment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the Claim that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](entities.ClaimOrder.mdx)","description":"The details of the claim that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the Swap that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](entities.Swap.mdx)","description":"The details of the swap that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the Order that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](entities.Order.mdx)","description":"The details of the order that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be sent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the Fulfillment Provider responsible for handling the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`null` \\| `string`","description":"The ID of the stock location the fulfillment will be shipped from","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProvider](entities.FulfillmentProvider.mdx)","description":"The details of the fulfillment provider responsible for handling the fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"items","type":"[FulfillmentItem](entities.FulfillmentItem.mdx)[]","description":"The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tracking_links","type":"[TrackingLink](entities.TrackingLink.mdx)[]","description":"The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tracking_numbers","type":"`string`[]","description":"The tracking numbers that can be used to track the status of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record<string, unknown>`","description":"This contains all the data necessary for the Fulfillment provider to handle the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"nameLine truncated

www/apps/docs/content/references/entities/classes/entities.User.mdx

@@ -11,4 +11,4 @@ A User is an administrator who can manage store settings and data.
 
 ## Properties
 
-<ParameterTypes parameters={[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[{"name":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
+<ParameterTypes parameters={[{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[{"name":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="User"/>

www/apps/docs/content/references/entities/enums/entities.AllocationType.mdx

@@ -10,14 +10,14 @@ The scope that the discount should apply to.
 
 ## Enumeration Members
 
-### ITEM
-
- **ITEM** = `"item"`
-
-The discount should be applied to applicable items in the cart.
-
 ### TOTAL
 
  **TOTAL** = `"total"`
 
 The discount should be applied to the checkout total.
+
+### ITEM
+
+ **ITEM** = `"item"`
+
+The discount should be applied to applicable items in the cart.

www/apps/docs/content/references/entities/enums/entities.CartType.mdx

@@ -8,14 +8,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
 ## Enumeration Members
 
-### CLAIM
-
- **CLAIM** = `"claim"`
-
 ### DEFAULT
 
  **DEFAULT** = `"default"`
 
+### SWAP
+
+ **SWAP** = `"swap"`
+
 ### DRAFT\_ORDER
 
  **DRAFT\_ORDER** = `"draft_order"`
@@ -24,6 +24,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
  **PAYMENT\_LINK** = `"payment_link"`
 
-### SWAP
+### CLAIM
 
- **SWAP** = `"swap"`
+ **CLAIM** = `"claim"`

www/apps/docs/content/references/entities/enums/entities.ClaimFulfillmentStatus.mdx

@@ -10,18 +10,6 @@ The claim's fulfillment status.
 
 ## Enumeration Members
 
-### CANCELED
-
- **CANCELED** = `"canceled"`
-
-The claim's fulfillments are canceled.
-
-### FULFILLED
-
- **FULFILLED** = `"fulfilled"`
-
-The claim's replacement items are fulfilled.
-
 ### NOT\_FULFILLED
 
  **NOT\_FULFILLED** = `"not_fulfilled"`
@@ -34,11 +22,11 @@ The claim's replacement items are not fulfilled.
 
 Some of the claim's replacement items, but not all, are fulfilled.
 
-### PARTIALLY\_RETURNED
+### FULFILLED
 
- **PARTIALLY\_RETURNED** = `"partially_returned"`
+ **FULFILLED** = `"fulfilled"`
 
-Some of the claim's items, but not all, are returned.
+The claim's replacement items are fulfilled.
 
 ### PARTIALLY\_SHIPPED
 
@@ -46,11 +34,17 @@ Some of the claim's items, but not all, are returned.
 
 Some of the claim's replacement items, but not all, are shipped.
 
-### REQUIRES\_ACTION
+### SHIPPED
 
- **REQUIRES\_ACTION** = `"requires_action"`
+ **SHIPPED** = `"shipped"`
 
-The claim's fulfillment requires action.
+The claim's replacement items are shipped.
+
+### PARTIALLY\_RETURNED
+
+ **PARTIALLY\_RETURNED** = `"partially_returned"`
+
+Some of the claim's items, but not all, are returned.
 
 ### RETURNED
 
@@ -58,8 +52,14 @@ The claim's fulfillment requires action.
 
 The claim's items are returned.
 
-### SHIPPED
+### CANCELED
 
- **SHIPPED** = `"shipped"`
+ **CANCELED** = `"canceled"`
 
-The claim's replacement items are shipped.
+The claim's fulfillments are canceled.
+
+### REQUIRES\_ACTION
+
+ **REQUIRES\_ACTION** = `"requires_action"`
+
+The claim's fulfillment requires action.

www/apps/docs/content/references/entities/enums/entities.ClaimReason.mdx

@@ -12,14 +12,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 
  **MISSING\_ITEM** = `"missing_item"`
 
-### OTHER
+### WRONG\_ITEM
 
- **OTHER** = `"other"`
+ **WRONG\_ITEM** = `"wrong_item"`
 
 ### PRODUCTION\_FAILURE
 
  **PRODUCTION\_FAILURE** = `"production_failure"`
 
-### WRONG\_ITEM
+### OTHER
 
- **WRONG\_ITEM** = `"wrong_item"`
+ **OTHER** = `"other"`

www/apps/docs/content/references/entities/enums/entities.DiscountConditionType.mdx

@@ -10,18 +10,18 @@ The discount condition's type.
 
 ## Enumeration Members
 
-### CUSTOMER\_GROUPS
-
- **CUSTOMER\_GROUPS** = `"customer_groups"`
-
-The discount condition is used for customer groups.
-
 ### PRODUCTS
 
  **PRODUCTS** = `"products"`
 
 The discount condition is used for products.
 
+### PRODUCT\_TYPES
+
+ **PRODUCT\_TYPES** = `"product_types"`
+
+The discount condition is used for product types.
+
 ### PRODUCT\_COLLECTIONS
 
  **PRODUCT\_COLLECTIONS** = `"product_collections"`
@@ -34,8 +34,8 @@ The discount condition is used for product collections.
 
 The discount condition is used for product tags.
 
-### PRODUCT\_TYPES
+### CUSTOMER\_GROUPS
 
- **PRODUCT\_TYPES** = `"product_types"`
+ **CUSTOMER\_GROUPS** = `"customer_groups"`
 
-The discount condition is used for product types.
+The discount condition is used for customer groups.

www/apps/docs/content/references/entities/enums/entities.DiscountRuleType.mdx

@@ -16,14 +16,14 @@ The possible types of discount rules.
 
 Discounts that reduce the price by a fixed amount.
 
-### FREE\_SHIPPING
-
- **FREE\_SHIPPING** = `"free_shipping"`
-
-Discounts that sets the shipping price to `0`.
-
 ### PERCENTAGE
 
  **PERCENTAGE** = `"percentage"`
 
 Discounts that reduce the price by a percentage reduction.
+
+### FREE\_SHIPPING
+
+ **FREE\_SHIPPING** = `"free_shipping"`
+
+Discounts that sets the shipping price to `0`.

www/apps/docs/content/references/entities/enums/entities.DraftOrderStatus.mdx

@@ -10,14 +10,14 @@ The draft order's status.
 
 ## Enumeration Members
 
-### COMPLETED
-
- **COMPLETED** = `"completed"`
-
-The draft order is completed, and an order has been created from it.
-
 ### OPEN
 
  **OPEN** = `"open"`
 
 The draft order is open.
+
+### COMPLETED
+
+ **COMPLETED** = `"completed"`
+
+The draft order is completed, and an order has been created from it.

www/apps/docs/content/references/entities/enums/entities.FulfillmentStatus.mdx

@@ -10,18 +10,6 @@ The order's fulfillment status.
 
 ## Enumeration Members
 
-### CANCELED
-
- **CANCELED** = `"canceled"`
-
-The order's fulfillments are canceled.
-
-### FULFILLED
-
- **FULFILLED** = `"fulfilled"`
-
-The order's items are fulfilled.
-
 ### NOT\_FULFILLED
 
  **NOT\_FULFILLED** = `"not_fulfilled"`
@@ -34,11 +22,11 @@ The order's items are not fulfilled.
 
 Some of the order's items, but not all, are fulfilled.
 
-### PARTIALLY\_RETURNED
+### FULFILLED
 
- **PARTIALLY\_RETURNED** = `"partially_returned"`
+ **FULFILLED** = `"fulfilled"`
 
-Some of the order's items, but not all, are returned.
+The order's items are fulfilled.
 
 ### PARTIALLY\_SHIPPED
 
@@ -46,11 +34,17 @@ Some of the order's items, but not all, are returned.
 
 Some of the order's items, but not all, are shipped.
 
-### REQUIRES\_ACTION
+### SHIPPED
 
- **REQUIRES\_ACTION** = `"requires_action"`
+ **SHIPPED** = `"shipped"`
 
-The order's fulfillment requires action.
+The order's items are shipped.
+
+### PARTIALLY\_RETURNED
+
+ **PARTIALLY\_RETURNED** = `"partially_returned"`
+
+Some of the order's items, but not all, are returned.
 
 ### RETURNED
 
@@ -58,8 +52,14 @@ The order's fulfillment requires action.
 
 The order's items are returned.
 
-### SHIPPED
+### CANCELED
 
- **SHIPPED** = `"shipped"`
+ **CANCELED** = `"canceled"`
 
-The order's items are shipped.
+The order's fulfillments are canceled.
+
+### REQUIRES\_ACTION
+
+ **REQUIRES\_ACTION** = `"requires_action"`
+
+The order's fulfillment requires action.

www/apps/docs/content/references/entities/enums/entities.OrderEditStatus.mdx

@@ -10,24 +10,12 @@ The order edit's status.
 
 ## Enumeration Members
 
-### CANCELED
-
- **CANCELED** = `"canceled"`
-
-The order edit is canceled.
-
 ### CONFIRMED
 
  **CONFIRMED** = `"confirmed"`
 
 The order edit is confirmed.
 
-### CREATED
-
- **CREATED** = `"created"`
-
-The order edit is created.
-
 ### DECLINED
 
  **DECLINED** = `"declined"`
@@ -39,3 +27,15 @@ The order edit is declined.
  **REQUESTED** = `"requested"`
 
 The order edit is requested.
+
+### CREATED
+
+ **CREATED** = `"created"`
+
+The order edit is created.
+
+### CANCELED
+
+ **CANCELED** = `"canceled"`
+
+The order edit is canceled.

www/apps/docs/content/references/entities/enums/entities.OrderStatus.mdx

@@ -10,6 +10,20 @@ The order's status.
 
 ## Enumeration Members
 
+### PENDING
+
+ **PENDING** = `"pending"`
+
+The order is pending.
+
+### COMPLETED
+
+ **COMPLETED** = `"completed"`
+
+The order is completed, meaning that
+the items have been fulfilled and the payment
+has been captured.
+
 ### ARCHIVED
 
  **ARCHIVED** = `"archived"`
@@ -22,20 +36,6 @@ The order is archived.
 
 The order is canceled.
 
-### COMPLETED
-
- **COMPLETED** = `"completed"`
-
-The order is completed, meaning that
-the items have been fulfilled and the payment
-has been captured.
-
-### PENDING
-
- **PENDING** = `"pending"`
-
-The order is pending.
-
 ### REQUIRES\_ACTION
 
  **REQUIRES\_ACTION** = `"requires_action"`

www/apps/docs/content/references/entities/enums/entities.PaymentCollectionStatus.mdx

@@ -10,11 +10,11 @@ The payment collection's status.
 
 ## Enumeration Members
 
-### AUTHORIZED
+### NOT\_PAID
 
- **AUTHORIZED** = `"authorized"`
+ **NOT\_PAID** = `"not_paid"`
 
-The payment colleciton is authorized.
+The payment collection isn't paid.
 
 ### AWAITING
 
@@ -22,20 +22,20 @@ The payment colleciton is authorized.
 
 The payment collection is awaiting payment.
 
-### CANCELED
+### AUTHORIZED
 
- **CANCELED** = `"canceled"`
+ **AUTHORIZED** = `"authorized"`
 
-The payment collection is canceled.
-
-### NOT\_PAID
-
- **NOT\_PAID** = `"not_paid"`
-
-The payment collection isn't paid.
+The payment colleciton is authorized.
 
 ### PARTIALLY\_AUTHORIZED
 
  **PARTIALLY\_AUTHORIZED** = `"partially_authorized"`
 
 Some of the payments in the payment collection are authorized.
+
+### CANCELED
+
+ **CANCELED** = `"canceled"`
+
+The payment collection is canceled.

www/apps/docs/content/references/entities/enums/entities.PaymentSessionStatus.mdx

@@ -16,18 +16,6 @@ The status of a payment session.
 
 The payment is authorized.
 
-### CANCELED
-
- **CANCELED** = `"canceled"`
-
-The payment is canceled.
-
-### ERROR
-
- **ERROR** = `"error"`
-
-An error occurred while processing the payment.
-
 ### PENDING
 
  **PENDING** = `"pending"`
@@ -39,3 +27,15 @@ The payment is pending.
  **REQUIRES\_MORE** = `"requires_more"`
 
 The payment requires an action.
+
+### ERROR
+
+ **ERROR** = `"error"`
+
+An error occurred while processing the payment.
+
+### CANCELED
+
+ **CANCELED** = `"canceled"`
+
+The payment is canceled.

www/apps/docs/content/references/entities/enums/entities.PaymentStatus.mdx

@@ -10,30 +10,24 @@ The order's payment status.
 
 ## Enumeration Members
 
+### NOT\_PAID
+
+ **NOT\_PAID** = `"not_paid"`
+
+The order's payment is not paid.
+
 ### AWAITING
 
  **AWAITING** = `"awaiting"`
 
 The order's payment is awaiting capturing.
 
-### CANCELED
-
- **CANCELED** = `"canceled"`
-
-The order's payment is canceled.
-
 ### CAPTURED
 
  **CAPTURED** = `"captured"`
 
 The order's payment is captured.
 
-### NOT\_PAID
-
- **NOT\_PAID** = `"not_paid"`
-
-The order's payment is not paid.
-
 ### PARTIALLY\_REFUNDED
 
  **PARTIALLY\_REFUNDED** = `"partially_refunded"`
@@ -46,6 +40,12 @@ Some of the order's payment amount is refunded.
 
 The order's payment amount is refunded.
 
+### CANCELED
+
+ **CANCELED** = `"canceled"`
+
+The order's payment is canceled.
+
 ### REQUIRES\_ACTION
 
  **REQUIRES\_ACTION** = `"requires_action"`

www/apps/docs/content/references/entities/enums/entities.RefundReason.mdx

@@ -10,24 +10,12 @@ The reason of the refund.
 
 ## Enumeration Members
 
-### CLAIM
-
- **CLAIM** = `"claim"`
-
-The refund is applied because of a created claim.
-
 ### DISCOUNT
 
  **DISCOUNT** = `"discount"`
 
 The refund is applied as a discount.
 
-### OTHER
-
- **OTHER** = `"other"`
-
-The refund is created for a custom reason.
-
 ### RETURN
 
  **RETURN** = `"return"`
@@ -39,3 +27,15 @@ The refund is applied because of a created return.
  **SWAP** = `"swap"`
 
 The refund is applied because of a created swap.
+
+### CLAIM
+
+ **CLAIM** = `"claim"`
+
+The refund is applied because of a created claim.
+
+### OTHER
+
+ **OTHER** = `"other"`
+
+The refund is created for a custom reason.

www/apps/docs/content/references/entities/enums/entities.RequirementType.mdx

@@ -10,14 +10,14 @@ The type of shipping option requirement.
 
 ## Enumeration Members
 
-### MAX\_SUBTOTAL
-
- **MAX\_SUBTOTAL** = `"max_subtotal"`
-
-The shipping option can only be applied if the subtotal is less than the requirement's amont.
-
 ### MIN\_SUBTOTAL
 
  **MIN\_SUBTOTAL** = `"min_subtotal"`
 
 The shipping option can only be applied if the subtotal is greater than the requirement's amount.
+
+### MAX\_SUBTOTAL
+
+ **MAX\_SUBTOTAL** = `"max_subtotal"`
+
+The shipping option can only be applied if the subtotal is less than the requirement's amont.

www/apps/docs/content/references/entities/enums/entities.ReturnStatus.mdx

@@ -10,11 +10,11 @@ The return's status.
 
 ## Enumeration Members
 
-### CANCELED
+### REQUESTED
 
- **CANCELED** = `"canceled"`
+ **REQUESTED** = `"requested"`
 
-The return is canceled.
+The return is requested.
 
 ### RECEIVED
 
@@ -22,14 +22,14 @@ The return is canceled.
 
 The return is received.
 
-### REQUESTED
-
- **REQUESTED** = `"requested"`
-
-The return is requested.
-
 ### REQUIRES\_ACTION
 
  **REQUIRES\_ACTION** = `"requires_action"`
 
 The return is awaiting action.
+
+### CANCELED
+
+ **CANCELED** = `"canceled"`
+
+The return is canceled.

www/apps/docs/content/references/entities/enums/entities.ShippingOptionPriceType.mdx

@@ -10,14 +10,14 @@ The type of the shipping option price.
 
 ## Enumeration Members
 
-### CALCULATED
-
- **CALCULATED** = `"calculated"`
-
-The shipping option's price is calculated. In this case, the `amount` field is typically `null`.
-
 ### FLAT\_RATE
 
  **FLAT\_RATE** = `"flat_rate"`
 
 The shipping option's price is a flat rate.
+
+### CALCULATED
+
+ **CALCULATED** = `"calculated"`
+
+The shipping option's price is calculated. In this case, the `amount` field is typically `null`.

www/apps/docs/content/references/entities/enums/entities.ShippingProfileType.mdx

@@ -10,12 +10,6 @@ The shipping profile's type.
 
 ## Enumeration Members
 
-### CUSTOM
-
- **CUSTOM** = `"custom"`
-
-The profile used to ship custom items.
-
 ### DEFAULT
 
  **DEFAULT** = `"default"`
@@ -27,3 +21,9 @@ The default profile used to ship item.
  **GIFT\_CARD** = `"gift_card"`
 
 The profile used to ship gift cards.
+
+### CUSTOM
+
+ **CUSTOM** = `"custom"`
+
+The profile used to ship custom items.

www/apps/docs/content/references/entities/enums/entities.SwapFulfillmentStatus.mdx

@@ -10,11 +10,11 @@ The swap's fulfillment status.
 
 ## Enumeration Members
 
-### CANCELED
+### NOT\_FULFILLED
 
- **CANCELED** = `"canceled"`
+ **NOT\_FULFILLED** = `"not_fulfilled"`
 
-The swap's fulfillments are canceled.
+The swap's items aren't fulfilled.
 
 ### FULFILLED
 
@@ -22,11 +22,11 @@ The swap's fulfillments are canceled.
 
 The swap's items are fulfilled.
 
-### NOT\_FULFILLED
+### SHIPPED
 
- **NOT\_FULFILLED** = `"not_fulfilled"`
+ **SHIPPED** = `"shipped"`
 
-The swap's items aren't fulfilled.
+The swap's items are shipped.
 
 ### PARTIALLY\_SHIPPED
 
@@ -34,14 +34,14 @@ The swap's items aren't fulfilled.
 
 Some of the swap's items are shipped.
 
+### CANCELED
+
+ **CANCELED** = `"canceled"`
+
+The swap's fulfillments are canceled.
+
 ### REQUIRES\_ACTION
 
  **REQUIRES\_ACTION** = `"requires_action"`
 
 The swap's fulfillments require an action.
-
-### SHIPPED
-
- **SHIPPED** = `"shipped"`
-
-The swap's items are shipped.

www/apps/docs/content/references/entities/enums/entities.SwapPaymentStatus.mdx

@@ -10,18 +10,18 @@ The swap's payment status.
 
 ## Enumeration Members
 
+### NOT\_PAID
+
+ **NOT\_PAID** = `"not_paid"`
+
+The swap's additional payment isn't paid.
+
 ### AWAITING
 
  **AWAITING** = `"awaiting"`
 
 The swap is additional awaiting payment.
 
-### CANCELED
-
- **CANCELED** = `"canceled"`
-
-The swap's additional payment is canceled.
-
 ### CAPTURED
 
  **CAPTURED** = `"captured"`
@@ -34,18 +34,18 @@ The swap's additional payment is captured.
 
 The swap's additional payment is confirmed.
 
+### CANCELED
+
+ **CANCELED** = `"canceled"`
+
+The swap's additional payment is canceled.
+
 ### DIFFERENCE\_REFUNDED
 
  **DIFFERENCE\_REFUNDED** = `"difference_refunded"`
 
 The negative difference amount between the returned item(s) and the new one(s) has been refuneded.
 
-### NOT\_PAID
-
- **NOT\_PAID** = `"not_paid"`
-
-The swap's additional payment isn't paid.
-
 ### PARTIALLY\_REFUNDED
 
  **PARTIALLY\_REFUNDED** = `"partially_refunded"`