asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: general fixes to references (#5653)

Browse Source 
* fixed typedoc plugin's escape strategy

* move props comments to the associated property

* regenerate references
This commit is contained in:
Shahed Nasser
2023-11-17 19:36:58 +02:00
committed by GitHub
parent b3093c3e3d
commit c51dce164d
869 changed files with 15238 additions and 7267 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/classes/AbstractBatchJobStrategy.mdx
+1 -1
View File
@@ -495,7 +495,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/AbstractNotificationService.mdx
+1 -1
View File
@@ -349,7 +349,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/AbstractPaymentService.mdx
+1 -1
View File
@@ -696,7 +696,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/AbstractSearchService.mdx
+1 -1
View File
@@ -388,7 +388,7 @@ Used to search for a document in an index
},
{
"name": "query",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "the search query",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/Address.mdx
+14 -14
View File
@@ -21,7 +21,7 @@ An address is used across the Medusa backend within other schemas and object typ
<ParameterTypes parameters={[
{
"name": "address_1",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Address line 1",
"optional": false,
"defaultValue": "",
@@ -30,7 +30,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "address_2",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Address line 2",
"optional": false,
"defaultValue": "",
@@ -39,7 +39,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "city",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "City",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "company",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Company name",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "country",
"type": "``null`` \\| [Country](Country.mdx)",
"type": "`null` \\| [Country](Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "country_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The 2 character ISO code of the country in lower case",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "customer",
"type": "``null`` \\| [Customer](Customer.mdx)",
"type": "`null` \\| [Customer](Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "customer_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "ID of the customer this address belongs to",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "first_name",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "First name",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "last_name",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Last name",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "phone",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Phone Number",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "postal_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Postal Code",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "province",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Province",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/AnalyticsConfig.mdx
+1 -1
View File
@@ -37,7 +37,7 @@ Base abstract entity for all entities
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/AnalyticsConfigService.mdx
+1 -1
View File
@@ -327,7 +327,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/AuthService.mdx
+1 -1
View File
@@ -389,7 +389,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/BatchJob.mdx
+3 -3
View File
@@ -66,7 +66,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the batch job.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -138,7 +138,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "result",
"type": "`&#123; advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../types/BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../types/BatchJobResultStatDescriptor.mdx)[] &#125;` & `Record<string, unknown>`",
"type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../types/BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../types/BatchJobResultStatDescriptor.mdx)[] }`` & `Record<string, unknown>`",
"description": "The result of the batch job.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/BatchJobService.mdx
+2 -2
View File
@@ -701,7 +701,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -746,7 +746,7 @@ ___
},
{
"name": "data",
"type": "[Partial](../types/Partial.mdx)&#60;[Pick](../types/Pick.mdx)&#60;[BatchJob](BatchJob.mdx), `\"context\"` \\| `\"result\"`&#62;&#62;",
"type": "[Partial](../types/Partial.mdx)&#60;[Pick](../types/Pick.mdx)&#60;[BatchJob](BatchJob.mdx), \"context\" \\| \"result\"&#62;&#62;",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/Cart.mdx
+8 -8
View File
@@ -84,7 +84,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -192,7 +192,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "object",
"type": "``\"cart\"``",
"type": "`\"cart\"`",
"description": "",
"optional": false,
"defaultValue": "\"cart\"",
@@ -228,7 +228,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -300,7 +300,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -309,7 +309,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](Address.mdx)",
"type": "`null` \\| [Address](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -336,7 +336,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -363,7 +363,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/classes/CartService.mdx
+14 -14
View File
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "cartRepository_",
"type": "Repository&#60;[Cart](Cart.mdx)&#62; & `&#123; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations &#125;`",
"type": "Repository&#60;[Cart](Cart.mdx)&#62; & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -139,7 +139,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "lineItemRepository_",
"type": "Repository&#60;[LineItem](LineItem.mdx)&#62; & `&#123; findByReturn: Method findByReturn &#125;`",
"type": "Repository&#60;[LineItem](LineItem.mdx)&#62; & ``{ findByReturn: Method findByReturn }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -872,7 +872,7 @@ set the payment on the cart.
},
{
"name": "context",
"type": "`Record<string, unknown>` & `&#123; cart_id: string &#125;`",
"type": "`Record<string, unknown>` & ``{ cart_id: string }``",
"description": "object containing whatever is relevant for authorizing the payment with the payment provider. As an example, this could be IP address or similar for fraud handling.",
"optional": false,
"defaultValue": "",
@@ -1013,7 +1013,7 @@ ___
### decorateTotals
`**decorateTotals**(cart, totalsConfig?): Promise&#60;[WithRequiredProperty](../types/WithRequiredProperty.mdx)&#60;[Cart](Cart.mdx), `"total"`&#62;&#62;`
`**decorateTotals**(cart, totalsConfig?): Promise&#60;[WithRequiredProperty](../types/WithRequiredProperty.mdx)&#60;[Cart](Cart.mdx), "total"&#62;&#62;`
#### Parameters
@@ -1040,12 +1040,12 @@ ___
#### Returns
Promise&#60;[WithRequiredProperty](../types/WithRequiredProperty.mdx)&#60;[Cart](Cart.mdx), `"total"`&#62;&#62;
Promise&#60;[WithRequiredProperty](../types/WithRequiredProperty.mdx)&#60;[Cart](Cart.mdx), "total"&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[WithRequiredProperty](../types/WithRequiredProperty.mdx)&#60;[Cart](Cart.mdx), `\"total\"`&#62;&#62;",
"type": "Promise&#60;[WithRequiredProperty](../types/WithRequiredProperty.mdx)&#60;[Cart](Cart.mdx), \"total\"&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1738,7 +1738,7 @@ ___
### retrieveWithTotals
`**retrieveWithTotals**(cartId, options?, totalsConfig?): Promise&#60;[WithRequiredProperty](../types/WithRequiredProperty.mdx)&#60;[Cart](Cart.mdx), `"total"`&#62;&#62;`
`**retrieveWithTotals**(cartId, options?, totalsConfig?): Promise&#60;[WithRequiredProperty](../types/WithRequiredProperty.mdx)&#60;[Cart](Cart.mdx), "total"&#62;&#62;`
#### Parameters
@@ -1774,12 +1774,12 @@ ___
#### Returns
Promise&#60;[WithRequiredProperty](../types/WithRequiredProperty.mdx)&#60;[Cart](Cart.mdx), `"total"`&#62;&#62;
Promise&#60;[WithRequiredProperty](../types/WithRequiredProperty.mdx)&#60;[Cart](Cart.mdx), "total"&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[WithRequiredProperty](../types/WithRequiredProperty.mdx)&#60;[Cart](Cart.mdx), `\"total\"`&#62;&#62;",
"type": "Promise&#60;[WithRequiredProperty](../types/WithRequiredProperty.mdx)&#60;[Cart](Cart.mdx), \"total\"&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1966,7 +1966,7 @@ Set's the region of a cart.
},
{
"name": "countryCode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "the country code to set the country to",
"optional": false,
"defaultValue": "",
@@ -2002,7 +2002,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2049,12 +2049,12 @@ ___
#### Returns
[FindConfig](../interfaces/FindConfig.mdx)&#60;[Cart](Cart.mdx)&#62; & `&#123; totalsToSelect: [TotalField](../types/TotalField.mdx)[] &#125;`
[FindConfig](../interfaces/FindConfig.mdx)&#60;[Cart](Cart.mdx)&#62; & ``{ totalsToSelect: [TotalField](../types/TotalField.mdx)[] }``
<ParameterTypes parameters={[
{
"name": "FindConfig&#60;Cart&#62; & &#123; totalsToSelect: TotalField[] &#125;",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Cart](Cart.mdx)&#62; & `&#123; totalsToSelect: [TotalField](../types/TotalField.mdx)[] &#125;`",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Cart](Cart.mdx)&#62; & ``{ totalsToSelect: [TotalField](../types/TotalField.mdx)[] }``",
"optional": true,
"defaultValue": "",
"description": "",
@@ -2446,7 +2446,7 @@ Check if line item's variant belongs to the cart's sales channel.
},
{
"name": "sales_channel_id.sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ClaimImage.mdx
+1 -1
View File
@@ -48,7 +48,7 @@ The details of an image attached to a claim.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ClaimItem.mdx
+1 -1
View File
@@ -48,7 +48,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ClaimItemService.mdx
+1 -1
View File
@@ -397,7 +397,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ClaimService.mdx
+3 -3
View File
@@ -112,7 +112,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "lineItemRepository_",
"type": "Repository&#60;[LineItem](LineItem.mdx)&#62; & `&#123; findByReturn: Method findByReturn &#125;`",
"type": "Repository&#60;[LineItem](LineItem.mdx)&#62; & ``{ findByReturn: Method findByReturn }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -597,7 +597,7 @@ ___
},
{
"name": "trackingLinks",
"type": "`&#123; tracking_number: string &#125;`[]",
"type": "``{ tracking_number: string }``[]",
"description": "",
"optional": false,
"defaultValue": "[]",
@@ -840,7 +840,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ClaimTag.mdx
+1 -1
View File
@@ -30,7 +30,7 @@ Claim Tags are user defined tags that can be assigned to claim items for easy fi
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/Country.mdx
+1 -1
View File
@@ -84,7 +84,7 @@ Country details
},
{
"name": "region_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The region ID this country is associated with.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/CurrencyService.mdx
+1 -1
View File
@@ -319,7 +319,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/CustomShippingOption.mdx
+1 -1
View File
@@ -48,7 +48,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/CustomShippingOptionService.mdx
+1 -1
View File
@@ -350,7 +350,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/Customer.mdx
+2 -2
View File
@@ -30,7 +30,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/CustomerGroup.mdx
+1 -1
View File
@@ -39,7 +39,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/CustomerGroupService.mdx
+4 -4
View File
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "customerGroupRepository_",
"type": "Repository&#60;[CustomerGroup](CustomerGroup.mdx)&#62; & `&#123; addCustomers: Method addCustomers ; findWithRelationsAndCount: Method findWithRelationsAndCount ; removeCustomers: Method removeCustomers &#125;`",
"type": "Repository&#60;[CustomerGroup](CustomerGroup.mdx)&#62; & ``{ addCustomers: Method addCustomers ; findWithRelationsAndCount: Method findWithRelationsAndCount ; removeCustomers: Method removeCustomers }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -385,7 +385,7 @@ List customer groups.
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../types/Selector.mdx)&#60;[CustomerGroup](CustomerGroup.mdx)&#62; & `&#123; discount_condition_id?: string ; q?: string &#125;`",
"type": "[Selector](../types/Selector.mdx)&#60;[CustomerGroup](CustomerGroup.mdx)&#62; & ``{ discount_condition_id?: string ; q?: string }``",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
@@ -432,7 +432,7 @@ Retrieve a list of customer groups and total count of records that match the que
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../types/Selector.mdx)&#60;[CustomerGroup](CustomerGroup.mdx)&#62; & `&#123; discount_condition_id?: string ; q?: string &#125;`",
"type": "[Selector](../types/Selector.mdx)&#60;[CustomerGroup](CustomerGroup.mdx)&#62; & ``{ discount_condition_id?: string ; q?: string }``",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
@@ -569,7 +569,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/CustomerService.mdx
+4 -4
View File
@@ -69,7 +69,7 @@ Provides layer to manipulate customers.
},
{
"name": "customerRepository_",
"type": "Repository&#60;[Customer](Customer.mdx)&#62; & `&#123; listAndCount: Method listAndCount &#125;`",
"type": "Repository&#60;[Customer](Customer.mdx)&#62; & ``{ listAndCount: Method listAndCount }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -481,7 +481,7 @@ ___
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../types/Selector.mdx)&#60;[Customer](Customer.mdx)&#62; & `&#123; groups?: string[] ; q?: string &#125;`",
"type": "[Selector](../types/Selector.mdx)&#60;[Customer](Customer.mdx)&#62; & ``{ groups?: string[] ; q?: string }``",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
@@ -526,7 +526,7 @@ ___
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../types/Selector.mdx)&#60;[Customer](Customer.mdx)&#62; & `&#123; groups?: string[] ; q?: string &#125;`",
"type": "[Selector](../types/Selector.mdx)&#60;[Customer](Customer.mdx)&#62; & ``{ groups?: string[] ; q?: string }``",
"description": "the query object for find",
"optional": false,
"defaultValue": "",
@@ -939,7 +939,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/Discount.mdx
+4 -4
View File
@@ -39,7 +39,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/DiscountCondition.mdx
+1 -1
View File
@@ -39,7 +39,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/DiscountConditionService.mdx
+5 -5
View File
@@ -62,7 +62,7 @@ Provides layer to manipulate discount conditions.
},
{
"name": "discountConditionRepository_",
"type": "Repository&#60;[DiscountCondition](DiscountCondition.mdx)&#62; & `&#123; addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources &#125;`",
"type": "Repository&#60;[DiscountCondition](DiscountCondition.mdx)&#62; & ``{ addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -246,7 +246,7 @@ ___
<ParameterTypes parameters={[
{
"name": "data",
"type": "[Omit](../types/Omit.mdx)&#60;[DiscountConditionInput](../types/DiscountConditionInput.mdx), `\"id\"`&#62; & `&#123; id: string &#125;`",
"type": "[Omit](../types/Omit.mdx)&#60;[DiscountConditionInput](../types/DiscountConditionInput.mdx), \"id\"&#62; & ``{ id: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -327,7 +327,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -455,12 +455,12 @@ ___
#### Returns
`undefined` \| `&#123; resource_ids: (string \| &#123; id: string &#125;)[] ; type: [DiscountConditionType](../enums/DiscountConditionType.mdx) &#125;`
`undefined` \| ``{ resource_ids: (string \| &#123; id: string &#125;)[] ; type: [DiscountConditionType](../enums/DiscountConditionType.mdx) }``
<ParameterTypes parameters={[
{
"name": "undefined \\| &#123; resource_ids: (string \\| &#123; id: string &#125;)[] ; type: DiscountConditionType &#125;",
"type": "`undefined` \\| `&#123; resource_ids: (string \\| &#123; id: string &#125;)[] ; type: [DiscountConditionType](../enums/DiscountConditionType.mdx) &#125;`",
"type": "`undefined` \\| ``{ resource_ids: (string \\| &#123; id: string &#125;)[] ; type: [DiscountConditionType](../enums/DiscountConditionType.mdx) }``",
"optional": true,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/services/classes/DiscountRule.mdx
+1 -1
View File
@@ -48,7 +48,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/DiscountService.mdx
+3 -3
View File
@@ -71,7 +71,7 @@ Provides layer to manipulate discounts.
},
{
"name": "discountConditionRepository_",
"type": "Repository&#60;[DiscountCondition](DiscountCondition.mdx)&#62; & `&#123; addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources &#125;`",
"type": "Repository&#60;[DiscountCondition](DiscountCondition.mdx)&#62; & ``{ addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -125,7 +125,7 @@ Provides layer to manipulate discounts.
},
{
"name": "giftCardRepository_",
"type": "Repository&#60;[GiftCard](GiftCard.mdx)&#62; & `&#123; listGiftCardsAndCount: Method listGiftCardsAndCount &#125;`",
"type": "Repository&#60;[GiftCard](GiftCard.mdx)&#62; & ``{ listGiftCardsAndCount: Method listGiftCardsAndCount }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1120,7 +1120,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/DraftOrderService.mdx
+2 -2
View File
@@ -116,7 +116,7 @@ Handles draft orders
},
{
"name": "orderRepository_",
"type": "Repository&#60;[Order](Order.mdx)&#62; & `&#123; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations &#125;`",
"type": "Repository&#60;[Order](Order.mdx)&#62; & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -611,7 +611,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/EventBusService.mdx
+1 -1
View File
@@ -452,7 +452,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/FilterablePriceListProps.mdx
+2 -2
View File
@@ -82,7 +82,7 @@ Filters to apply on the retrieved price lists.
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)[]",
"type": "[PriceListStatus](../enums/PriceListStatus-1.mdx)[]",
"description": "Statuses to filter price lists by.",
"optional": true,
"defaultValue": "",
@@ -91,7 +91,7 @@ Filters to apply on the retrieved price lists.
},
{
"name": "type",
"type": "[PriceListType](../enums/PriceListType.mdx)[]",
"type": "[PriceListType](../enums/PriceListType-1.mdx)[]",
"description": "Types to filter price lists by.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/services/classes/FlagRouter.mdx
+2 -2
View File
@@ -101,7 +101,7 @@ ___
<ParameterTypes parameters={[
{
"name": "FeatureFlagsResponse",
"type": "`&#123; key: string ; value: boolean \\| Record&#60;string, boolean&#62; &#125;`[]",
"type": "``{ key: string ; value: boolean \\| Record&#60;string, boolean&#62; }``[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -136,7 +136,7 @@ These shapes are used for top-level and nested flags respectively, as explained
},
{
"name": "value",
"type": "`boolean` \\| `&#123; [key: string]: boolean; &#125;`",
"type": "`boolean` \\| ``{ [key: string]: boolean; }``",
"description": "The value of the flag to set.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/Fulfillment.mdx
+1 -1
View File
@@ -93,7 +93,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "location_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the fulfillment will be shipped from",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/FulfillmentProviderService.mdx
+3 -3
View File
@@ -361,7 +361,7 @@ ___
},
{
"name": "fulfillment",
"type": "[Omit](../types/Omit.mdx)&#60;[Fulfillment](Fulfillment.mdx), `\"beforeInsert\"`&#62;",
"type": "[Omit](../types/Omit.mdx)&#60;[Fulfillment](Fulfillment.mdx), \"beforeInsert\"&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -547,7 +547,7 @@ Fetches documents from the fulfillment provider
},
{
"name": "documentType",
"type": "``\"label\"`` \\| ``\"invoice\"``",
"type": "`\"label\"` \\| `\"invoice\"`",
"description": "the typ of",
"optional": false,
"defaultValue": "",
@@ -619,7 +619,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/FulfillmentService.mdx
+10 -10
View File
@@ -78,7 +78,7 @@ Handles Fulfillments
},
{
"name": "lineItemRepository_",
"type": "Repository&#60;[LineItem](LineItem.mdx)&#62; & `&#123; findByReturn: Method findByReturn &#125;`",
"type": "Repository&#60;[LineItem](LineItem.mdx)&#62; & ``{ findByReturn: Method findByReturn }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -373,7 +373,7 @@ tracking links and potentially more metadata.
},
{
"name": "trackingLinks",
"type": "`&#123; tracking_number: string &#125;`[]",
"type": "``{ tracking_number: string }``[]",
"description": "tracking links for the shipment",
"optional": true,
"defaultValue": "",
@@ -411,7 +411,7 @@ ___
### getFulfillmentItems\_
`**getFulfillmentItems_**(order, items): Promise&#60;(`null` \| [LineItem](LineItem.mdx))[]&#62;`
`**getFulfillmentItems_**(order, items): Promise&#60;(null \| [LineItem](LineItem.mdx))[]&#62;`
Retrieves the order line items, given an array of items.
@@ -440,12 +440,12 @@ Retrieves the order line items, given an array of items.
#### Returns
Promise&#60;(`null` \| [LineItem](LineItem.mdx))[]&#62;
Promise&#60;(null \| [LineItem](LineItem.mdx))[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;(`null` \\| [LineItem](LineItem.mdx))[]&#62;",
"type": "Promise&#60;(null \\| [LineItem](LineItem.mdx))[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the line items generated by the transformer.",
@@ -557,7 +557,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -586,7 +586,7 @@ ___
### validateFulfillmentLineItem\_
`**validateFulfillmentLineItem_**(item, quantity): `null` \| [LineItem](LineItem.mdx)`
`**validateFulfillmentLineItem_**(item, quantity): null \| [LineItem](LineItem.mdx)`
Checks that a given quantity of a line item can be fulfilled. Fails if the
fulfillable quantity is lower than the requested fulfillment quantity.
@@ -618,12 +618,12 @@ quantity from the quantity that was originally purchased.
#### Returns
``null`` \| [LineItem](LineItem.mdx)
`null` \| [LineItem](LineItem.mdx)
<ParameterTypes parameters={[
{
"name": "`null` \\| LineItem",
"type": "``null`` \\| [LineItem](LineItem.mdx)",
"name": "null \\| LineItem",
"type": "`null` \\| [LineItem](LineItem.mdx)",
"optional": true,
"defaultValue": "",
"description": "a line item that has the requested fulfillment quantity\n set.",
www/apps/docs/content/references/services/classes/GiftCard.mdx
+2 -2
View File
@@ -48,7 +48,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The gift card's tax rate that will be applied on calculating totals",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/GiftCardService.mdx
+7 -7
View File
@@ -69,7 +69,7 @@ Provides layer to manipulate gift cards.
},
{
"name": "giftCardRepository_",
"type": "Repository&#60;[GiftCard](GiftCard.mdx)&#62; & `&#123; listGiftCardsAndCount: Method listGiftCardsAndCount &#125;`",
"type": "Repository&#60;[GiftCard](GiftCard.mdx)&#62; & ``{ listGiftCardsAndCount: Method listGiftCardsAndCount }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -583,7 +583,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -719,7 +719,7 @@ ___
### resolveTaxRate
`Static Protected **resolveTaxRate**(giftCardTaxRate, region): `null` \| number`
`Static Protected **resolveTaxRate**(giftCardTaxRate, region): null \| number`
The tax\_rate of the giftcard can depend on whether regions tax gift cards, an input
provided by the user or the tax rate. Based on these conditions, tax\_rate changes.
@@ -729,7 +729,7 @@ provided by the user or the tax rate. Based on these conditions, tax\_rate chang
<ParameterTypes parameters={[
{
"name": "giftCardTaxRate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -749,12 +749,12 @@ provided by the user or the tax rate. Based on these conditions, tax\_rate chang
#### Returns
``null`` \| `number`
`null` \| `number`
<ParameterTypes parameters={[
{
"name": "`null` \\| number",
"type": "``null`` \\| `number`",
"name": "null \\| number",
"type": "`null` \\| `number`",
"optional": true,
"defaultValue": "",
"description": "the tax rate for the gift card",
www/apps/docs/content/references/services/classes/GiftCardTransaction.mdx
+1 -1
View File
@@ -93,7 +93,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax rate of the transaction",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/IdempotencyKeyService.mdx
+1 -1
View File
@@ -378,7 +378,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/Image.mdx
+1 -1
View File
@@ -30,7 +30,7 @@ An Image is used to store details about uploaded images. Images are uploaded by
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/LineItem.mdx
+21 -21
View File
@@ -84,7 +84,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A more detailed description of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "discount_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item rounded",
"optional": true,
"defaultValue": "",
@@ -102,7 +102,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "fulfilled_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been fulfilled.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "gift_card_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of the gift card of the line item",
"optional": true,
"defaultValue": "",
@@ -120,7 +120,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "has_shipping",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "Flag to indicate if the Line Item has fulfillment associated with it.",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "order_edit",
"type": "``null`` \\| [OrderEdit](OrderEdit.mdx)",
"type": "`null` \\| [OrderEdit](OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -193,7 +193,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "order_edit_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order edit that the item may belong to.",
"optional": true,
"defaultValue": "",
@@ -202,7 +202,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "original_item_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.",
"optional": true,
"defaultValue": "",
@@ -220,7 +220,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "original_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The original tax total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -229,7 +229,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "original_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The original total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -238,7 +238,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "product_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "raw_discount_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item",
"optional": true,
"defaultValue": "",
@@ -265,7 +265,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "refundable",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
"optional": true,
"defaultValue": "",
@@ -274,7 +274,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "returned_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been returned.",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "shipped_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been shipped.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "subtotal",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The subtotal of the line item",
"optional": true,
"defaultValue": "",
@@ -337,7 +337,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax of the line item",
"optional": true,
"defaultValue": "",
@@ -346,7 +346,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL string to a small image of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
@@ -364,7 +364,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -400,7 +400,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "variant_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The id of the Product Variant contained in the Line Item.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/LineItemAdjustmentService.mdx
+2 -2
View File
@@ -342,7 +342,7 @@ Deletes line item adjustments matching a selector
<ParameterTypes parameters={[
{
"name": "selectorOrIds",
"type": "`string` \\| `string`[] \\| [FilterableLineItemAdjustmentProps](FilterableLineItemAdjustmentProps.mdx) & `&#123; discount_id?: FindOperator&#60;`null` \\| string&#62; &#125;`",
"type": "`string` \\| `string`[] \\| [FilterableLineItemAdjustmentProps](FilterableLineItemAdjustmentProps.mdx) & ``{ discount_id?: FindOperator&#60;null \\| string&#62; }``",
"description": "the query object for find or the line item adjustment id",
"optional": false,
"defaultValue": "",
@@ -528,7 +528,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/LineItemService.mdx
+12 -12
View File
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "cartRepository_",
"type": "Repository&#60;[Cart](Cart.mdx)&#62; & `&#123; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations &#125;`",
"type": "Repository&#60;[Cart](Cart.mdx)&#62; & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "itemTaxLineRepo_",
"type": "Repository&#60;[LineItemTaxLine](LineItemTaxLine.mdx)&#62; & `&#123; deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines &#125;`",
"type": "Repository&#60;[LineItemTaxLine](LineItemTaxLine.mdx)&#62; & ``{ deleteForCart: Method deleteForCart ; upsertLines: Method upsertLines }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "lineItemRepository_",
"type": "Repository&#60;[LineItem](LineItem.mdx)&#62; & `&#123; findByReturn: Method findByReturn &#125;`",
"type": "Repository&#60;[LineItem](LineItem.mdx)&#62; & ``{ findByReturn: Method findByReturn }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -479,7 +479,7 @@ ___
### delete
`**delete**(id): Promise&#60;undefined \| `null` \| [LineItem](LineItem.mdx)&#62;`
`**delete**(id): Promise&#60;undefined \| null \| [LineItem](LineItem.mdx)&#62;`
Deletes a line item.
@@ -499,12 +499,12 @@ Deletes a line item.
#### Returns
Promise&#60;undefined \| `null` \| [LineItem](LineItem.mdx)&#62;
Promise&#60;undefined \| null \| [LineItem](LineItem.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;undefined \\| `null` \\| [LineItem](LineItem.mdx)&#62;",
"type": "Promise&#60;undefined \\| null \\| [LineItem](LineItem.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the delete operation",
@@ -517,7 +517,7 @@ ___
### deleteWithTaxLines
`**deleteWithTaxLines**(id): Promise&#60;undefined \| `null` \| [LineItem](LineItem.mdx)&#62;`
`**deleteWithTaxLines**(id): Promise&#60;undefined \| null \| [LineItem](LineItem.mdx)&#62;`
#### Parameters
@@ -535,12 +535,12 @@ ___
#### Returns
Promise&#60;undefined \| `null` \| [LineItem](LineItem.mdx)&#62;
Promise&#60;undefined \| null \| [LineItem](LineItem.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;undefined \\| `null` \\| [LineItem](LineItem.mdx)&#62;",
"type": "Promise&#60;undefined \\| null \\| [LineItem](LineItem.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the delete operation",
@@ -696,7 +696,7 @@ ___
},
{
"name": "variant.product.thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -741,7 +741,7 @@ ___
},
{
"name": "context",
"type": "[GenerateLineItemContext](../types/GenerateLineItemContext.mdx) & `&#123; variantPricing: [ProductVariantPricing](../types/ProductVariantPricing.mdx) &#125;`",
"type": "[GenerateLineItemContext](../types/GenerateLineItemContext.mdx) & ``{ variantPricing: [ProductVariantPricing](../types/ProductVariantPricing.mdx) }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -869,7 +869,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/LineItemTaxLine.mdx
+1 -1
View File
@@ -21,7 +21,7 @@ A Line Item Tax Line represents the taxes applied on a line item.
<ParameterTypes parameters={[
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/MoneyAmount.mdx
+5 -5
View File
@@ -57,7 +57,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "max_quantity",
"type": "``null`` \\| `number`",
"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": "",
@@ -84,7 +84,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "min_quantity",
"type": "``null`` \\| `number`",
"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": "",
@@ -93,7 +93,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "price_list",
"type": "``null`` \\| [PriceList](PriceList.mdx)",
"type": "`null` \\| [PriceList](PriceList.mdx)",
"description": "The details of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "price_list_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/NewTotalsService.mdx
+4 -4
View File
@@ -539,7 +539,7 @@ Return the amount that can be refund on a line item
},
{
"name": "__namedParameters.taxRate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -712,7 +712,7 @@ Calculate and return the items totals for either the legacy calculation or the n
},
{
"name": "__namedParameters.taxRate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -988,7 +988,7 @@ Calculate and return the shipping methods totals for either the legacy calculati
},
{
"name": "__namedParameters.taxRate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1181,7 +1181,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/Note.mdx
+1 -1
View File
@@ -48,7 +48,7 @@ A Note is an element that can be used in association with different resources to
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/NoteService.mdx
+1 -1
View File
@@ -477,7 +477,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/Notification.mdx
+1 -1
View File
@@ -39,7 +39,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "customer_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/NotificationService.mdx
+2 -2
View File
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "container_",
"type": "[InjectedDependencies](../types/InjectedDependencies-17.mdx) & `&#123;&#125;`",
"type": "[InjectedDependencies](../types/InjectedDependencies-17.mdx) & ``{}``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -653,7 +653,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/OauthService.mdx
+1 -1
View File
@@ -512,7 +512,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/Order.mdx
+7 -7
View File
@@ -183,7 +183,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -264,7 +264,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -300,7 +300,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "object",
"type": "``\"order\"``",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
@@ -417,7 +417,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -453,7 +453,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -498,7 +498,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -507,7 +507,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/OrderEdit.mdx
+1 -1
View File
@@ -255,7 +255,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/OrderEditItemChangeService.mdx
+1 -1
View File
@@ -413,7 +413,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/OrderEditService.mdx
+5 -5
View File
@@ -822,7 +822,7 @@ ___
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../types/Selector.mdx)&#60;[OrderEdit](OrderEdit.mdx)&#62; & `&#123; q?: string &#125;`",
"type": "[Selector](../types/Selector.mdx)&#60;[OrderEdit](OrderEdit.mdx)&#62; & ``{ q?: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1058,7 +1058,7 @@ ___
### retrieveActive
`Protected **retrieveActive**(orderId, config?): Promise&#60;undefined \| `null` \| [OrderEdit](OrderEdit.mdx)&#62;`
`Protected **retrieveActive**(orderId, config?): Promise&#60;undefined \| null \| [OrderEdit](OrderEdit.mdx)&#62;`
#### Parameters
@@ -1085,12 +1085,12 @@ ___
#### Returns
Promise&#60;undefined \| `null` \| [OrderEdit](OrderEdit.mdx)&#62;
Promise&#60;undefined \| null \| [OrderEdit](OrderEdit.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;undefined \\| `null` \\| [OrderEdit](OrderEdit.mdx)&#62;",
"type": "Promise&#60;undefined \\| null \\| [OrderEdit](OrderEdit.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -1110,7 +1110,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/OrderItemChange.mdx
+1 -1
View File
@@ -30,7 +30,7 @@ An order item change is a change made within an order edit to an order's items.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/OrderService.mdx
+6 -6
View File
@@ -184,7 +184,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "orderRepository_",
"type": "Repository&#60;[Order](Order.mdx)&#62; & `&#123; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations &#125;`",
"type": "Repository&#60;[Order](Order.mdx)&#62; & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1794,7 +1794,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -2032,7 +2032,7 @@ ___
### validateFulfillmentLineItem
`Protected **validateFulfillmentLineItem**(item, quantity): `null` \| [LineItem](LineItem.mdx)`
`Protected **validateFulfillmentLineItem**(item, quantity): null \| [LineItem](LineItem.mdx)`
Checks that a given quantity of a line item can be fulfilled. Fails if the
fulfillable quantity is lower than the requested fulfillment quantity.
@@ -2064,12 +2064,12 @@ quantity from the quantity that was originally purchased.
#### Returns
``null`` \| [LineItem](LineItem.mdx)
`null` \| [LineItem](LineItem.mdx)
<ParameterTypes parameters={[
{
"name": "`null` \\| LineItem",
"type": "``null`` \\| [LineItem](LineItem.mdx)",
"name": "null \\| LineItem",
"type": "`null` \\| [LineItem](LineItem.mdx)",
"optional": true,
"defaultValue": "",
"description": "a line item that has the requested fulfillment quantity\n set.",
www/apps/docs/content/references/services/classes/PaymentCollection.mdx
+3 -3
View File
@@ -30,7 +30,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "authorized_amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "Authorized amount of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Description of the payment collection",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/PaymentCollectionService.mdx
+2 -2
View File
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "paymentCollectionRepository_",
"type": "Repository&#60;[PaymentCollection](PaymentCollection.mdx)&#62; & `&#123; getPaymentCollectionIdByPaymentId: Method getPaymentCollectionIdByPaymentId ; getPaymentCollectionIdBySessionId: Method getPaymentCollectionIdBySessionId &#125;`",
"type": "Repository&#60;[PaymentCollection](PaymentCollection.mdx)&#62; & ``{ getPaymentCollectionIdByPaymentId: Method getPaymentCollectionIdByPaymentId ; getPaymentCollectionIdBySessionId: Method getPaymentCollectionIdBySessionId }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -699,7 +699,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/PaymentProviderService.mdx
+3 -3
View File
@@ -367,7 +367,7 @@ ___
<ParameterTypes parameters={[
{
"name": "paymentObj",
"type": "[Partial](../types/Partial.mdx)&#60;[Payment](Payment.mdx)&#62; & `&#123; id: string &#125;`",
"type": "[Partial](../types/Partial.mdx)&#60;[Payment](Payment.mdx)&#62; & ``{ id: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -403,7 +403,7 @@ ___
<ParameterTypes parameters={[
{
"name": "paymentObj",
"type": "[Partial](../types/Partial.mdx)&#60;[Payment](Payment.mdx)&#62; & `&#123; id: string &#125;`",
"type": "[Partial](../types/Partial.mdx)&#60;[Payment](Payment.mdx)&#62; & ``{ id: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1298,7 +1298,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/PaymentService.mdx
+1 -1
View File
@@ -466,7 +466,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/PaymentSession.mdx
+2 -2
View File
@@ -39,7 +39,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "cart_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the cart that the payment session was created for.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "is_selected",
"type": "``null`` \\| `boolean`",
"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": "",
www/apps/docs/content/references/services/classes/PriceList.mdx
+3 -3
View File
@@ -39,7 +39,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List stops being valid.",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "starts_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List starts being valid.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/PriceListService.mdx
+4 -4
View File
@@ -87,7 +87,7 @@ Provides layer to manipulate product tags.
},
{
"name": "moneyAmountRepo_",
"type": "Repository&#60;[MoneyAmount](MoneyAmount.mdx)&#62; & `&#123; addPriceListPrices: Method addPriceListPrices ; createProductVariantMoneyAmounts: Method createProductVariantMoneyAmounts ; deletePriceListPrices: Method deletePriceListPrices ; deleteVariantPricesNotIn: Method deleteVariantPricesNotIn ; findCurrencyMoneyAmounts: Method findCurrencyMoneyAmounts ; findManyForVariantInPriceList: Method findManyForVariantInPriceList ; findManyForVariantInRegion: Method findManyForVariantInRegion ; findManyForVariantsInRegion: Method findManyForVariantsInRegion ; findRegionMoneyAmounts: Method findRegionMoneyAmounts ; findVariantPricesNotIn: Method findVariantPricesNotIn ; getPricesForVariantInRegion: Method getPricesForVariantInRegion ; insertBulk: Method insertBulk ; updatePriceListPrices: Method updatePriceListPrices ; upsertVariantCurrencyPrice: Method upsertVariantCurrencyPrice &#125;`",
"type": "Repository&#60;[MoneyAmount](MoneyAmount.mdx)&#62; & ``{ addPriceListPrices: Method addPriceListPrices ; createProductVariantMoneyAmounts: Method createProductVariantMoneyAmounts ; deletePriceListPrices: Method deletePriceListPrices ; deleteVariantPricesNotIn: Method deleteVariantPricesNotIn ; findCurrencyMoneyAmounts: Method findCurrencyMoneyAmounts ; findManyForVariantInPriceList: Method findManyForVariantInPriceList ; findManyForVariantInRegion: Method findManyForVariantInRegion ; findManyForVariantsInRegion: Method findManyForVariantsInRegion ; findRegionMoneyAmounts: Method findRegionMoneyAmounts ; findVariantPricesNotIn: Method findVariantPricesNotIn ; getPricesForVariantInRegion: Method getPricesForVariantInRegion ; insertBulk: Method insertBulk ; updatePriceListPrices: Method updatePriceListPrices ; upsertVariantCurrencyPrice: Method upsertVariantCurrencyPrice }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -96,7 +96,7 @@ Provides layer to manipulate product tags.
},
{
"name": "priceListRepo_",
"type": "Repository&#60;[PriceList](PriceList.mdx)&#62; & `&#123; listAndCount: Method listAndCount ; listPriceListsVariantIdsMap: Method listPriceListsVariantIdsMap &#125;`",
"type": "Repository&#60;[PriceList](PriceList.mdx)&#62; & ``{ listAndCount: Method listAndCount ; listPriceListsVariantIdsMap: Method listPriceListsVariantIdsMap }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -923,7 +923,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1015,7 +1015,7 @@ ___
},
{
"name": "customerGroups",
"type": "`&#123; id: string &#125;`[]",
"type": "``{ id: string }``[]",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/PricingService.mdx
+144 -9
View File
@@ -156,6 +156,15 @@ ___
[IPricingModuleService](../interfaces/IPricingModuleService.mdx)
<ParameterTypes parameters={[
{
"name": "addPriceListPrices",
"type": "(`data`: [AddPriceListPricesDTO](../interfaces/AddPriceListPricesDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceListDTO](../interfaces/PriceListDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "addPrices",
"type": "(`data`: [AddPricesDTO](../interfaces/AddPricesDTO.mdx), `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceSetDTO](../interfaces/PriceSetDTO.mdx)&#62;(`data`: [AddPricesDTO](../interfaces/AddPricesDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceSetDTO](../interfaces/PriceSetDTO.mdx)[]&#62;",
@@ -210,6 +219,24 @@ ___
"expandable": false,
"children": []
},
{
"name": "createPriceListRules",
"type": "(`data`: [CreatePriceListRuleDTO](../interfaces/CreatePriceListRuleDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "createPriceLists",
"type": "(`data`: [CreatePriceListDTO](../interfaces/CreatePriceListDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceListDTO](../interfaces/PriceListDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "createPriceRules",
"type": "(`data`: [CreatePriceRuleDTO](../interfaces/CreatePriceRuleDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)[]&#62;",
@@ -264,6 +291,24 @@ ___
"expandable": false,
"children": []
},
{
"name": "deletePriceListRules",
"type": "(`priceListRuleIds`: `string`[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deletePriceLists",
"type": "(`priceListIds`: `string`[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deletePriceRules",
"type": "(`priceRuleIds`: `string`[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;void&#62;",
@@ -327,6 +372,24 @@ ___
"expandable": false,
"children": []
},
{
"name": "listAndCountPriceListRules",
"type": "(`filters?`: [FilterablePriceListRuleProps](../interfaces/FilterablePriceListRuleProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)&#62;, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)[], number]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "listAndCountPriceLists",
"type": "(`filters?`: [FilterablePriceListProps](../interfaces/FilterablePriceListProps-1.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[PriceListDTO](../interfaces/PriceListDTO.mdx)&#62;, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[[PriceListDTO](../interfaces/PriceListDTO.mdx)[], number]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "listAndCountPriceRules",
"type": "(`filters?`: [FilterablePriceRuleProps](../interfaces/FilterablePriceRuleProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)&#62;, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)[], number]&#62;",
@@ -381,6 +444,24 @@ ___
"expandable": false,
"children": []
},
{
"name": "listPriceListRules",
"type": "(`filters?`: [FilterablePriceListRuleProps](../interfaces/FilterablePriceListRuleProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)&#62;, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "listPriceLists",
"type": "(`filters?`: [FilterablePriceListProps](../interfaces/FilterablePriceListProps-1.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[PriceListDTO](../interfaces/PriceListDTO.mdx)&#62;, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceListDTO](../interfaces/PriceListDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "listPriceRules",
"type": "(`filters?`: [FilterablePriceRuleProps](../interfaces/FilterablePriceRuleProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)&#62;, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)[]&#62;",
@@ -417,6 +498,15 @@ ___
"expandable": false,
"children": []
},
{
"name": "removePriceListRules",
"type": "(`data`: [RemovePriceListRulesDTO](../interfaces/RemovePriceListRulesDTO.mdx), `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceListDTO](../interfaces/PriceListDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "removeRules",
"type": "(`data`: [RemovePriceSetRulesDTO](../interfaces/RemovePriceSetRulesDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;void&#62;",
@@ -453,6 +543,24 @@ ___
"expandable": false,
"children": []
},
{
"name": "retrievePriceList",
"type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[PriceListDTO](../interfaces/PriceListDTO.mdx)&#62;, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceListDTO](../interfaces/PriceListDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "retrievePriceListRule",
"type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)&#62;, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "retrievePriceRule",
"type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)&#62;, `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)&#62;",
@@ -480,6 +588,15 @@ ___
"expandable": false,
"children": []
},
{
"name": "setPriceListRules",
"type": "(`data`: [SetPriceListRulesDTO](../interfaces/SetPriceListRulesDTO.mdx), `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceListDTO](../interfaces/PriceListDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updateCurrencies",
"type": "(`data`: [UpdateCurrencyDTO](../interfaces/UpdateCurrencyDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[CurrencyDTO](../interfaces/CurrencyDTO.mdx)[]&#62;",
@@ -498,6 +615,24 @@ ___
"expandable": false,
"children": []
},
{
"name": "updatePriceListRules",
"type": "(`data`: [UpdatePriceListRuleDTO](../interfaces/UpdatePriceListRuleDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceListRuleDTO](../interfaces/PriceListRuleDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updatePriceLists",
"type": "(`data`: [UpdatePriceListDTO](../interfaces/UpdatePriceListDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceListDTO](../interfaces/PriceListDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updatePriceRules",
"type": "(`data`: [UpdatePriceRuleDTO](../interfaces/UpdatePriceRuleDTO.mdx)[], `sharedContext?`: [Context](../interfaces/Context.mdx)) => Promise&#60;[PriceRuleDTO](../interfaces/PriceRuleDTO.mdx)[]&#62;",
@@ -540,7 +675,7 @@ ___
<ParameterTypes parameters={[
{
"name": "RemoteQueryFunction",
"type": "(`query`: `string` \\| [RemoteJoinerQuery](../interfaces/RemoteJoinerQuery.mdx) \\| `object`, `variables?`: `Record<string, unknown>`) => Promise&#60;any&#62; \\| ``null``",
"type": "(`query`: `string` \\| [RemoteJoinerQuery](../interfaces/RemoteJoinerQuery.mdx) \\| `object`, `variables?`: `Record<string, unknown>`) => Promise&#60;any&#62; \\| `null`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -764,7 +899,7 @@ be fetched.
<ParameterTypes parameters={[
{
"name": "product",
"type": "[Pick](../types/Pick.mdx)&#60;[Product](Product.mdx), `\"id\"` \\| `\"variants\"`&#62;",
"type": "[Pick](../types/Pick.mdx)&#60;[Product](Product.mdx), \"id\" \\| \"variants\"&#62;",
"description": "the product to get pricing for.",
"optional": false,
"defaultValue": "",
@@ -856,7 +991,7 @@ ___
<ParameterTypes parameters={[
{
"name": "data",
"type": "`&#123; productId: string ; variants: [ProductVariant](ProductVariant.mdx)[] &#125;`[]",
"type": "``{ productId: string ; variants: [ProductVariant](ProductVariant.mdx)[] }``[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -903,7 +1038,7 @@ Gets the prices for a product variant.
<ParameterTypes parameters={[
{
"name": "variant",
"type": "[Pick](../types/Pick.mdx)&#60;[ProductVariant](ProductVariant.mdx), `\"id\"` \\| `\"product_id\"`&#62;",
"type": "[Pick](../types/Pick.mdx)&#60;[ProductVariant](ProductVariant.mdx), \"id\" \\| \"product_id\"&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -999,7 +1134,7 @@ ___
<ParameterTypes parameters={[
{
"name": "variantPriceData",
"type": "`&#123; quantity?: number ; variantId: string &#125;`[]",
"type": "``{ quantity?: number ; variantId: string }``[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1044,7 +1179,7 @@ ___
<ParameterTypes parameters={[
{
"name": "data",
"type": "`&#123; quantity?: number ; variantId: string &#125;`[]",
"type": "``{ quantity?: number ; variantId: string }``[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1091,7 +1226,7 @@ Gets the prices for a collection of variants.
<ParameterTypes parameters={[
{
"name": "data",
"type": "`&#123; quantity?: number ; variantId: string &#125;`[]",
"type": "``{ quantity?: number ; variantId: string }``[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1322,7 +1457,7 @@ Set additional prices on a list of shipping options.
},
{
"name": "context",
"type": "[Omit](../types/Omit.mdx)&#60;[PriceSelectionContext](../types/PriceSelectionContext.mdx), `\"region_id\"`&#62;",
"type": "[Omit](../types/Omit.mdx)&#60;[PriceSelectionContext](../types/PriceSelectionContext.mdx), \"region_id\"&#62;",
"description": "the price selection context to use",
"optional": false,
"defaultValue": "{}",
@@ -1405,7 +1540,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/Product.mdx
+17 -17
View File
@@ -40,7 +40,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -148,7 +148,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -166,7 +166,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -175,7 +175,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -193,7 +193,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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.",
"optional": false,
"defaultValue": "",
@@ -247,7 +247,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -265,7 +265,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -319,7 +319,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -328,7 +328,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ProductCategory.mdx
+2 -2
View File
@@ -93,7 +93,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "parent_category",
"type": "``null`` \\| [ProductCategory](ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
www/apps/docs/content/references/services/classes/ProductCategoryService.mdx
+4 -4
View File
@@ -78,7 +78,7 @@ Provides layer to manipulate product categories.
},
{
"name": "productCategoryRepo_",
"type": "TreeRepository&#60;[ProductCategory](ProductCategory.mdx)&#62; & `&#123; addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts &#125;`",
"type": "TreeRepository&#60;[ProductCategory](ProductCategory.mdx)&#62; & ``{ addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -478,7 +478,7 @@ ___
<ParameterTypes parameters={[
{
"name": "repository",
"type": "TreeRepository&#60;[ProductCategory](ProductCategory.mdx)&#62; & `&#123; addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts &#125;`",
"type": "TreeRepository&#60;[ProductCategory](ProductCategory.mdx)&#62; & ``{ addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -756,7 +756,7 @@ ___
<ParameterTypes parameters={[
{
"name": "repository",
"type": "TreeRepository&#60;[ProductCategory](ProductCategory.mdx)&#62; & `&#123; addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts &#125;`",
"type": "TreeRepository&#60;[ProductCategory](ProductCategory.mdx)&#62; & ``{ addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -801,7 +801,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ProductCollection.mdx
+1 -1
View File
@@ -30,7 +30,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ProductCollectionService.mdx
+4 -4
View File
@@ -78,7 +78,7 @@ Provides layer to manipulate product collections.
},
{
"name": "productCollectionRepository_",
"type": "Repository&#60;[ProductCollection](ProductCollection.mdx)&#62; & `&#123; findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId &#125;`",
"type": "Repository&#60;[ProductCollection](ProductCollection.mdx)&#62; & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -87,7 +87,7 @@ Provides layer to manipulate product collections.
},
{
"name": "productRepository_",
"type": "Repository&#60;[Product](Product.mdx)&#62; & `&#123; _applyCategoriesQuery: Method \\_applyCategoriesQuery ; _findWithRelations: Method \\_findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds &#125;`",
"type": "Repository&#60;[Product](Product.mdx)&#62; & ``{ _applyCategoriesQuery: Method _applyCategoriesQuery ; _findWithRelations: Method _findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -394,7 +394,7 @@ Lists product collections
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../types/Selector.mdx)&#60;[ProductCollection](ProductCollection.mdx)&#62; & `&#123; discount_condition_id?: string ; q?: string &#125;`",
"type": "[Selector](../types/Selector.mdx)&#60;[ProductCollection](ProductCollection.mdx)&#62; & ``{ discount_condition_id?: string ; q?: string }``",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
@@ -643,7 +643,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ProductOption.mdx
+1 -1
View File
@@ -30,7 +30,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ProductOptionValue.mdx
+1 -1
View File
@@ -30,7 +30,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ProductService.mdx
+11 -11
View File
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "imageRepository_",
"type": "Repository&#60;[Image](Image.mdx)&#62; & `&#123; insertBulk: Method insertBulk ; upsertImages: Method upsertImages &#125;`",
"type": "Repository&#60;[Image](Image.mdx)&#62; & ``{ insertBulk: Method insertBulk ; upsertImages: Method upsertImages }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "productCategoryRepository_",
"type": "TreeRepository&#60;[ProductCategory](ProductCategory.mdx)&#62; & `&#123; addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts &#125;`",
"type": "TreeRepository&#60;[ProductCategory](ProductCategory.mdx)&#62; & ``{ addProducts: Method addProducts ; findOneWithDescendants: Method findOneWithDescendants ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; removeProducts: Method removeProducts }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "productRepository_",
"type": "Repository&#60;[Product](Product.mdx)&#62; & `&#123; _applyCategoriesQuery: Method \\_applyCategoriesQuery ; _findWithRelations: Method \\_findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds &#125;`",
"type": "Repository&#60;[Product](Product.mdx)&#62; & ``{ _applyCategoriesQuery: Method _applyCategoriesQuery ; _findWithRelations: Method _findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "productTagRepository_",
"type": "Repository&#60;[ProductTag](ProductTag.mdx)&#62; & `&#123; findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; insertBulk: Method insertBulk ; listTagsByUsage: Method listTagsByUsage ; upsertTags: Method upsertTags &#125;`",
"type": "Repository&#60;[ProductTag](ProductTag.mdx)&#62; & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; insertBulk: Method insertBulk ; listTagsByUsage: Method listTagsByUsage ; upsertTags: Method upsertTags }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "productTypeRepository_",
"type": "Repository&#60;[ProductType](ProductType.mdx)&#62; & `&#123; findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType &#125;`",
"type": "Repository&#60;[ProductType](ProductType.mdx)&#62; & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "IndexName",
"type": "``\"products\"``",
"type": "`\"products\"`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1056,7 +1056,7 @@ ___
### retrieveOptionByTitle
`**retrieveOptionByTitle**(title, productId): Promise&#60;`null` \| [ProductOption](ProductOption.mdx)&#62;`
`**retrieveOptionByTitle**(title, productId): Promise&#60;null \| [ProductOption](ProductOption.mdx)&#62;`
Retrieve product's option by title.
@@ -1085,12 +1085,12 @@ Retrieve product's option by title.
#### Returns
Promise&#60;`null` \| [ProductOption](ProductOption.mdx)&#62;
Promise&#60;null \| [ProductOption](ProductOption.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;`null` \\| [ProductOption](ProductOption.mdx)&#62;",
"type": "Promise&#60;null \\| [ProductOption](ProductOption.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "product option",
@@ -1205,7 +1205,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1358,7 +1358,7 @@ Assign a product to a profile, if a profile id null is provided then detach the
},
{
"name": "profileId",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Shipping profile ID to update the shipping options with",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ProductTag.mdx
+1 -1
View File
@@ -30,7 +30,7 @@ A Product Tag can be added to Products for easy filtering and grouping.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ProductType.mdx
+1 -1
View File
@@ -30,7 +30,7 @@ A Product Type can be added to Products for filtering and reporting purposes.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ProductTypeService.mdx
+4 -4
View File
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "typeRepository_",
"type": "Repository&#60;[ProductType](ProductType.mdx)&#62; & `&#123; findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType &#125;`",
"type": "Repository&#60;[ProductType](ProductType.mdx)&#62; & ``{ findAndCountByDiscountConditionId: Method findAndCountByDiscountConditionId ; upsertType: Method upsertType }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -199,7 +199,7 @@ Lists product types
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../types/Selector.mdx)&#60;[ProductType](ProductType.mdx)&#62; & `&#123; discount_condition_id?: string ; q?: string &#125;`",
"type": "[Selector](../types/Selector.mdx)&#60;[ProductType](ProductType.mdx)&#62; & ``{ discount_condition_id?: string ; q?: string }``",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
@@ -246,7 +246,7 @@ Lists product types and adds count.
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../types/Selector.mdx)&#60;[ProductType](ProductType.mdx)&#62; & `&#123; discount_condition_id?: string ; q?: string &#125;`",
"type": "[Selector](../types/Selector.mdx)&#60;[ProductType](ProductType.mdx)&#62; & ``{ discount_condition_id?: string ; q?: string }``",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
@@ -339,7 +339,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ProductVariant.mdx
+15 -15
View File
@@ -30,7 +30,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -111,7 +111,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -138,7 +138,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -165,7 +165,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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.",
"optional": false,
"defaultValue": "",
@@ -210,7 +210,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"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": "",
@@ -228,7 +228,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -246,7 +246,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The ranking of this variant",
"optional": false,
"defaultValue": "0",
@@ -255,7 +255,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -264,7 +264,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ProductVariantInventoryItem.mdx
+1 -1
View File
@@ -30,7 +30,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ProductVariantInventoryService.mdx
+38 -56
View File
@@ -145,18 +145,9 @@ ___
[IInventoryService](../interfaces/IInventoryService.mdx)
<ParameterTypes parameters={[
{
"name": "__joinerConfig",
"type": "() => [ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "adjustInventory",
"type": "(`inventoryItemId`: `string`, `locationId`: `string`, `adjustment`: `number`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"type": "(`inventoryItemId`: `string`, `locationId`: `string`, `adjustment`: `number`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -165,7 +156,7 @@ ___
},
{
"name": "confirmInventory",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;boolean&#62;",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;boolean&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -174,7 +165,7 @@ ___
},
{
"name": "createInventoryItem",
"type": "(`input`: [CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"type": "(`input`: [CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -183,7 +174,7 @@ ___
},
{
"name": "createInventoryItems",
"type": "(`input`: [CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]&#62;",
"type": "(`input`: [CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -192,7 +183,7 @@ ___
},
{
"name": "createInventoryLevel",
"type": "(`data`: [CreateInventoryLevelInput](../types/CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"type": "(`data`: [CreateInventoryLevelInput](../interfaces/CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -201,7 +192,7 @@ ___
},
{
"name": "createInventoryLevels",
"type": "(`data`: [CreateInventoryLevelInput](../types/CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;",
"type": "(`data`: [CreateInventoryLevelInput](../interfaces/CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -210,7 +201,7 @@ ___
},
{
"name": "createReservationItem",
"type": "(`input`: [CreateReservationItemInput](../types/CreateReservationItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"type": "(`input`: [CreateReservationItemInput](../interfaces/CreateReservationItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -219,7 +210,7 @@ ___
},
{
"name": "createReservationItems",
"type": "(`input`: [CreateReservationItemInput](../types/CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]&#62;",
"type": "(`input`: [CreateReservationItemInput](../interfaces/CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -228,7 +219,7 @@ ___
},
{
"name": "deleteInventoryItem",
"type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -237,7 +228,7 @@ ___
},
{
"name": "deleteInventoryItemLevelByLocationId",
"type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -246,7 +237,7 @@ ___
},
{
"name": "deleteInventoryLevel",
"type": "(`inventoryLevelId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -255,7 +246,7 @@ ___
},
{
"name": "deleteReservationItem",
"type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -264,7 +255,7 @@ ___
},
{
"name": "deleteReservationItemByLocationId",
"type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -273,7 +264,7 @@ ___
},
{
"name": "deleteReservationItemsByLineItem",
"type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -282,7 +273,7 @@ ___
},
{
"name": "listInventoryItems",
"type": "(`selector`: [FilterableInventoryItemProps](../types/FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]&#62;",
"type": "(`selector`: [FilterableInventoryItemProps](../interfaces/FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -291,7 +282,7 @@ ___
},
{
"name": "listInventoryLevels",
"type": "(`selector`: [FilterableInventoryLevelProps](../types/FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]&#62;",
"type": "(`selector`: [FilterableInventoryLevelProps](../interfaces/FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -300,7 +291,7 @@ ___
},
{
"name": "listReservationItems",
"type": "(`selector`: [FilterableReservationItemProps](../types/FilterableReservationItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]&#62;",
"type": "(`selector`: [FilterableReservationItemProps](../interfaces/FilterableReservationItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -309,7 +300,7 @@ ___
},
{
"name": "restoreInventoryItem",
"type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -318,7 +309,7 @@ ___
},
{
"name": "retrieveAvailableQuantity",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;number&#62;",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;number&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -327,7 +318,7 @@ ___
},
{
"name": "retrieveInventoryItem",
"type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -336,7 +327,7 @@ ___
},
{
"name": "retrieveInventoryLevel",
"type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -345,7 +336,7 @@ ___
},
{
"name": "retrieveReservationItem",
"type": "(`reservationId`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"type": "(`reservationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -354,7 +345,7 @@ ___
},
{
"name": "retrieveReservedQuantity",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;number&#62;",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;number&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -363,7 +354,7 @@ ___
},
{
"name": "retrieveStockedQuantity",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;number&#62;",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;number&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -372,7 +363,7 @@ ___
},
{
"name": "updateInventoryItem",
"type": "(`inventoryItemId`: `string`, `input`: [CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"type": "(`inventoryItemId`: `string`, `input`: [Partial](../types/Partial.mdx)&#60;[CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -381,7 +372,7 @@ ___
},
{
"name": "updateInventoryLevel",
"type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../types/UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../interfaces/UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -390,7 +381,7 @@ ___
},
{
"name": "updateInventoryLevels",
"type": "(`updates`: `&#123; inventory_item_id: string ; location_id: string &#125;` & [UpdateInventoryLevelInput](../types/UpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;",
"type": "(`updates`: [BulkUpdateInventoryLevelInput](../interfaces/BulkUpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -399,7 +390,7 @@ ___
},
{
"name": "updateReservationItem",
"type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../types/UpdateReservationItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../interfaces/UpdateReservationItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -419,18 +410,9 @@ ___
[IStockLocationService](../interfaces/IStockLocationService.mdx)
<ParameterTypes parameters={[
{
"name": "__joinerConfig",
"type": "() => [ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "create",
"type": "(`input`: [CreateStockLocationInput](../types/CreateStockLocationInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"type": "(`input`: [CreateStockLocationInput](../types/CreateStockLocationInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -439,7 +421,7 @@ ___
},
{
"name": "delete",
"type": "(`id`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`id`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -448,7 +430,7 @@ ___
},
{
"name": "list",
"type": "(`selector`: [FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;",
"type": "(`selector`: [FilterableStockLocationProps](../interfaces/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -457,7 +439,7 @@ ___
},
{
"name": "listAndCount",
"type": "(`selector`: [FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;",
"type": "(`selector`: [FilterableStockLocationProps](../interfaces/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -466,7 +448,7 @@ ___
},
{
"name": "retrieve",
"type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -475,7 +457,7 @@ ___
},
{
"name": "update",
"type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -697,7 +679,7 @@ Attach a variant to an inventory item
<ParameterTypes parameters={[
{
"name": "attachments",
"type": "`&#123; inventoryItemId: string ; requiredQuantity?: number ; variantId: string &#125;`[]",
"type": "``{ inventoryItemId: string ; requiredQuantity?: number ; variantId: string }``[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -812,7 +794,7 @@ confirms if requested inventory is available
},
{
"name": "context.salesChannelId",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1409,7 +1391,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1447,7 +1429,7 @@ Validate stock at a location for fulfillment items
<ParameterTypes parameters={[
{
"name": "items",
"type": "[Omit](../types/Omit.mdx)&#60;[LineItem](LineItem.mdx), `\"beforeInsert\"`&#62;[]",
"type": "[Omit](../types/Omit.mdx)&#60;[LineItem](LineItem.mdx), \"beforeInsert\"&#62;[]",
"description": "Fulfillment Line items to validate quantities for",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ProductVariantService.mdx
+9 -9
View File
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "cartRepository_",
"type": "Repository&#60;[Cart](Cart.mdx)&#62; & `&#123; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations &#125;`",
"type": "Repository&#60;[Cart](Cart.mdx)&#62; & ``{ findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "moneyAmountRepository_",
"type": "Repository&#60;[MoneyAmount](MoneyAmount.mdx)&#62; & `&#123; addPriceListPrices: Method addPriceListPrices ; createProductVariantMoneyAmounts: Method createProductVariantMoneyAmounts ; deletePriceListPrices: Method deletePriceListPrices ; deleteVariantPricesNotIn: Method deleteVariantPricesNotIn ; findCurrencyMoneyAmounts: Method findCurrencyMoneyAmounts ; findManyForVariantInPriceList: Method findManyForVariantInPriceList ; findManyForVariantInRegion: Method findManyForVariantInRegion ; findManyForVariantsInRegion: Method findManyForVariantsInRegion ; findRegionMoneyAmounts: Method findRegionMoneyAmounts ; findVariantPricesNotIn: Method findVariantPricesNotIn ; getPricesForVariantInRegion: Method getPricesForVariantInRegion ; insertBulk: Method insertBulk ; updatePriceListPrices: Method updatePriceListPrices ; upsertVariantCurrencyPrice: Method upsertVariantCurrencyPrice &#125;`",
"type": "Repository&#60;[MoneyAmount](MoneyAmount.mdx)&#62; & ``{ addPriceListPrices: Method addPriceListPrices ; createProductVariantMoneyAmounts: Method createProductVariantMoneyAmounts ; deletePriceListPrices: Method deletePriceListPrices ; deleteVariantPricesNotIn: Method deleteVariantPricesNotIn ; findCurrencyMoneyAmounts: Method findCurrencyMoneyAmounts ; findManyForVariantInPriceList: Method findManyForVariantInPriceList ; findManyForVariantInRegion: Method findManyForVariantInRegion ; findManyForVariantsInRegion: Method findManyForVariantsInRegion ; findRegionMoneyAmounts: Method findRegionMoneyAmounts ; findVariantPricesNotIn: Method findVariantPricesNotIn ; getPricesForVariantInRegion: Method getPricesForVariantInRegion ; insertBulk: Method insertBulk ; updatePriceListPrices: Method updatePriceListPrices ; upsertVariantCurrencyPrice: Method upsertVariantCurrencyPrice }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "productRepository_",
"type": "Repository&#60;[Product](Product.mdx)&#62; & `&#123; _applyCategoriesQuery: Method \\_applyCategoriesQuery ; _findWithRelations: Method \\_findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds &#125;`",
"type": "Repository&#60;[Product](Product.mdx)&#62; & ``{ _applyCategoriesQuery: Method _applyCategoriesQuery ; _findWithRelations: Method _findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -562,7 +562,7 @@ ___
### getRegionPrice
`**getRegionPrice**(variantId, context): Promise&#60;`null` \| number&#62;`
`**getRegionPrice**(variantId, context): Promise&#60;null \| number&#62;`
Gets the price specific to a region. If no region specific money amount
exists the function will try to use a currency price. If no default
@@ -593,12 +593,12 @@ currency price exists the function will throw an error.
#### Returns
Promise&#60;`null` \| number&#62;
Promise&#60;null \| number&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;`null` \\| number&#62;",
"type": "Promise&#60;null \\| number&#62;",
"optional": false,
"defaultValue": "",
"description": "the price specific to the region",
@@ -949,7 +949,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -987,7 +987,7 @@ Updates a collection of variant.
<ParameterTypes parameters={[
{
"name": "variantData",
"type": "`&#123; updateData: [UpdateProductVariantInput](../types/UpdateProductVariantInput.mdx) ; variant: [ProductVariant](ProductVariant.mdx) &#125;`[]",
"type": "``{ updateData: [UpdateProductVariantInput](../types/UpdateProductVariantInput.mdx) ; variant: [ProductVariant](ProductVariant.mdx) }``[]",
"description": "a collection of variant and the data to update.",
"optional": false,
"defaultValue": "",
@@ -1321,7 +1321,7 @@ ___
<ParameterTypes parameters={[
{
"name": "data",
"type": "`&#123; price: [WithRequiredProperty](../types/WithRequiredProperty.mdx)&#60;[ProductVariantPrice](../types/ProductVariantPrice.mdx), `\"currency_code\"`&#62; ; variantId: string &#125;`[]",
"type": "``{ price: [WithRequiredProperty](../types/WithRequiredProperty.mdx)&#60;[ProductVariantPrice](../types/ProductVariantPrice.mdx), \"currency_code\"&#62; ; variantId: string }``[]",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/Region.mdx
+3 -3
View File
@@ -66,7 +66,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -175,7 +175,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/RegionService.mdx
+2 -2
View File
@@ -911,7 +911,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1099,7 +1099,7 @@ the id can be passed to check that country updates are allowed.
<ParameterTypes parameters={[
{
"name": "regionData",
"type": "[Omit](../types/Omit.mdx)&#60;T, `\"metadata\"` \\| `\"currency_code\"`&#62;",
"type": "[Omit](../types/Omit.mdx)&#60;T, \"metadata\" \\| \"currency_code\"&#62;",
"description": "the region data to validate",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/Return.mdx
+7 -7
View File
@@ -30,7 +30,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "claim_order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "idempotency_key",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Randomly generated key used to continue the completion of the return in case of failure.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "location_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the return will be added back.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "no_notification",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "When set to true, no notification will be sent related to this return.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order that the return was created for.",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "swap_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ReturnReason.mdx
+3 -3
View File
@@ -30,7 +30,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "parent_return_reason",
"type": "``null`` \\| [ReturnReason](ReturnReason.mdx)",
"type": "`null` \\| [ReturnReason](ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "parent_return_reason_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent reason.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ReturnReasonService.mdx
+1 -1
View File
@@ -361,7 +361,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ReturnService.mdx
+1 -1
View File
@@ -728,7 +728,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/SalesChannel.mdx
+3 -3
View File
@@ -30,7 +30,7 @@ A Sales Channel is a method a business offers its products for purchase for the
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -39,7 +39,7 @@ A Sales Channel is a method a business offers its products for purchase for the
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ A Sales Channel is a method a business offers its products for purchase for the
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/SalesChannelInventoryService.mdx
+29 -38
View File
@@ -127,18 +127,9 @@ ___
[IInventoryService](../interfaces/IInventoryService.mdx)
<ParameterTypes parameters={[
{
"name": "__joinerConfig",
"type": "() => [ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "adjustInventory",
"type": "(`inventoryItemId`: `string`, `locationId`: `string`, `adjustment`: `number`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"type": "(`inventoryItemId`: `string`, `locationId`: `string`, `adjustment`: `number`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -147,7 +138,7 @@ ___
},
{
"name": "confirmInventory",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;boolean&#62;",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `quantity`: `number`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;boolean&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -156,7 +147,7 @@ ___
},
{
"name": "createInventoryItem",
"type": "(`input`: [CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"type": "(`input`: [CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -165,7 +156,7 @@ ___
},
{
"name": "createInventoryItems",
"type": "(`input`: [CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]&#62;",
"type": "(`input`: [CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -174,7 +165,7 @@ ___
},
{
"name": "createInventoryLevel",
"type": "(`data`: [CreateInventoryLevelInput](../types/CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"type": "(`data`: [CreateInventoryLevelInput](../interfaces/CreateInventoryLevelInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -183,7 +174,7 @@ ___
},
{
"name": "createInventoryLevels",
"type": "(`data`: [CreateInventoryLevelInput](../types/CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;",
"type": "(`data`: [CreateInventoryLevelInput](../interfaces/CreateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -192,7 +183,7 @@ ___
},
{
"name": "createReservationItem",
"type": "(`input`: [CreateReservationItemInput](../types/CreateReservationItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"type": "(`input`: [CreateReservationItemInput](../interfaces/CreateReservationItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -201,7 +192,7 @@ ___
},
{
"name": "createReservationItems",
"type": "(`input`: [CreateReservationItemInput](../types/CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]&#62;",
"type": "(`input`: [CreateReservationItemInput](../interfaces/CreateReservationItemInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -210,7 +201,7 @@ ___
},
{
"name": "deleteInventoryItem",
"type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -219,7 +210,7 @@ ___
},
{
"name": "deleteInventoryItemLevelByLocationId",
"type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -228,7 +219,7 @@ ___
},
{
"name": "deleteInventoryLevel",
"type": "(`inventoryLevelId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -237,7 +228,7 @@ ___
},
{
"name": "deleteReservationItem",
"type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`reservationItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -246,7 +237,7 @@ ___
},
{
"name": "deleteReservationItemByLocationId",
"type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`locationId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -255,7 +246,7 @@ ___
},
{
"name": "deleteReservationItemsByLineItem",
"type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`lineItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -264,7 +255,7 @@ ___
},
{
"name": "listInventoryItems",
"type": "(`selector`: [FilterableInventoryItemProps](../types/FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]&#62;",
"type": "(`selector`: [FilterableInventoryItemProps](../interfaces/FilterableInventoryItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[[InventoryItemDTO](../types/InventoryItemDTO.mdx)[], number]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -273,7 +264,7 @@ ___
},
{
"name": "listInventoryLevels",
"type": "(`selector`: [FilterableInventoryLevelProps](../types/FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]&#62;",
"type": "(`selector`: [FilterableInventoryLevelProps](../interfaces/FilterableInventoryLevelProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[], number]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -282,7 +273,7 @@ ___
},
{
"name": "listReservationItems",
"type": "(`selector`: [FilterableReservationItemProps](../types/FilterableReservationItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]&#62;",
"type": "(`selector`: [FilterableReservationItemProps](../interfaces/FilterableReservationItemProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[[ReservationItemDTO](../types/ReservationItemDTO.mdx)[], number]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -291,7 +282,7 @@ ___
},
{
"name": "restoreInventoryItem",
"type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`inventoryItemId`: `string` \\| `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -300,7 +291,7 @@ ___
},
{
"name": "retrieveAvailableQuantity",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;number&#62;",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;number&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -309,7 +300,7 @@ ___
},
{
"name": "retrieveInventoryItem",
"type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"type": "(`inventoryItemId`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -318,7 +309,7 @@ ___
},
{
"name": "retrieveInventoryLevel",
"type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"type": "(`inventoryItemId`: `string`, `locationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -327,7 +318,7 @@ ___
},
{
"name": "retrieveReservationItem",
"type": "(`reservationId`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"type": "(`reservationId`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -336,7 +327,7 @@ ___
},
{
"name": "retrieveReservedQuantity",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;number&#62;",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;number&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -345,7 +336,7 @@ ___
},
{
"name": "retrieveStockedQuantity",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;number&#62;",
"type": "(`inventoryItemId`: `string`, `locationIds`: `string`[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;number&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -354,7 +345,7 @@ ___
},
{
"name": "updateInventoryItem",
"type": "(`inventoryItemId`: `string`, `input`: [CreateInventoryItemInput](../types/CreateInventoryItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"type": "(`inventoryItemId`: `string`, `input`: [Partial](../types/Partial.mdx)&#60;[CreateInventoryItemInput](../interfaces/CreateInventoryItemInput.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryItemDTO](../types/InventoryItemDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -363,7 +354,7 @@ ___
},
{
"name": "updateInventoryLevel",
"type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../types/UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"type": "(`inventoryItemId`: `string`, `locationId`: `string`, `update`: [UpdateInventoryLevelInput](../interfaces/UpdateInventoryLevelInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -372,7 +363,7 @@ ___
},
{
"name": "updateInventoryLevels",
"type": "(`updates`: `&#123; inventory_item_id: string ; location_id: string &#125;` & [UpdateInventoryLevelInput](../types/UpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;",
"type": "(`updates`: [BulkUpdateInventoryLevelInput](../interfaces/BulkUpdateInventoryLevelInput.mdx)[], `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[InventoryLevelDTO](../types/InventoryLevelDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -381,7 +372,7 @@ ___
},
{
"name": "updateReservationItem",
"type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../types/UpdateReservationItemInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"type": "(`reservationItemId`: `string`, `input`: [UpdateReservationItemInput](../interfaces/UpdateReservationItemInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[ReservationItemDTO](../types/ReservationItemDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -527,7 +518,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/SalesChannelLocation.mdx
+1 -1
View File
@@ -30,7 +30,7 @@ This represents the association between a sales channel and a stock locations.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/SalesChannelLocationService.mdx
+7 -16
View File
@@ -129,18 +129,9 @@ ___
[IStockLocationService](../interfaces/IStockLocationService.mdx)
<ParameterTypes parameters={[
{
"name": "__joinerConfig",
"type": "() => [ModuleJoinerConfig](../types/ModuleJoinerConfig.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "create",
"type": "(`input`: [CreateStockLocationInput](../types/CreateStockLocationInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"type": "(`input`: [CreateStockLocationInput](../types/CreateStockLocationInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -149,7 +140,7 @@ ___
},
{
"name": "delete",
"type": "(`id`: `string`, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;void&#62;",
"type": "(`id`: `string`, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;void&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -158,7 +149,7 @@ ___
},
{
"name": "list",
"type": "(`selector`: [FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;",
"type": "(`selector`: [FilterableStockLocationProps](../interfaces/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)[]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -167,7 +158,7 @@ ___
},
{
"name": "listAndCount",
"type": "(`selector`: [FilterableStockLocationProps](../types/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;",
"type": "(`selector`: [FilterableStockLocationProps](../interfaces/FilterableStockLocationProps.mdx), `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[[StockLocationDTO](../types/StockLocationDTO.mdx)[], number]&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -176,7 +167,7 @@ ___
},
{
"name": "retrieve",
"type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"type": "(`id`: `string`, `config?`: [FindConfig](../interfaces/FindConfig-1.mdx)&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;, `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -185,7 +176,7 @@ ___
},
{
"name": "update",
"type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx), `context?`: [SharedContext](../types/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"type": "(`id`: `string`, `input`: [UpdateStockLocationInput](../types/UpdateStockLocationInput.mdx), `context?`: [SharedContext](../interfaces/SharedContext.mdx)) => Promise&#60;[StockLocationDTO](../types/StockLocationDTO.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -454,7 +445,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/SalesChannelService.mdx
+2 -2
View File
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "salesChannelRepository_",
"type": "Repository&#60;[SalesChannel](SalesChannel.mdx)&#62; & `&#123; addProducts: Method addProducts ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; listProductIdsBySalesChannelIds: Method listProductIdsBySalesChannelIds ; removeProducts: Method removeProducts &#125;`",
"type": "Repository&#60;[SalesChannel](SalesChannel.mdx)&#62; & ``{ addProducts: Method addProducts ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; listProductIdsBySalesChannelIds: Method listProductIdsBySalesChannelIds ; removeProducts: Method removeProducts }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -701,7 +701,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ShippingMethod.mdx
+1 -1
View File
@@ -48,7 +48,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "claim_order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the claim that the shipping method is used in.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ShippingMethodTaxLine.mdx
+1 -1
View File
@@ -21,7 +21,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
<ParameterTypes parameters={[
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ShippingOption.mdx
+2 -2
View File
@@ -30,7 +30,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ShippingOptionService.mdx
+8 -8
View File
@@ -87,7 +87,7 @@ Provides layer to manipulate profiles.
},
{
"name": "optionRepository_",
"type": "Repository&#60;[ShippingOption](ShippingOption.mdx)&#62; & `&#123; upsertShippingProfile: Method upsertShippingProfile &#125;`",
"type": "Repository&#60;[ShippingOption](ShippingOption.mdx)&#62; & ``{ upsertShippingProfile: Method upsertShippingProfile }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -698,7 +698,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -869,7 +869,7 @@ ___
### validateAndMutatePrice
`Private **validateAndMutatePrice**(option, priceInput): Promise&#60;[CreateShippingOptionInput](../types/CreateShippingOptionInput.mdx) \| [Omit](../types/Omit.mdx)&#60;[ShippingOption](ShippingOption.mdx), `"beforeInsert"`&#62;&#62;`
`Private **validateAndMutatePrice**(option, priceInput): Promise&#60;[CreateShippingOptionInput](../types/CreateShippingOptionInput.mdx) \| [Omit](../types/Omit.mdx)&#60;[ShippingOption](ShippingOption.mdx), "beforeInsert"&#62;&#62;`
#### Parameters
@@ -896,12 +896,12 @@ ___
#### Returns
Promise&#60;[CreateShippingOptionInput](../types/CreateShippingOptionInput.mdx) \| [Omit](../types/Omit.mdx)&#60;[ShippingOption](ShippingOption.mdx), `"beforeInsert"`&#62;&#62;
Promise&#60;[CreateShippingOptionInput](../types/CreateShippingOptionInput.mdx) \| [Omit](../types/Omit.mdx)&#60;[ShippingOption](ShippingOption.mdx), "beforeInsert"&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[CreateShippingOptionInput](../types/CreateShippingOptionInput.mdx) \\| [Omit](../types/Omit.mdx)&#60;[ShippingOption](ShippingOption.mdx), `\"beforeInsert\"`&#62;&#62;",
"type": "Promise&#60;[CreateShippingOptionInput](../types/CreateShippingOptionInput.mdx) \\| [Omit](../types/Omit.mdx)&#60;[ShippingOption](ShippingOption.mdx), \"beforeInsert\"&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -914,7 +914,7 @@ ___
### validateCartOption
`**validateCartOption**(option, cart): Promise&#60;`null` \| [ShippingOption](ShippingOption.mdx)&#62;`
`**validateCartOption**(option, cart): Promise&#60;null \| [ShippingOption](ShippingOption.mdx)&#62;`
Checks if a given option id is a valid option for a cart. If it is the
option is returned with the correct price. Throws when region\_ids do not
@@ -945,12 +945,12 @@ match, or when the shipping option requirements are not satisfied.
#### Returns
Promise&#60;`null` \| [ShippingOption](ShippingOption.mdx)&#62;
Promise&#60;null \| [ShippingOption](ShippingOption.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;`null` \\| [ShippingOption](ShippingOption.mdx)&#62;",
"type": "Promise&#60;null \\| [ShippingOption](ShippingOption.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the validated shipping option",
www/apps/docs/content/references/services/classes/ShippingProfile.mdx
+1 -1
View File
@@ -30,7 +30,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/ShippingProfileService.mdx
+10 -10
View File
@@ -89,7 +89,7 @@ Provides layer to manipulate profiles.
},
{
"name": "productRepository_",
"type": "Repository&#60;[Product](Product.mdx)&#62; & `&#123; _applyCategoriesQuery: Method \\_applyCategoriesQuery ; _findWithRelations: Method \\_findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds &#125;`",
"type": "Repository&#60;[Product](Product.mdx)&#62; & ``{ _applyCategoriesQuery: Method _applyCategoriesQuery ; _findWithRelations: Method _findWithRelations ; bulkAddToCollection: Method bulkAddToCollection ; bulkRemoveFromCollection: Method bulkRemoveFromCollection ; findOneWithRelations: Method findOneWithRelations ; findWithRelations: Method findWithRelations ; findWithRelationsAndCount: Method findWithRelationsAndCount ; getCategoryIdsFromInput: Method getCategoryIdsFromInput ; getCategoryIdsRecursively: Method getCategoryIdsRecursively ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; isProductInSalesChannels: Method isProductInSalesChannels ; queryProducts: Method queryProducts ; queryProductsWithIds: Method queryProductsWithIds }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -116,7 +116,7 @@ Provides layer to manipulate profiles.
},
{
"name": "shippingProfileRepository_",
"type": "Repository&#60;[ShippingProfile](ShippingProfile.mdx)&#62; & `&#123; findByProducts: Method findByProducts &#125;`",
"type": "Repository&#60;[ShippingProfile](ShippingProfile.mdx)&#62; & ``{ findByProducts: Method findByProducts }``",
"description": "",
"optional": false,
"defaultValue": "",
@@ -675,7 +675,7 @@ Removes a product or an array of products from the profile.
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "the profile to add the products to.",
"optional": false,
"defaultValue": "",
@@ -761,16 +761,16 @@ ___
### retrieveDefault
`**retrieveDefault**(): Promise&#60;`null` \| [ShippingProfile](ShippingProfile.mdx)&#62;`
`**retrieveDefault**(): Promise&#60;null \| [ShippingProfile](ShippingProfile.mdx)&#62;`
#### Returns
Promise&#60;`null` \| [ShippingProfile](ShippingProfile.mdx)&#62;
Promise&#60;null \| [ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;`null` \\| [ShippingProfile](ShippingProfile.mdx)&#62;",
"type": "Promise&#60;null \\| [ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -819,18 +819,18 @@ ___
### retrieveGiftCardDefault
`**retrieveGiftCardDefault**(): Promise&#60;`null` \| [ShippingProfile](ShippingProfile.mdx)&#62;`
`**retrieveGiftCardDefault**(): Promise&#60;null \| [ShippingProfile](ShippingProfile.mdx)&#62;`
Retrieves the default gift card profile
#### Returns
Promise&#60;`null` \| [ShippingProfile](ShippingProfile.mdx)&#62;
Promise&#60;null \| [ShippingProfile](ShippingProfile.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;`null` \\| [ShippingProfile](ShippingProfile.mdx)&#62;",
"type": "Promise&#60;null \\| [ShippingProfile](ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the shipping profile for gift cards",
@@ -850,7 +850,7 @@ ___
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"type": "`Record<string, unknown>` \\| ``{ code: string }``",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/services/classes/SoftDeletableEntity.mdx
+1 -1
View File
@@ -28,7 +28,7 @@ Base abstract entity for all entities
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "",
"optional": false,
"defaultValue": "",

Some files were not shown because too many files have changed in this diff Show More