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

42
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPrices.mdx
View File

@@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
This documentation provides a reference to the `addPrices` method. This belongs to the Pricing Module.
## addPrices(data, sharedContext?): Promise<PriceSetDTO\>
## addPrices(data, sharedContext?): Promise&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)&#62;
This method adds prices to a price set.
@@ -93,7 +93,7 @@ async function addPricesToPriceSet (priceSetId: string) {
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`AddPricesDTO`](../../interfaces/AddPricesDTO.mdx)",
"type": "[AddPricesDTO](../../interfaces/AddPricesDTO.mdx)",
"description": "The data defining the price set to add the prices to, along with the prices to add.",
"optional": false,
"defaultValue": "",
@@ -110,7 +110,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "prices",
"type": "[`CreatePricesDTO`](../../interfaces/CreatePricesDTO.mdx)[]",
"type": "[CreatePricesDTO](../../interfaces/CreatePricesDTO.mdx)[]",
"description": "The prices to add to the price set.",
"optional": false,
"defaultValue": "",
@@ -127,7 +127,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "currency",
"type": "[`CreateCurrencyDTO`](../../interfaces/CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](../../interfaces/CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
@@ -172,7 +172,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"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": "",
@@ -185,7 +185,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -245,7 +245,7 @@ async function addPricesToPriceSet (priceSetId: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)\\>",
"type": "Promise&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "The price set that the prices were added to.",
@@ -262,7 +262,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -279,7 +279,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "currency",
"type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)",
"type": "[CurrencyDTO](../../interfaces/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": "",
@@ -326,7 +326,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -362,7 +362,7 @@ async function addPricesToPriceSet (priceSetId: string) {
{
"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,
@@ -374,7 +374,7 @@ async function addPricesToPriceSet (priceSetId: string) {
}
]} />
## addPrices(data, sharedContext?): Promise<PriceSetDTO[]\>
## addPrices(data, sharedContext?): Promise&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)[]&#62;
This method adds prices to multiple price sets.
@@ -454,7 +454,7 @@ async function addPricesToPriceSet (priceSetId: string) {
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`AddPricesDTO`](../../interfaces/AddPricesDTO.mdx)[]",
"type": "[AddPricesDTO](../../interfaces/AddPricesDTO.mdx)[]",
"description": "The data defining the prices to add per price set.",
"optional": false,
"defaultValue": "",
@@ -471,7 +471,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "prices",
"type": "[`CreatePricesDTO`](../../interfaces/CreatePricesDTO.mdx)[]",
"type": "[CreatePricesDTO](../../interfaces/CreatePricesDTO.mdx)[]",
"description": "The prices to add to the price set.",
"optional": false,
"defaultValue": "",
@@ -488,7 +488,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "currency",
"type": "[`CreateCurrencyDTO`](../../interfaces/CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](../../interfaces/CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
@@ -533,7 +533,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"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": "",
@@ -546,7 +546,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -606,7 +606,7 @@ async function addPricesToPriceSet (priceSetId: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]\\>",
"type": "Promise&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of the price sets that prices were added to.",
@@ -614,7 +614,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"children": [
{
"name": "PriceSetDTO[]",
"type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]",
"type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -631,7 +631,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -640,7 +640,7 @@ async function addPricesToPriceSet (priceSetId: string) {
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",

34
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addRules.mdx
View File

@@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
This documentation provides a reference to the `addRules` method. This belongs to the Pricing Module.
## addRules(data, sharedContext?): Promise<PriceSetDTO\>
## addRules(data, sharedContext?): Promise&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)&#62;
This method adds rules to a price set.
@@ -43,7 +43,7 @@ async function addRulesToPriceSet (priceSetId: string) {
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`AddRulesDTO`](../../interfaces/AddRulesDTO.mdx)",
"type": "[AddRulesDTO](../../interfaces/AddRulesDTO.mdx)",
"description": "The data defining the price set to add the rules to, along with the rules to add.",
"optional": false,
"defaultValue": "",
@@ -60,7 +60,7 @@ async function addRulesToPriceSet (priceSetId: string) {
},
{
"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": "",
@@ -81,7 +81,7 @@ async function addRulesToPriceSet (priceSetId: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -141,7 +141,7 @@ async function addRulesToPriceSet (priceSetId: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)\\>",
"type": "Promise&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "The price set that the rules were added to.",
@@ -158,7 +158,7 @@ async function addRulesToPriceSet (priceSetId: string) {
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -175,7 +175,7 @@ async function addRulesToPriceSet (priceSetId: string) {
},
{
"name": "currency",
"type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)",
"type": "[CurrencyDTO](../../interfaces/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": "",
@@ -222,7 +222,7 @@ async function addRulesToPriceSet (priceSetId: string) {
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -258,7 +258,7 @@ async function addRulesToPriceSet (priceSetId: string) {
{
"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,
@@ -270,7 +270,7 @@ async function addRulesToPriceSet (priceSetId: string) {
}
]} />
## addRules(data, sharedContext?): Promise<PriceSetDTO[]\>
## addRules(data, sharedContext?): Promise&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)[]&#62;
This method adds rules to multiple price sets.
@@ -300,7 +300,7 @@ async function addRulesToPriceSet (priceSetId: string) {
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`AddRulesDTO`](../../interfaces/AddRulesDTO.mdx)[]",
"type": "[AddRulesDTO](../../interfaces/AddRulesDTO.mdx)[]",
"description": "The data defining the rules to add per price set.",
"optional": false,
"defaultValue": "",
@@ -317,7 +317,7 @@ async function addRulesToPriceSet (priceSetId: string) {
},
{
"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": "",
@@ -338,7 +338,7 @@ async function addRulesToPriceSet (priceSetId: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -398,7 +398,7 @@ async function addRulesToPriceSet (priceSetId: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]\\>",
"type": "Promise&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of the price sets that the rules were added to.",
@@ -406,7 +406,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"children": [
{
"name": "PriceSetDTO[]",
"type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]",
"type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -423,7 +423,7 @@ async function addRulesToPriceSet (priceSetId: string) {
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -432,7 +432,7 @@ async function addRulesToPriceSet (priceSetId: string) {
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",

10
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.calculatePrices.mdx
View File

@@ -90,7 +90,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`PricingFilters`](../../interfaces/PricingFilters.mdx)",
"type": "[PricingFilters](../../interfaces/PricingFilters.mdx)",
"description": "The filters to apply on prices.",
"optional": false,
"defaultValue": "",
@@ -109,7 +109,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
},
{
"name": "context",
"type": "[`PricingContext`](../../interfaces/PricingContext.mdx)",
"type": "[PricingContext](../../interfaces/PricingContext.mdx)",
"description": "The context used to select the prices. For example, you can specify the region ID in this context, and only prices having the same value will be retrieved.",
"optional": true,
"defaultValue": "",
@@ -117,7 +117,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"children": [
{
"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": "",
@@ -128,7 +128,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -188,7 +188,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`CalculatedPriceSetDTO`](../../interfaces/CalculatedPriceSetDTO.mdx)\\>",
"type": "Promise&#60;[CalculatedPriceSetDTO](../../interfaces/CalculatedPriceSetDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "The calculated price matching the context and filters provided.",

46
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.create.mdx
View File

@@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
This documentation provides a reference to the `create` method. This belongs to the Pricing Module.
## create(data, sharedContext?): Promise<PriceSetDTO\>
## create(data, sharedContext?): Promise&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)&#62;
This method is used to create a new price set.
@@ -96,7 +96,7 @@ async function createPriceSet() {
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreatePriceSetDTO`](../../interfaces/CreatePriceSetDTO.mdx)",
"type": "[CreatePriceSetDTO](../../interfaces/CreatePriceSetDTO.mdx)",
"description": "The attributes of the price set to create.",
"optional": false,
"defaultValue": "",
@@ -104,7 +104,7 @@ async function createPriceSet() {
"children": [
{
"name": "prices",
"type": "[`CreatePricesDTO`](../../interfaces/CreatePricesDTO.mdx)[]",
"type": "[CreatePricesDTO](../../interfaces/CreatePricesDTO.mdx)[]",
"description": "The prices to create and add to this price set.",
"optional": true,
"defaultValue": "",
@@ -121,7 +121,7 @@ async function createPriceSet() {
},
{
"name": "currency",
"type": "[`CreateCurrencyDTO`](../../interfaces/CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](../../interfaces/CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
@@ -166,7 +166,7 @@ async function createPriceSet() {
},
{
"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": "",
@@ -177,7 +177,7 @@ async function createPriceSet() {
},
{
"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": "",
@@ -198,7 +198,7 @@ async function createPriceSet() {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -258,7 +258,7 @@ async function createPriceSet() {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)\\>",
"type": "Promise&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "The created price set.",
@@ -275,7 +275,7 @@ async function createPriceSet() {
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -292,7 +292,7 @@ async function createPriceSet() {
},
{
"name": "currency",
"type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)",
"type": "[CurrencyDTO](../../interfaces/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": "",
@@ -339,7 +339,7 @@ async function createPriceSet() {
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -375,7 +375,7 @@ async function createPriceSet() {
{
"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,
@@ -387,7 +387,7 @@ async function createPriceSet() {
}
]} />
## create(data, sharedContext?): Promise<PriceSetDTO[]\>
## create(data, sharedContext?): Promise&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)[]&#62;
This method is used to create multiple price sets.
@@ -467,7 +467,7 @@ async function createPriceSets() {
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreatePriceSetDTO`](../../interfaces/CreatePriceSetDTO.mdx)[]",
"type": "[CreatePriceSetDTO](../../interfaces/CreatePriceSetDTO.mdx)[]",
"description": "The price sets to create.",
"optional": false,
"defaultValue": "",
@@ -475,7 +475,7 @@ async function createPriceSets() {
"children": [
{
"name": "prices",
"type": "[`CreatePricesDTO`](../../interfaces/CreatePricesDTO.mdx)[]",
"type": "[CreatePricesDTO](../../interfaces/CreatePricesDTO.mdx)[]",
"description": "The prices to create and add to this price set.",
"optional": true,
"defaultValue": "",
@@ -492,7 +492,7 @@ async function createPriceSets() {
},
{
"name": "currency",
"type": "[`CreateCurrencyDTO`](../../interfaces/CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](../../interfaces/CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
@@ -537,7 +537,7 @@ async function createPriceSets() {
},
{
"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": "",
@@ -548,7 +548,7 @@ async function createPriceSets() {
},
{
"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": "",
@@ -569,7 +569,7 @@ async function createPriceSets() {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -629,7 +629,7 @@ async function createPriceSets() {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]\\>",
"type": "Promise&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of created price sets.",
@@ -637,7 +637,7 @@ async function createPriceSets() {
"children": [
{
"name": "PriceSetDTO[]",
"type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]",
"type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -654,7 +654,7 @@ async function createPriceSets() {
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -663,7 +663,7 @@ async function createPriceSets() {
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",

8
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createCurrencies.mdx
View File

@@ -41,7 +41,7 @@ async function createCurrencies() {
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateCurrencyDTO`](../../interfaces/CreateCurrencyDTO.mdx)[]",
"type": "[CreateCurrencyDTO](../../interfaces/CreateCurrencyDTO.mdx)[]",
"description": "The currencies to create.",
"optional": false,
"defaultValue": "",
@@ -87,7 +87,7 @@ async function createCurrencies() {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -147,7 +147,7 @@ async function createCurrencies() {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]\\>",
"type": "Promise&#60;[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of created currencies.",
@@ -155,7 +155,7 @@ async function createCurrencies() {
"children": [
{
"name": "CurrencyDTO[]",
"type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]",
"type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",

12
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createMoneyAmounts.mdx
View File

@@ -45,7 +45,7 @@ async function retrieveMoneyAmounts() {
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateMoneyAmountDTO`](../../interfaces/CreateMoneyAmountDTO.mdx)[]",
"type": "[CreateMoneyAmountDTO](../../interfaces/CreateMoneyAmountDTO.mdx)[]",
"description": "The money amounts to create.",
"optional": false,
"defaultValue": "",
@@ -62,7 +62,7 @@ async function retrieveMoneyAmounts() {
},
{
"name": "currency",
"type": "[`CreateCurrencyDTO`](../../interfaces/CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](../../interfaces/CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
@@ -146,7 +146,7 @@ async function retrieveMoneyAmounts() {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -206,7 +206,7 @@ async function retrieveMoneyAmounts() {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]\\>",
"type": "Promise&#60;[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of created money amounts.",
@@ -214,7 +214,7 @@ async function retrieveMoneyAmounts() {
"children": [
{
"name": "MoneyAmountDTO[]",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -231,7 +231,7 @@ async function retrieveMoneyAmounts() {
},
{
"name": "currency",
"type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)",
"type": "[CurrencyDTO](../../interfaces/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": "",

12
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceRules.mdx
View File

@@ -52,7 +52,7 @@ async function createPriceRules (
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreatePriceRuleDTO`](../../interfaces/CreatePriceRuleDTO.mdx)[]",
"type": "[CreatePriceRuleDTO](../../interfaces/CreatePriceRuleDTO.mdx)[]",
"description": "The price rules to create.",
"optional": false,
"defaultValue": "",
@@ -125,7 +125,7 @@ async function createPriceRules (
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -185,7 +185,7 @@ async function createPriceRules (
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]\\>",
"type": "Promise&#60;[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of created price rules.",
@@ -193,7 +193,7 @@ async function createPriceRules (
"children": [
{
"name": "PriceRuleDTO[]",
"type": "[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -219,7 +219,7 @@ async function createPriceRules (
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)",
"type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)",
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
@@ -255,7 +255,7 @@ async function createPriceRules (
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",

12
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceSetMoneyAmountRules.mdx
View File

@@ -43,7 +43,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreatePriceSetMoneyAmountRulesDTO`](../../interfaces/CreatePriceSetMoneyAmountRulesDTO.mdx)[]",
"type": "[CreatePriceSetMoneyAmountRulesDTO](../../interfaces/CreatePriceSetMoneyAmountRulesDTO.mdx)[]",
"description": "The price set money amount rules to create.",
"optional": false,
"defaultValue": "",
@@ -80,7 +80,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -140,7 +140,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]\\>",
"type": "Promise&#60;[PriceSetMoneyAmountRulesDTO](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of created price set money amount rules.",
@@ -148,7 +148,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"children": [
{
"name": "PriceSetMoneyAmountRulesDTO[]",
"type": "[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]",
"type": "[PriceSetMoneyAmountRulesDTO](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -165,7 +165,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
},
{
"name": "price_set_money_amount",
"type": "[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](../../interfaces/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": "",
@@ -174,7 +174,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",

12
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createRuleTypes.mdx
View File

@@ -39,7 +39,7 @@ async function createRuleTypes() {
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateRuleTypeDTO`](../../interfaces/CreateRuleTypeDTO.mdx)[]",
"type": "[CreateRuleTypeDTO](../../interfaces/CreateRuleTypeDTO.mdx)[]",
"description": "The rule types to create.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ async function createRuleTypes() {
{
"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,
@@ -85,7 +85,7 @@ async function createRuleTypes() {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -145,7 +145,7 @@ async function createRuleTypes() {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]\\>",
"type": "Promise&#60;[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of created rule types.",
@@ -153,7 +153,7 @@ async function createRuleTypes() {
"children": [
{
"name": "RuleTypeDTO[]",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -189,7 +189,7 @@ async function createRuleTypes() {
{
"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,

4
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.delete.mdx
View File

@@ -43,7 +43,7 @@ async function removePriceSetRule (priceSetIds: string[]) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -103,7 +103,7 @@ async function removePriceSetRule (priceSetIds: string[]) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves when the price sets are successfully deleted.",

4
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteCurrencies.mdx
View File

@@ -41,7 +41,7 @@ async function deleteCurrencies() {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -101,7 +101,7 @@ async function deleteCurrencies() {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves once the currencies are deleted.",

4
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteMoneyAmounts.mdx
View File

@@ -45,7 +45,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -105,7 +105,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves when the money amounts are successfully deleted.",

4
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceRules.mdx
View File

@@ -45,7 +45,7 @@ async function deletePriceRules (
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -105,7 +105,7 @@ async function deletePriceRules (
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves once the price rules are deleted.",

4
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceSetMoneyAmountRules.mdx
View File

@@ -43,7 +43,7 @@ async function deletePriceSetMoneyAmountRule (id: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -103,7 +103,7 @@ async function deletePriceSetMoneyAmountRule (id: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves once the price set money amount rules are deleted.",

4
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteRuleTypes.mdx
View File

@@ -43,7 +43,7 @@ async function deleteRuleTypes (ruleTypeId: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -103,7 +103,7 @@ async function deleteRuleTypes (ruleTypeId: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves once the rule types are deleted.",

24
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.list.mdx
View File

@@ -124,7 +124,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx)",
"type": "[FilterablePriceSetProps](../../interfaces/FilterablePriceSetProps.mdx)",
"description": "The filters to apply on the retrieved price lists.",
"optional": true,
"defaultValue": "",
@@ -132,7 +132,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"children": [
{
"name": "$and",
"type": "([`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx)\\>)[]",
"type": "([FilterablePriceSetProps](../../interfaces/FilterablePriceSetProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceSetProps](../../interfaces/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": "",
@@ -141,7 +141,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
},
{
"name": "$or",
"type": "([`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx)\\>)[]",
"type": "([FilterablePriceSetProps](../../interfaces/FilterablePriceSetProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceSetProps](../../interfaces/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": "",
@@ -159,7 +159,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
},
{
"name": "money_amounts",
"type": "[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)",
"type": "[FilterableMoneyAmountProps](../../interfaces/FilterableMoneyAmountProps.mdx)",
"description": "Filters to apply on a price set's associated money amounts.",
"optional": true,
"defaultValue": "",
@@ -167,7 +167,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"children": [
{
"name": "$and",
"type": "([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterableMoneyAmountProps](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](../../interfaces/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": "",
@@ -176,7 +176,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
},
{
"name": "$or",
"type": "([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterableMoneyAmountProps](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](../../interfaces/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": "",
@@ -207,7 +207,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)&#62;",
"description": "The configurations determining how the price sets are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a price set.",
"optional": true,
"defaultValue": "",
@@ -281,7 +281,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -341,7 +341,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]\\>",
"type": "Promise&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of price sets.",
@@ -349,7 +349,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"children": [
{
"name": "PriceSetDTO[]",
"type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]",
"type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -366,7 +366,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -375,7 +375,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",

20
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCount.mdx
View File

@@ -124,7 +124,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx)",
"type": "[FilterablePriceSetProps](../../interfaces/FilterablePriceSetProps.mdx)",
"description": "The filters to apply on the retrieved price lists.",
"optional": true,
"defaultValue": "",
@@ -132,7 +132,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"children": [
{
"name": "$and",
"type": "([`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx)\\>)[]",
"type": "([FilterablePriceSetProps](../../interfaces/FilterablePriceSetProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceSetProps](../../interfaces/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": "",
@@ -141,7 +141,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
},
{
"name": "$or",
"type": "([`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx)\\>)[]",
"type": "([FilterablePriceSetProps](../../interfaces/FilterablePriceSetProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceSetProps](../../interfaces/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": "",
@@ -159,7 +159,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
},
{
"name": "money_amounts",
"type": "[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)",
"type": "[FilterableMoneyAmountProps](../../interfaces/FilterableMoneyAmountProps.mdx)",
"description": "Filters to apply on a price set's associated money amounts.",
"optional": true,
"defaultValue": "",
@@ -167,7 +167,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"children": [
{
"name": "$and",
"type": "([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterableMoneyAmountProps](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](../../interfaces/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": "",
@@ -176,7 +176,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
},
{
"name": "$or",
"type": "([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterableMoneyAmountProps](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](../../interfaces/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": "",
@@ -207,7 +207,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)&#62;",
"description": "The configurations determining how the price sets are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a price set.",
"optional": true,
"defaultValue": "",
@@ -281,7 +281,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -341,7 +341,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of price sets along with their total count.",
@@ -349,7 +349,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"children": [
{
"name": "PriceSetDTO[]",
"type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]",
"type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",

14
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountCurrencies.mdx
View File

@@ -90,7 +90,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx)",
"type": "[FilterableCurrencyProps](../../interfaces/FilterableCurrencyProps.mdx)",
"description": "The filters to apply on the retrieved currencies.",
"optional": true,
"defaultValue": "",
@@ -98,7 +98,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"children": [
{
"name": "$and",
"type": "([`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx)\\>)[]",
"type": "([FilterableCurrencyProps](../../interfaces/FilterableCurrencyProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableCurrencyProps](../../interfaces/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": "",
@@ -107,7 +107,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
},
{
"name": "$or",
"type": "([`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx)\\>)[]",
"type": "([FilterableCurrencyProps](../../interfaces/FilterableCurrencyProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableCurrencyProps](../../interfaces/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": "",
@@ -127,7 +127,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)&#62;",
"description": "The configurations determining how the currencies are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a currency.",
"optional": true,
"defaultValue": "",
@@ -201,7 +201,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -261,7 +261,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of currencies along with the total count.",
@@ -269,7 +269,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"children": [
{
"name": "CurrencyDTO[]",
"type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]",
"type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",

14
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountMoneyAmounts.mdx
View File

@@ -122,7 +122,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)",
"type": "[FilterableMoneyAmountProps](../../interfaces/FilterableMoneyAmountProps.mdx)",
"description": "The filters to apply on the retrieved money amounts.",
"optional": true,
"defaultValue": "",
@@ -130,7 +130,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"children": [
{
"name": "$and",
"type": "([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterableMoneyAmountProps](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](../../interfaces/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": "",
@@ -139,7 +139,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
},
{
"name": "$or",
"type": "([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterableMoneyAmountProps](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](../../interfaces/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": "",
@@ -168,7 +168,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)&#62;",
"description": "The configurations determining how the money amounts are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a money amount.",
"optional": true,
"defaultValue": "",
@@ -242,7 +242,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -302,7 +302,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of money amounts along with their total count.",
@@ -310,7 +310,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"children": [
{
"name": "MoneyAmountDTO[]",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",

14
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceRules.mdx
View File

@@ -111,7 +111,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx)",
"type": "[FilterablePriceRuleProps](../../interfaces/FilterablePriceRuleProps.mdx)",
"description": "The filters to apply on the retrieved price rules.",
"optional": true,
"defaultValue": "",
@@ -119,7 +119,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"children": [
{
"name": "$and",
"type": "([`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx)\\>)[]",
"type": "([FilterablePriceRuleProps](../../interfaces/FilterablePriceRuleProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceRuleProps](../../interfaces/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": "",
@@ -128,7 +128,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
},
{
"name": "$or",
"type": "([`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx)\\>)[]",
"type": "([FilterablePriceRuleProps](../../interfaces/FilterablePriceRuleProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceRuleProps](../../interfaces/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": "",
@@ -175,7 +175,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)&#62;",
"description": "The configurations determining how the price rule is retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a price rule.",
"optional": true,
"defaultValue": "",
@@ -249,7 +249,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -309,7 +309,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of price rules along with their total count.",
@@ -317,7 +317,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"children": [
{
"name": "PriceRuleDTO[]",
"type": "[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",

14
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx
View File

@@ -112,7 +112,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx)",
"type": "[FilterablePriceSetMoneyAmountRulesProps](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx)",
"description": "The filters to apply on the retrieved price set money amount rules.",
"optional": true,
"defaultValue": "",
@@ -120,7 +120,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"children": [
{
"name": "$and",
"type": "([`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountRulesProps](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountRulesProps](../../interfaces/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": "",
@@ -129,7 +129,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
},
{
"name": "$or",
"type": "([`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountRulesProps](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountRulesProps](../../interfaces/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": "",
@@ -176,7 +176,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[PriceSetMoneyAmountRulesDTO](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)&#62;",
"description": "The configurations determining how the price set money amount rules are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a price set money amount rule.",
"optional": true,
"defaultValue": "",
@@ -250,7 +250,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -310,7 +310,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[PriceSetMoneyAmountRulesDTO](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of price set money amount rules and their total count.",
@@ -318,7 +318,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"children": [
{
"name": "PriceSetMoneyAmountRulesDTO[]",
"type": "[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]",
"type": "[PriceSetMoneyAmountRulesDTO](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",

14
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx
View File

@@ -112,7 +112,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx)",
"type": "[FilterablePriceSetMoneyAmountProps](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx)",
"description": "The filters to apply on the retrieved price set money amounts.",
"optional": true,
"defaultValue": "",
@@ -120,7 +120,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"children": [
{
"name": "$and",
"type": "([`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountProps](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountProps](../../interfaces/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": "",
@@ -129,7 +129,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
},
{
"name": "$or",
"type": "([`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountProps](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountProps](../../interfaces/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": "",
@@ -158,7 +158,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)&#62;",
"description": "The configurations determining how the price set money amounts are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a price set money amount.",
"optional": true,
"defaultValue": "",
@@ -232,7 +232,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -292,7 +292,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of price set money amounts and their total count.",
@@ -300,7 +300,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"children": [
{
"name": "PriceSetMoneyAmountDTO[]",
"type": "[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)[]",
"type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",

14
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountRuleTypes.mdx
View File

@@ -117,7 +117,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx)",
"type": "[FilterableRuleTypeProps](../../interfaces/FilterableRuleTypeProps.mdx)",
"description": "The filters to apply on the retrieved rule types.",
"optional": true,
"defaultValue": "",
@@ -125,7 +125,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"children": [
{
"name": "$and",
"type": "([`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx)\\>)[]",
"type": "([FilterableRuleTypeProps](../../interfaces/FilterableRuleTypeProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableRuleTypeProps](../../interfaces/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": "",
@@ -134,7 +134,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
},
{
"name": "$or",
"type": "([`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx)\\>)[]",
"type": "([FilterableRuleTypeProps](../../interfaces/FilterableRuleTypeProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableRuleTypeProps](../../interfaces/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": "",
@@ -172,7 +172,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)&#62;",
"description": "The configurations determining how the rule types are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a rule type.",
"optional": true,
"defaultValue": "",
@@ -246,7 +246,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -306,7 +306,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[], `number`]\\>",
"type": "Promise&#60;[[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of rule types along with their total count.",
@@ -314,7 +314,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"children": [
{
"name": "RuleTypeDTO[]",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",

14
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listCurrencies.mdx
View File

@@ -90,7 +90,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx)",
"type": "[FilterableCurrencyProps](../../interfaces/FilterableCurrencyProps.mdx)",
"description": "The filters to apply on the retrieved currencies.",
"optional": true,
"defaultValue": "",
@@ -98,7 +98,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"children": [
{
"name": "$and",
"type": "([`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx)\\>)[]",
"type": "([FilterableCurrencyProps](../../interfaces/FilterableCurrencyProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableCurrencyProps](../../interfaces/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": "",
@@ -107,7 +107,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
},
{
"name": "$or",
"type": "([`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx)\\>)[]",
"type": "([FilterableCurrencyProps](../../interfaces/FilterableCurrencyProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableCurrencyProps](../../interfaces/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": "",
@@ -127,7 +127,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)&#62;",
"description": "The configurations determining how the currencies are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a currency.",
"optional": true,
"defaultValue": "",
@@ -201,7 +201,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -261,7 +261,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]\\>",
"type": "Promise&#60;[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of currencies.",
@@ -269,7 +269,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"children": [
{
"name": "CurrencyDTO[]",
"type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]",
"type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",

16
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listMoneyAmounts.mdx
View File

@@ -122,7 +122,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)",
"type": "[FilterableMoneyAmountProps](../../interfaces/FilterableMoneyAmountProps.mdx)",
"description": "The filtes to apply on the retrieved money amounts.",
"optional": true,
"defaultValue": "",
@@ -130,7 +130,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"children": [
{
"name": "$and",
"type": "([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterableMoneyAmountProps](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](../../interfaces/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": "",
@@ -139,7 +139,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
},
{
"name": "$or",
"type": "([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterableMoneyAmountProps](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](../../interfaces/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": "",
@@ -168,7 +168,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)&#62;",
"description": "The configurations determining how the money amounts are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a money amount.",
"optional": true,
"defaultValue": "",
@@ -242,7 +242,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -302,7 +302,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]\\>",
"type": "Promise&#60;[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of money amounts.",
@@ -310,7 +310,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"children": [
{
"name": "MoneyAmountDTO[]",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -327,7 +327,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
},
{
"name": "currency",
"type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)",
"type": "[CurrencyDTO](../../interfaces/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": "",

18
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceRules.mdx
View File

@@ -111,7 +111,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx)",
"type": "[FilterablePriceRuleProps](../../interfaces/FilterablePriceRuleProps.mdx)",
"description": "The filters to apply on the retrieved price rules.",
"optional": true,
"defaultValue": "",
@@ -119,7 +119,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"children": [
{
"name": "$and",
"type": "([`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx)\\>)[]",
"type": "([FilterablePriceRuleProps](../../interfaces/FilterablePriceRuleProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceRuleProps](../../interfaces/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": "",
@@ -128,7 +128,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
},
{
"name": "$or",
"type": "([`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx)\\>)[]",
"type": "([FilterablePriceRuleProps](../../interfaces/FilterablePriceRuleProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceRuleProps](../../interfaces/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": "",
@@ -175,7 +175,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)&#62;",
"description": "The configurations determining how the price rule is retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a price rule.",
"optional": true,
"defaultValue": "",
@@ -249,7 +249,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -309,7 +309,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]\\>",
"type": "Promise&#60;[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of price rules.",
@@ -317,7 +317,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"children": [
{
"name": "PriceRuleDTO[]",
"type": "[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -343,7 +343,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)",
"type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)",
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
@@ -379,7 +379,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",

18
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmountRules.mdx
View File

@@ -111,7 +111,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx)",
"type": "[FilterablePriceSetMoneyAmountRulesProps](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx)",
"description": "The filters to apply on the retrieved price set money amount rules.",
"optional": true,
"defaultValue": "",
@@ -119,7 +119,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"children": [
{
"name": "$and",
"type": "([`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountRulesProps](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountRulesProps](../../interfaces/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": "",
@@ -128,7 +128,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
},
{
"name": "$or",
"type": "([`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountRulesProps](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountRulesProps](../../interfaces/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": "",
@@ -175,7 +175,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[PriceSetMoneyAmountRulesDTO](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)&#62;",
"description": "The configurations determining how the price set money amount rules are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a price set money amount rule.",
"optional": true,
"defaultValue": "",
@@ -249,7 +249,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -309,7 +309,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]\\>",
"type": "Promise&#60;[PriceSetMoneyAmountRulesDTO](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of price set money amount rules.",
@@ -317,7 +317,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"children": [
{
"name": "PriceSetMoneyAmountRulesDTO[]",
"type": "[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]",
"type": "[PriceSetMoneyAmountRulesDTO](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -334,7 +334,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
},
{
"name": "price_set_money_amount",
"type": "[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](../../interfaces/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": "",
@@ -343,7 +343,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",

20
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmounts.mdx
View File

@@ -111,7 +111,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx)",
"type": "[FilterablePriceSetMoneyAmountProps](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx)",
"description": "The filters to apply on the retrieved price set money amounts.",
"optional": true,
"defaultValue": "",
@@ -119,7 +119,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"children": [
{
"name": "$and",
"type": "([`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountProps](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountProps](../../interfaces/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": "",
@@ -128,7 +128,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
},
{
"name": "$or",
"type": "([`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
"type": "([FilterablePriceSetMoneyAmountProps](../../interfaces/FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountProps](../../interfaces/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": "",
@@ -157,7 +157,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)&#62;",
"description": "The configurations determining how the price set money amounts are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a price set money amount.",
"optional": true,
"defaultValue": "",
@@ -231,7 +231,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -291,7 +291,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)[]\\>",
"type": "Promise&#60;[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of price set money amounts.",
@@ -299,7 +299,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"children": [
{
"name": "PriceSetMoneyAmountDTO[]",
"type": "[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)[]",
"type": "[PriceSetMoneyAmountDTO](../../interfaces/PriceSetMoneyAmountDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -316,7 +316,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
},
{
"name": "money_amount",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)",
"type": "[MoneyAmountDTO](../../interfaces/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": "",
@@ -325,7 +325,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
},
{
"name": "price_rules",
"type": "[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -334,7 +334,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)",
"type": "[PriceSetDTO](../../interfaces/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": "",

16
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listRuleTypes.mdx
View File

@@ -117,7 +117,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
<ParameterTypes parameters={[
{
"name": "filters",
"type": "[`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx)",
"type": "[FilterableRuleTypeProps](../../interfaces/FilterableRuleTypeProps.mdx)",
"description": "The filters to apply on the retrieved rule types.",
"optional": true,
"defaultValue": "",
@@ -125,7 +125,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"children": [
{
"name": "$and",
"type": "([`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx)\\>)[]",
"type": "([FilterableRuleTypeProps](../../interfaces/FilterableRuleTypeProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableRuleTypeProps](../../interfaces/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": "",
@@ -134,7 +134,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
},
{
"name": "$or",
"type": "([`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx)\\>)[]",
"type": "([FilterableRuleTypeProps](../../interfaces/FilterableRuleTypeProps.mdx) \\| [BaseFilterable](../../interfaces/BaseFilterable.mdx)&#60;[FilterableRuleTypeProps](../../interfaces/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": "",
@@ -172,7 +172,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)&#62;",
"description": "The configurations determining how the rule types are retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a rule type.",
"optional": true,
"defaultValue": "",
@@ -246,7 +246,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -306,7 +306,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]\\>",
"type": "Promise&#60;[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of rule types.",
@@ -314,7 +314,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"children": [
{
"name": "RuleTypeDTO[]",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -350,7 +350,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
{
"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,

6
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.removeRules.mdx
View File

@@ -39,7 +39,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) {
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`RemovePriceSetRulesDTO`](../../interfaces/RemovePriceSetRulesDTO.mdx)[]",
"type": "[RemovePriceSetRulesDTO](../../interfaces/RemovePriceSetRulesDTO.mdx)[]",
"description": "The rules to remove per price set.",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -127,7 +127,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves when rules are successfully removed.",

14
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieve.mdx
View File

@@ -70,7 +70,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)&#62;",
"description": "The configurations determining how the price set is retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a price set.",
"optional": true,
"defaultValue": "",
@@ -144,7 +144,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -204,7 +204,7 @@ async function retrievePriceSet (priceSetId: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)\\>",
"type": "Promise&#60;[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "The retrieved price set.",
@@ -221,7 +221,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -238,7 +238,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "currency",
"type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)",
"type": "[CurrencyDTO](../../interfaces/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": "",
@@ -285,7 +285,7 @@ async function retrievePriceSet (priceSetId: string) {
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -321,7 +321,7 @@ async function retrievePriceSet (priceSetId: string) {
{
"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,

6
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveCurrency.mdx
View File

@@ -70,7 +70,7 @@ async function retrieveCurrency (code: string) {
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)&#62;",
"description": "The configurations determining how the currency is retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a currency.",
"optional": true,
"defaultValue": "",
@@ -144,7 +144,7 @@ async function retrieveCurrency (code: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -204,7 +204,7 @@ async function retrieveCurrency (code: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)\\>",
"type": "Promise&#60;[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "The retrieved currency.",

8
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveMoneyAmount.mdx
View File

@@ -70,7 +70,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)&#62;",
"description": "The configurations determining how a money amount is retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a money amount.",
"optional": true,
"defaultValue": "",
@@ -144,7 +144,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -204,7 +204,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)\\>",
"type": "Promise&#60;[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "The retrieved money amount.",
@@ -221,7 +221,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
},
{
"name": "currency",
"type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)",
"type": "[CurrencyDTO](../../interfaces/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": "",

16
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceRule.mdx
View File

@@ -65,7 +65,7 @@ async function retrievePriceRule (id: string) {
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)&#62;",
"description": "The configurations determining how the price rule is retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a price rule.",
"optional": true,
"defaultValue": "",
@@ -139,7 +139,7 @@ async function retrievePriceRule (id: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -199,7 +199,7 @@ async function retrievePriceRule (id: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)\\>",
"type": "Promise&#60;[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "The retrieved price rule.",
@@ -225,7 +225,7 @@ async function retrievePriceRule (id: string) {
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)",
"type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)",
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
@@ -242,7 +242,7 @@ async function retrievePriceRule (id: string) {
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -251,7 +251,7 @@ async function retrievePriceRule (id: string) {
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -289,7 +289,7 @@ async function retrievePriceRule (id: string) {
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
@@ -325,7 +325,7 @@ async function retrievePriceRule (id: string) {
{
"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,

18
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx
View File

@@ -65,7 +65,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[PriceSetMoneyAmountRulesDTO](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)&#62;",
"description": "The configurations determining how the price set money amount rule is retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a price set money amount rule.",
"optional": true,
"defaultValue": "",
@@ -139,7 +139,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -199,7 +199,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)\\>",
"type": "Promise&#60;[PriceSetMoneyAmountRulesDTO](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "The retrieved price set money amount rule.",
@@ -216,7 +216,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
},
{
"name": "price_set_money_amount",
"type": "[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](../../interfaces/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": "",
@@ -233,7 +233,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
},
{
"name": "money_amount",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)",
"type": "[MoneyAmountDTO](../../interfaces/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": "",
@@ -242,7 +242,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
},
{
"name": "price_rules",
"type": "[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -251,7 +251,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)",
"type": "[PriceSetDTO](../../interfaces/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": "",
@@ -280,7 +280,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
@@ -316,7 +316,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
{
"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,

8
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveRuleType.mdx
View File

@@ -65,7 +65,7 @@ async function retrieveRuleType (ruleTypeId: string) {
},
{
"name": "config",
"type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)\\>",
"type": "[FindConfig](../../interfaces/FindConfig.mdx)&#60;[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)&#62;",
"description": "The configurations determining how the rule type is retrieved. Its properties, such as `select` or `relations`, accept the attributes or relations associated with a rule type.",
"optional": true,
"defaultValue": "",
@@ -139,7 +139,7 @@ async function retrieveRuleType (ruleTypeId: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -199,7 +199,7 @@ async function retrieveRuleType (ruleTypeId: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)\\>",
"type": "Promise&#60;[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "The retrieved rule type.",
@@ -235,7 +235,7 @@ async function retrieveRuleType (ruleTypeId: string) {
{
"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,

8
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateCurrencies.mdx
View File

@@ -39,7 +39,7 @@ async function updateCurrencies() {
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`UpdateCurrencyDTO`](../../interfaces/UpdateCurrencyDTO.mdx)[]",
"type": "[UpdateCurrencyDTO](../../interfaces/UpdateCurrencyDTO.mdx)[]",
"description": "The currencies to update, each having the attributes that should be updated in a currency.",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ async function updateCurrencies() {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -145,7 +145,7 @@ async function updateCurrencies() {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]\\>",
"type": "Promise&#60;[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of updated currencies.",
@@ -153,7 +153,7 @@ async function updateCurrencies() {
"children": [
{
"name": "CurrencyDTO[]",
"type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]",
"type": "[CurrencyDTO](../../interfaces/CurrencyDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",

10
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateMoneyAmounts.mdx
View File

@@ -41,7 +41,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`UpdateMoneyAmountDTO`](../../interfaces/UpdateMoneyAmountDTO.mdx)[]",
"type": "[UpdateMoneyAmountDTO](../../interfaces/UpdateMoneyAmountDTO.mdx)[]",
"description": "The money amounts to update, each having the attributes that should be updated in a money amount.",
"optional": false,
"defaultValue": "",
@@ -96,7 +96,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -156,7 +156,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]\\>",
"type": "Promise&#60;[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of updated money amounts.",
@@ -164,7 +164,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"children": [
{
"name": "MoneyAmountDTO[]",
"type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](../../interfaces/MoneyAmountDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -181,7 +181,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
},
{
"name": "currency",
"type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)",
"type": "[CurrencyDTO](../../interfaces/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": "",

12
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceRules.mdx
View File

@@ -44,7 +44,7 @@ async function updatePriceRules (
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`UpdatePriceRuleDTO`](../../interfaces/UpdatePriceRuleDTO.mdx)[]",
"type": "[UpdatePriceRuleDTO](../../interfaces/UpdatePriceRuleDTO.mdx)[]",
"description": "The price rules to update, each having attributes that should be updated in a price rule.",
"optional": false,
"defaultValue": "",
@@ -117,7 +117,7 @@ async function updatePriceRules (
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -177,7 +177,7 @@ async function updatePriceRules (
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]\\>",
"type": "Promise&#60;[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of updated price rules.",
@@ -185,7 +185,7 @@ async function updatePriceRules (
"children": [
{
"name": "PriceRuleDTO[]",
"type": "[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](../../interfaces/PriceRuleDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -211,7 +211,7 @@ async function updatePriceRules (
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)",
"type": "[PriceSetDTO](../../interfaces/PriceSetDTO.mdx)",
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
@@ -247,7 +247,7 @@ async function updatePriceRules (
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",

12
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceSetMoneyAmountRules.mdx
View File

@@ -41,7 +41,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`UpdatePriceSetMoneyAmountRulesDTO`](../../interfaces/UpdatePriceSetMoneyAmountRulesDTO.mdx)[]",
"type": "[UpdatePriceSetMoneyAmountRulesDTO](../../interfaces/UpdatePriceSetMoneyAmountRulesDTO.mdx)[]",
"description": "The price set money amounts to update, each having the attributes to update in a price set money amount.",
"optional": false,
"defaultValue": "",
@@ -87,7 +87,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -147,7 +147,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]\\>",
"type": "Promise&#60;[PriceSetMoneyAmountRulesDTO](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of updated price set money amount rules.",
@@ -155,7 +155,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"children": [
{
"name": "PriceSetMoneyAmountRulesDTO[]",
"type": "[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]",
"type": "[PriceSetMoneyAmountRulesDTO](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -172,7 +172,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
},
{
"name": "price_set_money_amount",
"type": "[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](../../interfaces/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": "",
@@ -181,7 +181,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",

12
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateRuleTypes.mdx
View File

@@ -41,7 +41,7 @@ async function updateRuleTypes (ruleTypeId: string) {
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`UpdateRuleTypeDTO`](../../interfaces/UpdateRuleTypeDTO.mdx)[]",
"type": "[UpdateRuleTypeDTO](../../interfaces/UpdateRuleTypeDTO.mdx)[]",
"description": "The rule types to update, each having the attributes that should be updated in a rule type.",
"optional": false,
"defaultValue": "",
@@ -77,7 +77,7 @@ async function updateRuleTypes (ruleTypeId: string) {
{
"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,
@@ -87,7 +87,7 @@ async function updateRuleTypes (ruleTypeId: string) {
},
{
"name": "sharedContext",
"type": "[`Context`](../../interfaces/Context.mdx)",
"type": "[Context](../../interfaces/Context.mdx)",
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
@@ -147,7 +147,7 @@ async function updateRuleTypes (ruleTypeId: string) {
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]\\>",
"type": "Promise&#60;[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "The list of updated rule types.",
@@ -155,7 +155,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"children": [
{
"name": "RuleTypeDTO[]",
"type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](../../interfaces/RuleTypeDTO.mdx)[]",
"optional": false,
"defaultValue": "",
"description": "",
@@ -191,7 +191,7 @@ async function updateRuleTypes (ruleTypeId: string) {
{
"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,