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

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/pricing/interfaces/AddPricesDTO.mdx
+3 -3
View File
@@ -22,7 +22,7 @@ The prices to add to a price set.
},
{
"name": "prices",
"type": "[`CreatePricesDTO`](CreatePricesDTO.mdx)[]",
"type": "[CreatePricesDTO](CreatePricesDTO.mdx)[]",
"description": "The prices to add to the price set.",
"optional": false,
"defaultValue": "",
@@ -39,7 +39,7 @@ The prices to add to a price set.
},
{
"name": "currency",
"type": "[`CreateCurrencyDTO`](CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
@@ -121,7 +121,7 @@ The prices to add to a price set.
},
{
"name": "rules",
"type": "Record<`string`, `string`\\>",
"type": "`Record<string, string>`",
"description": "The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/AddRulesDTO.mdx
+1 -1
View File
@@ -22,7 +22,7 @@ The rules to add to a price set.
},
{
"name": "rules",
"type": "{ `attribute`: `string` }[]",
"type": "`&#123; attribute: string &#125;`[]",
"description": "The rules to add to a price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/BaseFilterable.mdx
+2 -2
View File
@@ -27,7 +27,7 @@ An object used to allow specifying flexible queries with and/or conditions.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "(`T` \\| [`BaseFilterable`](BaseFilterable.mdx)<`T`\\>)[]",
"type": "(`T` \\| [BaseFilterable](BaseFilterable.mdx)&#60;T&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -36,7 +36,7 @@ An object used to allow specifying flexible queries with and/or conditions.
},
{
"name": "$or",
"type": "(`T` \\| [`BaseFilterable`](BaseFilterable.mdx)<`T`\\>)[]",
"type": "(`T` \\| [BaseFilterable](BaseFilterable.mdx)&#60;T&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/CreateMoneyAmountDTO.mdx
+1 -1
View File
@@ -22,7 +22,7 @@ The money amount to create.
},
{
"name": "currency",
"type": "[`CreateCurrencyDTO`](CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/CreatePriceSetDTO.mdx
+4 -4
View File
@@ -13,7 +13,7 @@ A price set to create.
<ParameterTypes parameters={[
{
"name": "prices",
"type": "[`CreatePricesDTO`](CreatePricesDTO.mdx)[]",
"type": "[CreatePricesDTO](CreatePricesDTO.mdx)[]",
"description": "The prices to create and add to this price set.",
"optional": true,
"defaultValue": "",
@@ -30,7 +30,7 @@ A price set to create.
},
{
"name": "currency",
"type": "[`CreateCurrencyDTO`](CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
@@ -112,7 +112,7 @@ A price set to create.
},
{
"name": "rules",
"type": "Record<`string`, `string`\\>",
"type": "`Record<string, string>`",
"description": "The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.",
"optional": false,
"defaultValue": "",
@@ -123,7 +123,7 @@ A price set to create.
},
{
"name": "rules",
"type": "{ `rule_attribute`: `string` }[]",
"type": "`&#123; rule_attribute: string &#125;`[]",
"description": "The rules to associate with the price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/CreatePricesDTO.mdx
+2 -2
View File
@@ -22,7 +22,7 @@ The prices to create part of a price set.
},
{
"name": "currency",
"type": "[`CreateCurrencyDTO`](CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
@@ -104,7 +104,7 @@ The prices to create part of a price set.
},
{
"name": "rules",
"type": "Record<`string`, `string`\\>",
"type": "`Record<string, string>`",
"description": "The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/CreateRuleTypeDTO.mdx
+1 -1
View File
@@ -41,7 +41,7 @@ The rule type to create.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/FilterableCurrencyProps.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ Filters to apply on a currency.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterableCurrencyProps`](FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableCurrencyProps`](FilterableCurrencyProps.mdx)\\>)[]",
"type": "([FilterableCurrencyProps](FilterableCurrencyProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableCurrencyProps](FilterableCurrencyProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ Filters to apply on a currency.
},
{
"name": "$or",
"type": "([`FilterableCurrencyProps`](FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableCurrencyProps`](FilterableCurrencyProps.mdx)\\>)[]",
"type": "([FilterableCurrencyProps](FilterableCurrencyProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableCurrencyProps](FilterableCurrencyProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterableMoneyAmountProps.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ Filters to apply on a money amount.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ Filters to apply on a money amount.
},
{
"name": "$or",
"type": "([`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterablePriceRuleProps.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ Filters to apply to price rules.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterablePriceRuleProps`](FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceRuleProps`](FilterablePriceRuleProps.mdx)\\>)[]",
"type": "([FilterablePriceRuleProps](FilterablePriceRuleProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceRuleProps](FilterablePriceRuleProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ Filters to apply to price rules.
},
{
"name": "$or",
"type": "([`FilterablePriceRuleProps`](FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceRuleProps`](FilterablePriceRuleProps.mdx)\\>)[]",
"type": "([FilterablePriceRuleProps](FilterablePriceRuleProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceRuleProps](FilterablePriceRuleProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountProps.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ Filters to apply on price set money amounts.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterablePriceSetMoneyAmountProps`](FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountProps](FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountProps](FilterablePriceSetMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ Filters to apply on price set money amounts.
},
{
"name": "$or",
"type": "([`FilterablePriceSetMoneyAmountProps`](FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountProps](FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountProps](FilterablePriceSetMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ Filters to apply on price set money amount rules.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterablePriceSetMoneyAmountRulesProps`](FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountRulesProps](FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountRulesProps](FilterablePriceSetMoneyAmountRulesProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ Filters to apply on price set money amount rules.
},
{
"name": "$or",
"type": "([`FilterablePriceSetMoneyAmountRulesProps`](FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountRulesProps](FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountRulesProps](FilterablePriceSetMoneyAmountRulesProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetProps.mdx
+5 -5
View File
@@ -13,7 +13,7 @@ Filters to apply on price sets.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterablePriceSetProps`](FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetProps`](FilterablePriceSetProps.mdx)\\>)[]",
"type": "([FilterablePriceSetProps](FilterablePriceSetProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetProps](FilterablePriceSetProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ Filters to apply on price sets.
},
{
"name": "$or",
"type": "([`FilterablePriceSetProps`](FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetProps`](FilterablePriceSetProps.mdx)\\>)[]",
"type": "([FilterablePriceSetProps](FilterablePriceSetProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetProps](FilterablePriceSetProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
@@ -40,7 +40,7 @@ Filters to apply on price sets.
},
{
"name": "money_amounts",
"type": "[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)",
"type": "[FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx)",
"description": "Filters to apply on a price set's associated money amounts.",
"optional": true,
"defaultValue": "",
@@ -48,7 +48,7 @@ Filters to apply on price sets.
"children": [
{
"name": "$and",
"type": "([`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -57,7 +57,7 @@ Filters to apply on price sets.
},
{
"name": "$or",
"type": "([`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterableRuleTypeProps.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ Filters to apply on rule types.
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterableRuleTypeProps`](FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableRuleTypeProps`](FilterableRuleTypeProps.mdx)\\>)[]",
"type": "([FilterableRuleTypeProps](FilterableRuleTypeProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableRuleTypeProps](FilterableRuleTypeProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ Filters to apply on rule types.
},
{
"name": "$or",
"type": "([`FilterableRuleTypeProps`](FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableRuleTypeProps`](FilterableRuleTypeProps.mdx)\\>)[]",
"type": "([FilterableRuleTypeProps](FilterableRuleTypeProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableRuleTypeProps](FilterableRuleTypeProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfig.mdx
+9 -9
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "alias",
"type": "[`JoinerServiceConfigAlias`](JoinerServiceConfigAlias.mdx) \\| [`JoinerServiceConfigAlias`](JoinerServiceConfigAlias.mdx)[]",
"type": "[JoinerServiceConfigAlias](JoinerServiceConfigAlias.mdx) \\| [JoinerServiceConfigAlias](JoinerServiceConfigAlias.mdx)[]",
"description": "Property name to use as entrypoint to the service",
"optional": true,
"defaultValue": "",
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "args",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "extends",
"type": "{ `relationship`: [`JoinerRelationship`](../types/JoinerRelationship.mdx) ; `serviceName`: `string` }[]",
"type": "`&#123; relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string &#125;`[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -37,7 +37,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"children": [
{
"name": "relationship",
"type": "[`JoinerRelationship`](../types/JoinerRelationship.mdx)",
"type": "[JoinerRelationship](../types/JoinerRelationship.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -54,7 +54,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "args",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
@@ -130,8 +130,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "fieldAlias",
"type": "Record<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\>",
"description": "alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })",
"type": "`Record<string, string \\| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;>`",
"description": "alias for deeper nested relationships (e.g. &#123; 'price': 'prices.calculated\\_price\\_set.amount' &#125;)",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -148,7 +148,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "relationships",
"type": "[`JoinerRelationship`](../types/JoinerRelationship.mdx)[]",
"type": "[JoinerRelationship](../types/JoinerRelationship.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -165,7 +165,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "args",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfigAlias.mdx
+1 -1
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "args",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx
+1 -1
View File
@@ -22,7 +22,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "currency",
"type": "[`CurrencyDTO`](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx
+7 -7
View File
@@ -31,7 +31,7 @@ A price rule's data.
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ A price rule's data.
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -65,7 +65,7 @@ A price rule's data.
},
{
"name": "currency",
"type": "[`CurrencyDTO`](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"optional": true,
"defaultValue": "",
@@ -112,7 +112,7 @@ A price rule's data.
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -148,7 +148,7 @@ A price rule's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -187,7 +187,7 @@ A price rule's data.
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
@@ -223,7 +223,7 @@ A price rule's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx
+4 -4
View File
@@ -22,7 +22,7 @@ A price set's data.
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -39,7 +39,7 @@ A price set's data.
},
{
"name": "currency",
"type": "[`CurrencyDTO`](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"optional": true,
"defaultValue": "",
@@ -123,7 +123,7 @@ A price set's data.
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -159,7 +159,7 @@ A price set's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx
+13 -13
View File
@@ -22,7 +22,7 @@ A price set money amount's data.
},
{
"name": "money_amount",
"type": "[`MoneyAmountDTO`](MoneyAmountDTO.mdx)",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.",
"optional": true,
"defaultValue": "",
@@ -39,7 +39,7 @@ A price set money amount's data.
},
{
"name": "currency",
"type": "[`CurrencyDTO`](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"optional": true,
"defaultValue": "",
@@ -123,7 +123,7 @@ A price set money amount's data.
},
{
"name": "price_rules",
"type": "[`PriceRuleDTO`](PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -149,7 +149,7 @@ A price set money amount's data.
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
@@ -166,7 +166,7 @@ A price set money amount's data.
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -175,7 +175,7 @@ A price set money amount's data.
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -213,7 +213,7 @@ A price set money amount's data.
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
@@ -249,7 +249,7 @@ A price set money amount's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -279,7 +279,7 @@ A price set money amount's data.
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.",
"optional": true,
"defaultValue": "",
@@ -296,7 +296,7 @@ A price set money amount's data.
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -313,7 +313,7 @@ A price set money amount's data.
},
{
"name": "currency",
"type": "[`CurrencyDTO`](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"optional": true,
"defaultValue": "",
@@ -360,7 +360,7 @@ A price set money amount's data.
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -396,7 +396,7 @@ A price set money amount's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx
+11 -11
View File
@@ -22,7 +22,7 @@ A price set money amount rule's data.
},
{
"name": "price_set_money_amount",
"type": "[`PriceSetMoneyAmountDTO`](PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.",
"optional": false,
"defaultValue": "",
@@ -39,7 +39,7 @@ A price set money amount rule's data.
},
{
"name": "money_amount",
"type": "[`MoneyAmountDTO`](MoneyAmountDTO.mdx)",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.",
"optional": true,
"defaultValue": "",
@@ -56,7 +56,7 @@ A price set money amount rule's data.
},
{
"name": "currency",
"type": "[`CurrencyDTO`](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"optional": true,
"defaultValue": "",
@@ -103,7 +103,7 @@ A price set money amount rule's data.
},
{
"name": "price_rules",
"type": "[`PriceRuleDTO`](PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -129,7 +129,7 @@ A price set money amount rule's data.
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ A price set money amount rule's data.
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
@@ -194,7 +194,7 @@ A price set money amount rule's data.
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.",
"optional": true,
"defaultValue": "",
@@ -211,7 +211,7 @@ A price set money amount rule's data.
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -220,7 +220,7 @@ A price set money amount rule's data.
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -251,7 +251,7 @@ A price set money amount rule's data.
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
@@ -287,7 +287,7 @@ A price set money amount rule's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/PricingContext.mdx
+1 -1
View File
@@ -13,7 +13,7 @@ The context to calculate prices. For example, you can specify the currency code
<ParameterTypes parameters={[
{
"name": "context",
"type": "Record<`string`, `string` \\| `number`\\>",
"type": "`Record<string, string \\| number>`",
"description": "an object whose keys are the name of the context attribute. Its value can be a string or a number. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in. Another example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/RuleTypeDTO.mdx
+1 -1
View File
@@ -41,7 +41,7 @@ A rule type's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/UpdateRuleTypeDTO.mdx
+1 -1
View File
@@ -41,7 +41,7 @@ The data to update in a rule type. The `id` is used to identify which price set
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": true,
"defaultValue": "",
"expandable": false,