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

chore(docs): Generated References (#5602)

Browse Source 
Generated the following references:
- `pricing`
- `product`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-10 17:31:02 +00:00
committed by GitHub
co-authored by Oli Juhl Shahed Nasser
parent 5f4317b9d7
commit 39649b3552
2110 changed files with 148777 additions and 4448445 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPrices.mdx
+51
View File
@@ -97,6 +97,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The data defining the price set to add the prices to, along with the prices to add.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "priceSetId",
@@ -104,6 +105,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The ID of the price set to add prices to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -112,6 +114,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The prices to add to the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -119,6 +122,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The amount of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -127,6 +131,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -135,6 +140,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The currency code of this money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -143,6 +149,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The ID of the money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -151,6 +158,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -159,6 +167,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -167,6 +176,7 @@ async function addPricesToPriceSet (priceSetId: 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": "",
"expandable": false,
"children": []
}
]
@@ -179,6 +189,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -186,6 +197,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -194,6 +206,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -202,6 +215,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -210,6 +224,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -218,6 +233,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -233,6 +249,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"optional": false,
"defaultValue": "",
"description": "The price set that the prices were added to.",
"expandable": false,
"children": [
{
"name": "id",
@@ -240,6 +257,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -248,6 +266,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -255,6 +274,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -263,6 +283,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"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": "",
"expandable": false,
"children": []
},
{
@@ -271,6 +292,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -279,6 +301,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -287,6 +310,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -295,6 +319,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -305,6 +330,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -312,6 +338,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -320,6 +347,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -328,6 +356,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -336,6 +365,7 @@ async function addPricesToPriceSet (priceSetId: 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.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -428,6 +458,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The data defining the prices to add per price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "priceSetId",
@@ -435,6 +466,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The ID of the price set to add prices to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -443,6 +475,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The prices to add to the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -450,6 +483,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The amount of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -458,6 +492,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -466,6 +501,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The currency code of this money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -474,6 +510,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The ID of the money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -482,6 +519,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -490,6 +528,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -498,6 +537,7 @@ async function addPricesToPriceSet (priceSetId: 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": "",
"expandable": false,
"children": []
}
]
@@ -510,6 +550,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -517,6 +558,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -525,6 +567,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -533,6 +576,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -541,6 +585,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -549,6 +594,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -564,6 +610,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"optional": false,
"defaultValue": "",
"description": "The list of the price sets that prices were added to.",
"expandable": false,
"children": [
{
"name": "PriceSetDTO[]",
@@ -571,6 +618,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -578,6 +626,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -586,6 +635,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -594,6 +644,7 @@ async function addPricesToPriceSet (priceSetId: string) {
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addRules.mdx
+59 -2
View File
@@ -47,6 +47,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The data defining the price set to add the rules to, along with the rules to add.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "priceSetId",
@@ -54,6 +55,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The ID of the price set to add the rules to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -62,7 +64,18 @@ async function addRulesToPriceSet (priceSetId: string) {
"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": "",
"children": []
"expandable": false,
"children": [
{
"name": "attribute",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
},
@@ -72,6 +85,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -79,6 +93,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -87,6 +102,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -95,6 +111,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -103,6 +120,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -111,6 +129,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -126,6 +145,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"optional": false,
"defaultValue": "",
"description": "The price set that the rules were added to.",
"expandable": false,
"children": [
{
"name": "id",
@@ -133,6 +153,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -141,6 +162,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -148,6 +170,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -156,6 +179,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"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": "",
"expandable": false,
"children": []
},
{
@@ -164,6 +188,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -172,6 +197,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -180,6 +206,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -188,6 +215,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -198,6 +226,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -205,6 +234,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -213,6 +243,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -221,6 +252,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -229,6 +261,7 @@ async function addRulesToPriceSet (priceSetId: 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.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -271,6 +304,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The data defining the rules to add per price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "priceSetId",
@@ -278,6 +312,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The ID of the price set to add the rules to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -286,7 +321,18 @@ async function addRulesToPriceSet (priceSetId: string) {
"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": "",
"children": []
"expandable": false,
"children": [
{
"name": "attribute",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
},
@@ -296,6 +342,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -303,6 +350,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -311,6 +359,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -319,6 +368,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -327,6 +377,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -335,6 +386,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -350,6 +402,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"optional": false,
"defaultValue": "",
"description": "The list of the price sets that the rules were added to.",
"expandable": false,
"children": [
{
"name": "PriceSetDTO[]",
@@ -357,6 +410,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -364,6 +418,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -372,6 +427,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -380,6 +436,7 @@ async function addRulesToPriceSet (priceSetId: string) {
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.calculatePrices.mdx
+16
View File
@@ -94,6 +94,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"description": "The filters to apply on prices.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -101,6 +102,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"description": "IDs to filter prices.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -111,6 +113,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"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": "",
"expandable": false,
"children": [
{
"name": "context",
@@ -118,6 +121,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"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": "",
"expandable": false,
"children": []
}
]
@@ -128,6 +132,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -135,6 +140,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -143,6 +149,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -151,6 +158,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -159,6 +167,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -167,6 +176,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -182,6 +192,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"optional": false,
"defaultValue": "",
"description": "The calculated price matching the context and filters provided.",
"expandable": false,
"children": [
{
"name": "amount",
@@ -189,6 +200,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"description": "The calculated amount. It can possibly be `null` if there's no price set up for the provided context.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -197,6 +209,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"description": "The currency code of the calculated price. It can possibly be `null`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -205,6 +218,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -213,6 +227,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"description": "The maximum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -221,6 +236,7 @@ async function calculatePrice (priceSetId: string, currencyCode: string) {
"description": "The minimum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.create.mdx
+129 -70
View File
@@ -22,34 +22,30 @@ This method is used to create a new price set.
To create a default price set, don't pass any rules. For example:
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
import { initialize as initializePricingModule } from "@medusajs/pricing"
async function createPriceSet () {
async function createPriceSet() {
const pricingService = await initializePricingModule()
const priceSet = await pricingService.create(
{
rules: [],
prices: [
{
amount: 500,
currency_code: "USD",
min_quantity: 0,
max_quantity: 4,
rules: {},
},
{
amount: 400,
currency_code: "USD",
min_quantity: 5,
max_quantity: 10,
rules: {},
},
],
},
)
const priceSet = await pricingService.create({
rules: [],
prices: [
{
amount: 500,
currency_code: "USD",
min_quantity: 0,
max_quantity: 4,
rules: {},
},
{
amount: 400,
currency_code: "USD",
min_quantity: 5,
max_quantity: 10,
rules: {},
},
],
})
// do something with the price set or return it
}
@@ -58,42 +54,38 @@ async function createPriceSet () {
To create a price set and associate it with rule types:
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
import { initialize as initializePricingModule } from "@medusajs/pricing"
async function createPriceSet () {
async function createPriceSet() {
const pricingService = await initializePricingModule()
const priceSet = await pricingService.create(
{
rules: [{ rule_attribute: "region_id" }, { rule_attribute: "city" }],
prices: [
{
amount: 300,
currency_code: "EUR",
rules: {
region_id: "PL",
city: "krakow"
},
const priceSet = await pricingService.create({
rules: [{ rule_attribute: "region_id" }, { rule_attribute: "city" }],
prices: [
{
amount: 300,
currency_code: "EUR",
rules: {
region_id: "PL",
city: "krakow",
},
{
amount: 400,
currency_code: "EUR",
rules: {
region_id: "PL"
},
},
{
amount: 400,
currency_code: "EUR",
rules: {
region_id: "PL",
},
{
amount: 450,
currency_code: "EUR",
rules: {
city: "krakow"
},
}
],
},
)
},
{
amount: 450,
currency_code: "EUR",
rules: {
city: "krakow",
},
},
],
})
// do something with the price set or return it
}
@@ -108,6 +100,7 @@ async function createPriceSet () {
"description": "The attributes of the price set to create.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "prices",
@@ -115,6 +108,7 @@ async function createPriceSet () {
"description": "The prices to create and add to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -122,6 +116,7 @@ async function createPriceSet () {
"description": "The amount of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -130,6 +125,7 @@ async function createPriceSet () {
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -138,6 +134,7 @@ async function createPriceSet () {
"description": "The currency code of this money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -146,6 +143,7 @@ async function createPriceSet () {
"description": "The ID of the money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -154,6 +152,7 @@ async function createPriceSet () {
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -162,6 +161,7 @@ async function createPriceSet () {
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -170,6 +170,7 @@ async function createPriceSet () {
"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": "",
"expandable": false,
"children": []
}
]
@@ -180,7 +181,18 @@ async function createPriceSet () {
"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": "",
"children": []
"expandable": false,
"children": [
{
"name": "rule_attribute",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
},
@@ -190,6 +202,7 @@ async function createPriceSet () {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -197,6 +210,7 @@ async function createPriceSet () {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -205,6 +219,7 @@ async function createPriceSet () {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -213,6 +228,7 @@ async function createPriceSet () {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -221,6 +237,7 @@ async function createPriceSet () {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -229,6 +246,7 @@ async function createPriceSet () {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -244,6 +262,7 @@ async function createPriceSet () {
"optional": false,
"defaultValue": "",
"description": "The created price set.",
"expandable": false,
"children": [
{
"name": "id",
@@ -251,6 +270,7 @@ async function createPriceSet () {
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -259,6 +279,7 @@ async function createPriceSet () {
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -266,6 +287,7 @@ async function createPriceSet () {
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -274,6 +296,7 @@ async function createPriceSet () {
"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": "",
"expandable": false,
"children": []
},
{
@@ -282,6 +305,7 @@ async function createPriceSet () {
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -290,6 +314,7 @@ async function createPriceSet () {
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -298,6 +323,7 @@ async function createPriceSet () {
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -306,6 +332,7 @@ async function createPriceSet () {
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -316,6 +343,7 @@ async function createPriceSet () {
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -323,6 +351,7 @@ async function createPriceSet () {
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -331,6 +360,7 @@ async function createPriceSet () {
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -339,6 +369,7 @@ async function createPriceSet () {
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -347,6 +378,7 @@ async function createPriceSet () {
"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,
"children": []
}
]
@@ -364,11 +396,9 @@ This method is used to create multiple price sets.
To create price sets with a default price, don't pass any rules and make sure to pass the `currency_code` of the price. For example:
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
import { initialize as initializePricingModule } from "@medusajs/pricing"
async function createPriceSets () {
async function createPriceSets() {
const pricingService = await initializePricingModule()
const priceSets = await pricingService.create([
@@ -391,11 +421,9 @@ async function createPriceSets () {
To create price sets and associate them with rule types:
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
import { initialize as initializePricingModule } from "@medusajs/pricing"
async function createPriceSets () {
async function createPriceSets() {
const pricingService = await initializePricingModule()
const priceSets = await pricingService.create([
@@ -407,7 +435,7 @@ async function createPriceSets () {
currency_code: "EUR",
rules: {
region_id: "PL",
city: "krakow"
city: "krakow",
},
},
{
@@ -416,16 +444,16 @@ async function createPriceSets () {
min_quantity: 0,
max_quantity: 4,
rules: {
region_id: "PL"
region_id: "PL",
},
},
{
amount: 450,
currency_code: "EUR",
rules: {
city: "krakow"
city: "krakow",
},
}
},
],
},
])
@@ -443,6 +471,7 @@ async function createPriceSets () {
"description": "The price sets to create.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "prices",
@@ -450,6 +479,7 @@ async function createPriceSets () {
"description": "The prices to create and add to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -457,6 +487,7 @@ async function createPriceSets () {
"description": "The amount of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -465,6 +496,7 @@ async function createPriceSets () {
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -473,6 +505,7 @@ async function createPriceSets () {
"description": "The currency code of this money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -481,6 +514,7 @@ async function createPriceSets () {
"description": "The ID of the money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -489,6 +523,7 @@ async function createPriceSets () {
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -497,6 +532,7 @@ async function createPriceSets () {
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -505,6 +541,7 @@ async function createPriceSets () {
"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": "",
"expandable": false,
"children": []
}
]
@@ -515,7 +552,18 @@ async function createPriceSets () {
"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": "",
"children": []
"expandable": false,
"children": [
{
"name": "rule_attribute",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
},
@@ -525,6 +573,7 @@ async function createPriceSets () {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -532,6 +581,7 @@ async function createPriceSets () {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -540,6 +590,7 @@ async function createPriceSets () {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -548,6 +599,7 @@ async function createPriceSets () {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -556,6 +608,7 @@ async function createPriceSets () {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -564,6 +617,7 @@ async function createPriceSets () {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -579,6 +633,7 @@ async function createPriceSets () {
"optional": false,
"defaultValue": "",
"description": "The list of created price sets.",
"expandable": false,
"children": [
{
"name": "PriceSetDTO[]",
@@ -586,6 +641,7 @@ async function createPriceSets () {
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -593,6 +649,7 @@ async function createPriceSets () {
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -601,6 +658,7 @@ async function createPriceSets () {
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -609,6 +667,7 @@ async function createPriceSets () {
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createCurrencies.mdx
+20 -5
View File
@@ -18,11 +18,9 @@ This method is used to create new currencies.
## Example
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
import { initialize as initializePricingModule } from "@medusajs/pricing"
async function createCurrencies () {
async function createCurrencies() {
const pricingService = await initializePricingModule()
const currencies = await pricingService.createCurrencies([
@@ -31,7 +29,7 @@ async function createCurrencies () {
symbol: "$",
symbol_native: "$",
name: "US Dollar",
}
},
])
// do something with the currencies or return them
@@ -47,6 +45,7 @@ async function createCurrencies () {
"description": "The currencies to create.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "code",
@@ -54,6 +53,7 @@ async function createCurrencies () {
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -62,6 +62,7 @@ async function createCurrencies () {
"description": "The name of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -70,6 +71,7 @@ async function createCurrencies () {
"description": "The symbol of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -78,6 +80,7 @@ async function createCurrencies () {
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -88,6 +91,7 @@ async function createCurrencies () {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -95,6 +99,7 @@ async function createCurrencies () {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -103,6 +108,7 @@ async function createCurrencies () {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -111,6 +117,7 @@ async function createCurrencies () {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -119,6 +126,7 @@ async function createCurrencies () {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -127,6 +135,7 @@ async function createCurrencies () {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -142,6 +151,7 @@ async function createCurrencies () {
"optional": false,
"defaultValue": "",
"description": "The list of created currencies.",
"expandable": false,
"children": [
{
"name": "CurrencyDTO[]",
@@ -149,6 +159,7 @@ async function createCurrencies () {
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "code",
@@ -156,6 +167,7 @@ async function createCurrencies () {
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -164,6 +176,7 @@ async function createCurrencies () {
"description": "The name of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -172,6 +185,7 @@ async function createCurrencies () {
"description": "The symbol of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -180,6 +194,7 @@ async function createCurrencies () {
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createMoneyAmounts.mdx
+29 -6
View File
@@ -18,11 +18,9 @@ This method creates money amounts.
## Example
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
import { initialize as initializePricingModule } from "@medusajs/pricing"
async function retrieveMoneyAmounts () {
async function retrieveMoneyAmounts() {
const pricingService = await initializePricingModule()
const moneyAmounts = await pricingService.createMoneyAmounts([
@@ -34,8 +32,8 @@ async function retrieveMoneyAmounts () {
amount: 400,
currency_code: "USD",
min_quantity: 0,
max_quantity: 4
}
max_quantity: 4,
},
])
// do something with the money amounts or return them
@@ -51,6 +49,7 @@ async function retrieveMoneyAmounts () {
"description": "The money amounts to create.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -58,6 +57,7 @@ async function retrieveMoneyAmounts () {
"description": "The amount of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -66,6 +66,7 @@ async function retrieveMoneyAmounts () {
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "code",
@@ -73,6 +74,7 @@ async function retrieveMoneyAmounts () {
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -81,6 +83,7 @@ async function retrieveMoneyAmounts () {
"description": "The name of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -89,6 +92,7 @@ async function retrieveMoneyAmounts () {
"description": "The symbol of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -97,6 +101,7 @@ async function retrieveMoneyAmounts () {
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -107,6 +112,7 @@ async function retrieveMoneyAmounts () {
"description": "The currency code of this money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -115,6 +121,7 @@ async function retrieveMoneyAmounts () {
"description": "The ID of the money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -123,6 +130,7 @@ async function retrieveMoneyAmounts () {
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -131,6 +139,7 @@ async function retrieveMoneyAmounts () {
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -141,6 +150,7 @@ async function retrieveMoneyAmounts () {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -148,6 +158,7 @@ async function retrieveMoneyAmounts () {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -156,6 +167,7 @@ async function retrieveMoneyAmounts () {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -164,6 +176,7 @@ async function retrieveMoneyAmounts () {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -172,6 +185,7 @@ async function retrieveMoneyAmounts () {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -180,6 +194,7 @@ async function retrieveMoneyAmounts () {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -195,6 +210,7 @@ async function retrieveMoneyAmounts () {
"optional": false,
"defaultValue": "",
"description": "The list of created money amounts.",
"expandable": false,
"children": [
{
"name": "MoneyAmountDTO[]",
@@ -202,6 +218,7 @@ async function retrieveMoneyAmounts () {
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -209,6 +226,7 @@ async function retrieveMoneyAmounts () {
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -217,6 +235,7 @@ async function retrieveMoneyAmounts () {
"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": "",
"expandable": false,
"children": []
},
{
@@ -225,6 +244,7 @@ async function retrieveMoneyAmounts () {
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -233,6 +253,7 @@ async function retrieveMoneyAmounts () {
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -241,6 +262,7 @@ async function retrieveMoneyAmounts () {
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -249,6 +271,7 @@ async function retrieveMoneyAmounts () {
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceRules.mdx
+25
View File
@@ -56,6 +56,7 @@ async function createPriceRules (
"description": "The price rules to create.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -63,6 +64,7 @@ async function createPriceRules (
"description": "The ID of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -71,6 +73,7 @@ async function createPriceRules (
"description": "The ID of the associated price list.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -79,6 +82,7 @@ async function createPriceRules (
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -87,6 +91,7 @@ async function createPriceRules (
"description": "The ID of the associated price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -95,6 +100,7 @@ async function createPriceRules (
"description": "The priority of the price rule in comparison to other applicable price rules.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -103,6 +109,7 @@ async function createPriceRules (
"description": "The ID of the associated rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -111,6 +118,7 @@ async function createPriceRules (
"description": "The value of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -121,6 +129,7 @@ async function createPriceRules (
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -128,6 +137,7 @@ async function createPriceRules (
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -136,6 +146,7 @@ async function createPriceRules (
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -144,6 +155,7 @@ async function createPriceRules (
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -152,6 +164,7 @@ async function createPriceRules (
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -160,6 +173,7 @@ async function createPriceRules (
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -175,6 +189,7 @@ async function createPriceRules (
"optional": false,
"defaultValue": "",
"description": "The list of created price rules.",
"expandable": false,
"children": [
{
"name": "PriceRuleDTO[]",
@@ -182,6 +197,7 @@ async function createPriceRules (
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -189,6 +205,7 @@ async function createPriceRules (
"description": "The ID of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -197,6 +214,7 @@ async function createPriceRules (
"description": "The ID of the associated price list.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -205,6 +223,7 @@ async function createPriceRules (
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -213,6 +232,7 @@ async function createPriceRules (
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -221,6 +241,7 @@ async function createPriceRules (
"description": "The ID of the associated price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -229,6 +250,7 @@ async function createPriceRules (
"description": "The priority of the price rule in comparison to other applicable price rules.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -237,6 +259,7 @@ async function createPriceRules (
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -245,6 +268,7 @@ async function createPriceRules (
"description": "The ID of the associated rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -253,6 +277,7 @@ async function createPriceRules (
"description": "The value of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceSetMoneyAmountRules.mdx
+16
View File
@@ -47,6 +47,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"description": "The price set money amount rules to create.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "price_set_money_amount",
@@ -54,6 +55,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"description": "The ID of a price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -62,6 +64,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"description": "The ID of a rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -70,6 +73,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"description": "The value of the price set money amount rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -80,6 +84,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -87,6 +92,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -95,6 +101,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -103,6 +110,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -111,6 +119,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -119,6 +128,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -134,6 +144,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"optional": false,
"defaultValue": "",
"description": "The list of created price set money amount rules.",
"expandable": false,
"children": [
{
"name": "PriceSetMoneyAmountRulesDTO[]",
@@ -141,6 +152,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -148,6 +160,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"description": "The ID of the price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -156,6 +169,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -164,6 +178,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -172,6 +187,7 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru
"description": "The value of the price set money amount rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createRuleTypes.mdx
+21 -6
View File
@@ -18,18 +18,16 @@ This method is used to create new rule types.
## Example
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
import { initialize as initializePricingModule } from "@medusajs/pricing"
async function createRuleTypes () {
async function createRuleTypes() {
const pricingService = await initializePricingModule()
const ruleTypes = await pricingService.createRuleTypes([
{
name: "Region",
rule_attribute: "region_id"
}
rule_attribute: "region_id",
},
])
// do something with the rule types or return them
@@ -45,6 +43,7 @@ async function createRuleTypes () {
"description": "The rule types to create.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -52,6 +51,7 @@ async function createRuleTypes () {
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -60,6 +60,7 @@ async function createRuleTypes () {
"description": "The ID of the rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -68,6 +69,7 @@ async function createRuleTypes () {
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -76,6 +78,7 @@ async function createRuleTypes () {
"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,
"children": []
}
]
@@ -86,6 +89,7 @@ async function createRuleTypes () {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -93,6 +97,7 @@ async function createRuleTypes () {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -101,6 +106,7 @@ async function createRuleTypes () {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -109,6 +115,7 @@ async function createRuleTypes () {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -117,6 +124,7 @@ async function createRuleTypes () {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -125,6 +133,7 @@ async function createRuleTypes () {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -140,6 +149,7 @@ async function createRuleTypes () {
"optional": false,
"defaultValue": "",
"description": "The list of created rule types.",
"expandable": false,
"children": [
{
"name": "RuleTypeDTO[]",
@@ -147,6 +157,7 @@ async function createRuleTypes () {
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -154,6 +165,7 @@ async function createRuleTypes () {
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -162,6 +174,7 @@ async function createRuleTypes () {
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -170,6 +183,7 @@ async function createRuleTypes () {
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -178,6 +192,7 @@ async function createRuleTypes () {
"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,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.delete.mdx
+8
View File
@@ -38,6 +38,7 @@ async function removePriceSetRule (priceSetIds: string[]) {
"description": "The IDs of the price sets to delete.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -46,6 +47,7 @@ async function removePriceSetRule (priceSetIds: string[]) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -53,6 +55,7 @@ async function removePriceSetRule (priceSetIds: string[]) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -61,6 +64,7 @@ async function removePriceSetRule (priceSetIds: string[]) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -69,6 +73,7 @@ async function removePriceSetRule (priceSetIds: string[]) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -77,6 +82,7 @@ async function removePriceSetRule (priceSetIds: string[]) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -85,6 +91,7 @@ async function removePriceSetRule (priceSetIds: string[]) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -100,6 +107,7 @@ async function removePriceSetRule (priceSetIds: string[]) {
"optional": false,
"defaultValue": "",
"description": "Resolves when the price sets are successfully deleted.",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteCurrencies.mdx
+10 -5
View File
@@ -18,15 +18,12 @@ This method is used to delete currencies based on their currency code.
## Example
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
import { initialize as initializePricingModule } from "@medusajs/pricing"
async function deleteCurrencies () {
async function deleteCurrencies() {
const pricingService = await initializePricingModule()
await pricingService.deleteCurrencies(["USD"])
}
```
@@ -39,6 +36,7 @@ async function deleteCurrencies () {
"description": "Currency codes of the currencies to delete.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -47,6 +45,7 @@ async function deleteCurrencies () {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -54,6 +53,7 @@ async function deleteCurrencies () {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -62,6 +62,7 @@ async function deleteCurrencies () {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -70,6 +71,7 @@ async function deleteCurrencies () {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -78,6 +80,7 @@ async function deleteCurrencies () {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -86,6 +89,7 @@ async function deleteCurrencies () {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -101,6 +105,7 @@ async function deleteCurrencies () {
"optional": false,
"defaultValue": "",
"description": "Resolves once the currencies are deleted.",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteMoneyAmounts.mdx
+8
View File
@@ -40,6 +40,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) {
"description": "The IDs of the money amounts to delete.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -48,6 +49,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -55,6 +57,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -63,6 +66,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -71,6 +75,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -79,6 +84,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -87,6 +93,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -102,6 +109,7 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) {
"optional": false,
"defaultValue": "",
"description": "Resolves when the money amounts are successfully deleted.",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceRules.mdx
+8
View File
@@ -40,6 +40,7 @@ async function deletePriceRules (
"description": "The IDs of the price rules to delete.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -48,6 +49,7 @@ async function deletePriceRules (
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -55,6 +57,7 @@ async function deletePriceRules (
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -63,6 +66,7 @@ async function deletePriceRules (
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -71,6 +75,7 @@ async function deletePriceRules (
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -79,6 +84,7 @@ async function deletePriceRules (
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -87,6 +93,7 @@ async function deletePriceRules (
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -102,6 +109,7 @@ async function deletePriceRules (
"optional": false,
"defaultValue": "",
"description": "Resolves once the price rules are deleted.",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceSetMoneyAmountRules.mdx
+8
View File
@@ -38,6 +38,7 @@ async function deletePriceSetMoneyAmountRule (id: string) {
"description": "The IDs of the price set money amount rules to delete.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -46,6 +47,7 @@ async function deletePriceSetMoneyAmountRule (id: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -53,6 +55,7 @@ async function deletePriceSetMoneyAmountRule (id: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -61,6 +64,7 @@ async function deletePriceSetMoneyAmountRule (id: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -69,6 +73,7 @@ async function deletePriceSetMoneyAmountRule (id: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -77,6 +82,7 @@ async function deletePriceSetMoneyAmountRule (id: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -85,6 +91,7 @@ async function deletePriceSetMoneyAmountRule (id: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -100,6 +107,7 @@ async function deletePriceSetMoneyAmountRule (id: string) {
"optional": false,
"defaultValue": "",
"description": "Resolves once the price set money amount rules are deleted.",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteRuleTypes.mdx
+8
View File
@@ -38,6 +38,7 @@ async function deleteRuleTypes (ruleTypeId: string) {
"description": "The IDs of the rule types to delete.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -46,6 +47,7 @@ async function deleteRuleTypes (ruleTypeId: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -53,6 +55,7 @@ async function deleteRuleTypes (ruleTypeId: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -61,6 +64,7 @@ async function deleteRuleTypes (ruleTypeId: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -69,6 +73,7 @@ async function deleteRuleTypes (ruleTypeId: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -77,6 +82,7 @@ async function deleteRuleTypes (ruleTypeId: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -85,6 +91,7 @@ async function deleteRuleTypes (ruleTypeId: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -100,6 +107,7 @@ async function deleteRuleTypes (ruleTypeId: string) {
"optional": false,
"defaultValue": "",
"description": "Resolves once the rule types are deleted.",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.list.mdx
+38 -1
View File
@@ -128,6 +128,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "The filters to apply on the retrieved price lists.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -135,6 +136,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"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": "",
"expandable": false,
"children": []
},
{
@@ -143,6 +145,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"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": "",
"expandable": false,
"children": []
},
{
@@ -151,6 +154,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "IDs to filter price sets by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -159,6 +163,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "Filters to apply on a price set's associated money amounts.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -166,6 +171,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"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": "",
"expandable": false,
"children": []
},
{
@@ -174,6 +180,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"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": "",
"expandable": false,
"children": []
},
{
@@ -182,6 +189,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "Currency codes to filter money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -190,6 +198,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "IDs to filter money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -202,6 +211,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -209,7 +219,18 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -217,6 +238,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -225,6 +247,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -233,6 +256,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -241,6 +265,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -249,6 +274,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -259,6 +285,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -266,6 +293,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -274,6 +302,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -282,6 +311,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -290,6 +320,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -298,6 +329,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -313,6 +345,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"optional": false,
"defaultValue": "",
"description": "The list of price sets.",
"expandable": false,
"children": [
{
"name": "PriceSetDTO[]",
@@ -320,6 +353,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -327,6 +361,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -335,6 +370,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -343,6 +379,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCount.mdx
+36 -1
View File
@@ -128,6 +128,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "The filters to apply on the retrieved price lists.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -135,6 +136,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"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": "",
"expandable": false,
"children": []
},
{
@@ -143,6 +145,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"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": "",
"expandable": false,
"children": []
},
{
@@ -151,6 +154,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "IDs to filter price sets by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -159,6 +163,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "Filters to apply on a price set's associated money amounts.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -166,6 +171,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"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": "",
"expandable": false,
"children": []
},
{
@@ -174,6 +180,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"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": "",
"expandable": false,
"children": []
},
{
@@ -182,6 +189,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "Currency codes to filter money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -190,6 +198,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "IDs to filter money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -202,6 +211,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -209,7 +219,18 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -217,6 +238,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -225,6 +247,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -233,6 +256,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -241,6 +265,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -249,6 +274,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -259,6 +285,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -266,6 +293,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -274,6 +302,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -282,6 +311,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -290,6 +320,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -298,6 +329,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -313,6 +345,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"optional": false,
"defaultValue": "",
"description": "The list of price sets along with their total count.",
"expandable": false,
"children": [
{
"name": "PriceSetDTO[]",
@@ -320,6 +353,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
@@ -328,6 +362,7 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountCurrencies.mdx
+31 -1
View File
@@ -94,6 +94,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "The filters to apply on the retrieved currencies.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -101,6 +102,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"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": "",
"expandable": false,
"children": []
},
{
@@ -109,6 +111,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"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": "",
"expandable": false,
"children": []
},
{
@@ -117,6 +120,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "The codes to filter the currencies by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -127,6 +131,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -134,7 +139,18 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -142,6 +158,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -150,6 +167,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -158,6 +176,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -166,6 +185,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -174,6 +194,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -184,6 +205,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -191,6 +213,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -199,6 +222,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -207,6 +231,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -215,6 +240,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -223,6 +249,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -238,6 +265,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"optional": false,
"defaultValue": "",
"description": "The list of currencies along with the total count.",
"expandable": false,
"children": [
{
"name": "CurrencyDTO[]",
@@ -245,6 +273,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
@@ -253,6 +282,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountMoneyAmounts.mdx
+32 -1
View File
@@ -126,6 +126,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "The filters to apply on the retrieved money amounts.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -133,6 +134,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"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": "",
"expandable": false,
"children": []
},
{
@@ -141,6 +143,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"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": "",
"expandable": false,
"children": []
},
{
@@ -149,6 +152,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "Currency codes to filter money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -157,6 +161,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "IDs to filter money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -167,6 +172,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -174,7 +180,18 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -182,6 +199,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -190,6 +208,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -198,6 +217,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -206,6 +226,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -214,6 +235,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -224,6 +246,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -231,6 +254,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -239,6 +263,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -247,6 +272,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -255,6 +281,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -263,6 +290,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -278,6 +306,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"optional": false,
"defaultValue": "",
"description": "The list of money amounts along with their total count.",
"expandable": false,
"children": [
{
"name": "MoneyAmountDTO[]",
@@ -285,6 +314,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
@@ -293,6 +323,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceRules.mdx
+34 -1
View File
@@ -115,6 +115,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The filters to apply on the retrieved price rules.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -122,6 +123,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"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": "",
"expandable": false,
"children": []
},
{
@@ -130,6 +132,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"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": "",
"expandable": false,
"children": []
},
{
@@ -138,6 +141,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The IDs to filter price rules by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -146,6 +150,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The names to filter price rules by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -154,6 +159,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The IDs to filter the price rule's associated price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -162,6 +168,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The IDs to filter the price rule's associated rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -172,6 +179,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -179,7 +187,18 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -187,6 +206,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -195,6 +215,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -203,6 +224,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -211,6 +233,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -219,6 +242,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -229,6 +253,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -236,6 +261,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -244,6 +270,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -252,6 +279,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -260,6 +288,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -268,6 +297,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -283,6 +313,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"optional": false,
"defaultValue": "",
"description": "The list of price rules along with their total count.",
"expandable": false,
"children": [
{
"name": "PriceRuleDTO[]",
@@ -290,6 +321,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
@@ -298,6 +330,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx
+34 -1
View File
@@ -116,6 +116,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "The filters to apply on the retrieved price set money amount rules.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -123,6 +124,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"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": "",
"expandable": false,
"children": []
},
{
@@ -131,6 +133,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"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": "",
"expandable": false,
"children": []
},
{
@@ -139,6 +142,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "The ID to filter price set money amount rules by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -147,6 +151,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "The IDs to filter the price set money amount rule's associated price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -155,6 +160,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "The IDs to filter the price set money amount rule's associated rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -163,6 +169,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "The value to filter price set money amount rules by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -173,6 +180,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -180,7 +188,18 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -188,6 +207,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -196,6 +216,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -204,6 +225,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -212,6 +234,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -220,6 +243,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -230,6 +254,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -237,6 +262,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -245,6 +271,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -253,6 +280,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -261,6 +289,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -269,6 +298,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -284,6 +314,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"optional": false,
"defaultValue": "",
"description": "The list of price set money amount rules and their total count.",
"expandable": false,
"children": [
{
"name": "PriceSetMoneyAmountRulesDTO[]",
@@ -291,6 +322,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
@@ -299,6 +331,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx
+32 -1
View File
@@ -116,6 +116,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "The filters to apply on the retrieved price set money amounts.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -123,6 +124,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"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": "",
"expandable": false,
"children": []
},
{
@@ -131,6 +133,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"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": "",
"expandable": false,
"children": []
},
{
@@ -139,6 +142,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "The IDs to filter the price set money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -147,6 +151,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "The IDs to filter the price set money amount's associated price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -157,6 +162,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -164,7 +170,18 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -172,6 +189,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -180,6 +198,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -188,6 +207,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -196,6 +216,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -204,6 +225,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -214,6 +236,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -221,6 +244,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -229,6 +253,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -237,6 +262,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -245,6 +271,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -253,6 +280,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -268,6 +296,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"optional": false,
"defaultValue": "",
"description": "The list of price set money amounts and their total count.",
"expandable": false,
"children": [
{
"name": "PriceSetMoneyAmountDTO[]",
@@ -275,6 +304,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
@@ -283,6 +313,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountRuleTypes.mdx
+33 -1
View File
@@ -121,6 +121,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "The filters to apply on the retrieved rule types.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -128,6 +129,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"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": "",
"expandable": false,
"children": []
},
{
@@ -136,6 +138,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"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": "",
"expandable": false,
"children": []
},
{
@@ -144,6 +147,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "The IDs to filter rule types by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -152,6 +156,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "The names to filter rule types by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -160,6 +165,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "The rule attributes to filter rule types by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -170,6 +176,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -177,7 +184,18 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -185,6 +203,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -193,6 +212,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -201,6 +221,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -209,6 +230,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -217,6 +239,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -227,6 +250,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -234,6 +258,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -242,6 +267,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -250,6 +276,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -258,6 +285,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -266,6 +294,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -281,6 +310,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"optional": false,
"defaultValue": "",
"description": "The list of rule types along with their total count.",
"expandable": false,
"children": [
{
"name": "RuleTypeDTO[]",
@@ -288,6 +318,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
},
{
@@ -296,6 +327,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listCurrencies.mdx
+34 -1
View File
@@ -94,6 +94,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "The filters to apply on the retrieved currencies.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -101,6 +102,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"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": "",
"expandable": false,
"children": []
},
{
@@ -109,6 +111,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"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": "",
"expandable": false,
"children": []
},
{
@@ -117,6 +120,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "The codes to filter the currencies by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -127,6 +131,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -134,7 +139,18 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -142,6 +158,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -150,6 +167,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -158,6 +176,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -166,6 +185,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -174,6 +194,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -184,6 +205,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -191,6 +213,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -199,6 +222,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -207,6 +231,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -215,6 +240,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -223,6 +249,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -238,6 +265,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"optional": false,
"defaultValue": "",
"description": "The list of currencies.",
"expandable": false,
"children": [
{
"name": "CurrencyDTO[]",
@@ -245,6 +273,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "code",
@@ -252,6 +281,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -260,6 +290,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "The name of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -268,6 +299,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "The symbol of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -276,6 +308,7 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number)
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listMoneyAmounts.mdx
+37 -1
View File
@@ -126,6 +126,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "The filtes to apply on the retrieved money amounts.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -133,6 +134,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"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": "",
"expandable": false,
"children": []
},
{
@@ -141,6 +143,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"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": "",
"expandable": false,
"children": []
},
{
@@ -149,6 +152,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "Currency codes to filter money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -157,6 +161,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "IDs to filter money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -167,6 +172,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -174,7 +180,18 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -182,6 +199,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -190,6 +208,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -198,6 +217,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -206,6 +226,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -214,6 +235,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -224,6 +246,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -231,6 +254,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -239,6 +263,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -247,6 +272,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -255,6 +281,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -263,6 +290,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -278,6 +306,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"optional": false,
"defaultValue": "",
"description": "The list of money amounts.",
"expandable": false,
"children": [
{
"name": "MoneyAmountDTO[]",
@@ -285,6 +314,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -292,6 +322,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -300,6 +331,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"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": "",
"expandable": false,
"children": []
},
{
@@ -308,6 +340,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -316,6 +349,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -324,6 +358,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -332,6 +367,7 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceRules.mdx
+42 -1
View File
@@ -115,6 +115,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The filters to apply on the retrieved price rules.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -122,6 +123,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"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": "",
"expandable": false,
"children": []
},
{
@@ -130,6 +132,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"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": "",
"expandable": false,
"children": []
},
{
@@ -138,6 +141,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The IDs to filter price rules by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -146,6 +150,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The names to filter price rules by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -154,6 +159,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The IDs to filter the price rule's associated price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -162,6 +168,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The IDs to filter the price rule's associated rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -172,6 +179,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -179,7 +187,18 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -187,6 +206,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -195,6 +215,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -203,6 +224,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -211,6 +233,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -219,6 +242,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -229,6 +253,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -236,6 +261,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -244,6 +270,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -252,6 +279,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -260,6 +288,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -268,6 +297,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -283,6 +313,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"optional": false,
"defaultValue": "",
"description": "The list of price rules.",
"expandable": false,
"children": [
{
"name": "PriceRuleDTO[]",
@@ -290,6 +321,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -297,6 +329,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The ID of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -305,6 +338,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The ID of the associated price list.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -313,6 +347,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -321,6 +356,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -329,6 +365,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The ID of the associated price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -337,6 +374,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The priority of the price rule in comparison to other applicable price rules.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -345,6 +383,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -353,6 +392,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The ID of the associated rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -361,6 +401,7 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number,
"description": "The value of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmountRules.mdx
+37 -1
View File
@@ -115,6 +115,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "The filters to apply on the retrieved price set money amount rules.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -122,6 +123,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"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": "",
"expandable": false,
"children": []
},
{
@@ -130,6 +132,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"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": "",
"expandable": false,
"children": []
},
{
@@ -138,6 +141,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "The ID to filter price set money amount rules by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -146,6 +150,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "The IDs to filter the price set money amount rule's associated price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -154,6 +159,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "The IDs to filter the price set money amount rule's associated rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -162,6 +168,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "The value to filter price set money amount rules by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -172,6 +179,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -179,7 +187,18 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -187,6 +206,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -195,6 +215,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -203,6 +224,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -211,6 +233,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -219,6 +242,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -229,6 +253,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -236,6 +261,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -244,6 +270,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -252,6 +279,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -260,6 +288,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -268,6 +297,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -283,6 +313,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"optional": false,
"defaultValue": "",
"description": "The list of price set money amount rules.",
"expandable": false,
"children": [
{
"name": "PriceSetMoneyAmountRulesDTO[]",
@@ -290,6 +321,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -297,6 +329,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "The ID of the price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -305,6 +338,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -313,6 +347,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -321,6 +356,7 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri
"description": "The value of the price set money amount rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmounts.mdx
+37 -1
View File
@@ -115,6 +115,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "The filters to apply on the retrieved price set money amounts.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -122,6 +123,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"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": "",
"expandable": false,
"children": []
},
{
@@ -130,6 +132,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"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": "",
"expandable": false,
"children": []
},
{
@@ -138,6 +141,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "The IDs to filter the price set money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -146,6 +150,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "The IDs to filter the price set money amount's associated price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -156,6 +161,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -163,7 +169,18 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -171,6 +188,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -179,6 +197,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -187,6 +206,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -195,6 +215,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -203,6 +224,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -213,6 +235,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -220,6 +243,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -228,6 +252,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -236,6 +261,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -244,6 +270,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -252,6 +279,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -267,6 +295,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"optional": false,
"defaultValue": "",
"description": "The list of price set money amounts.",
"expandable": false,
"children": [
{
"name": "PriceSetMoneyAmountDTO[]",
@@ -274,6 +303,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -281,6 +311,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "The ID of a price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -289,6 +320,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"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": "",
"expandable": false,
"children": []
},
{
@@ -297,6 +329,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -305,6 +338,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"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": "",
"expandable": false,
"children": []
},
{
@@ -313,6 +347,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -321,6 +356,7 @@ async function retrievePriceSetMoneyAmounts (ids: string[], titles: string[], sk
"description": "The title of the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listRuleTypes.mdx
+36 -1
View File
@@ -121,6 +121,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "The filters to apply on the retrieved rule types.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -128,6 +129,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"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": "",
"expandable": false,
"children": []
},
{
@@ -136,6 +138,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"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": "",
"expandable": false,
"children": []
},
{
@@ -144,6 +147,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "The IDs to filter rule types by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -152,6 +156,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "The names to filter rule types by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -160,6 +165,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "The rule attributes to filter rule types by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -170,6 +176,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -177,7 +184,18 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -185,6 +203,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -193,6 +212,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -201,6 +221,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -209,6 +230,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -217,6 +239,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -227,6 +250,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -234,6 +258,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -242,6 +267,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -250,6 +276,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -258,6 +285,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -266,6 +294,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -281,6 +310,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"optional": false,
"defaultValue": "",
"description": "The list of rule types.",
"expandable": false,
"children": [
{
"name": "RuleTypeDTO[]",
@@ -288,6 +318,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -295,6 +326,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -303,6 +335,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -311,6 +344,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -319,6 +353,7 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu
"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,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.removeRules.mdx
+10
View File
@@ -43,6 +43,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) {
"description": "The rules to remove per price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -50,6 +51,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) {
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -58,6 +60,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) {
"description": "The rules to remove. Each string is the `rule_attribute` of a rule to remove.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -68,6 +71,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -75,6 +79,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -83,6 +88,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -91,6 +97,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -99,6 +106,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -107,6 +115,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -122,6 +131,7 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) {
"optional": false,
"defaultValue": "",
"description": "Resolves when rules are successfully removed.",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieve.mdx
+39 -1
View File
@@ -65,6 +65,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "The ID of the price set to retrieve.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -73,6 +74,7 @@ async function retrievePriceSet (priceSetId: string) {
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -80,7 +82,18 @@ async function retrievePriceSet (priceSetId: string) {
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -88,6 +101,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -96,6 +110,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -104,6 +119,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -112,6 +128,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -120,6 +137,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -130,6 +148,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -137,6 +156,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -145,6 +165,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -153,6 +174,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -161,6 +183,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -169,6 +192,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -184,6 +208,7 @@ async function retrievePriceSet (priceSetId: string) {
"optional": false,
"defaultValue": "",
"description": "The retrieved price set.",
"expandable": false,
"children": [
{
"name": "id",
@@ -191,6 +216,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -199,6 +225,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -206,6 +233,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -214,6 +242,7 @@ async function retrievePriceSet (priceSetId: string) {
"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": "",
"expandable": false,
"children": []
},
{
@@ -222,6 +251,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -230,6 +260,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -238,6 +269,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -246,6 +278,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -256,6 +289,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -263,6 +297,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -271,6 +306,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -279,6 +315,7 @@ async function retrievePriceSet (priceSetId: string) {
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -287,6 +324,7 @@ async function retrievePriceSet (priceSetId: 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.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveCurrency.mdx
+30 -1
View File
@@ -65,6 +65,7 @@ async function retrieveCurrency (code: string) {
"description": "The code of the currency to retrieve.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -73,6 +74,7 @@ async function retrieveCurrency (code: string) {
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -80,7 +82,18 @@ async function retrieveCurrency (code: string) {
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -88,6 +101,7 @@ async function retrieveCurrency (code: string) {
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -96,6 +110,7 @@ async function retrieveCurrency (code: string) {
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -104,6 +119,7 @@ async function retrieveCurrency (code: string) {
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -112,6 +128,7 @@ async function retrieveCurrency (code: string) {
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -120,6 +137,7 @@ async function retrieveCurrency (code: string) {
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -130,6 +148,7 @@ async function retrieveCurrency (code: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -137,6 +156,7 @@ async function retrieveCurrency (code: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -145,6 +165,7 @@ async function retrieveCurrency (code: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -153,6 +174,7 @@ async function retrieveCurrency (code: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -161,6 +183,7 @@ async function retrieveCurrency (code: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -169,6 +192,7 @@ async function retrieveCurrency (code: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -184,6 +208,7 @@ async function retrieveCurrency (code: string) {
"optional": false,
"defaultValue": "",
"description": "The retrieved currency.",
"expandable": false,
"children": [
{
"name": "code",
@@ -191,6 +216,7 @@ async function retrieveCurrency (code: string) {
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -199,6 +225,7 @@ async function retrieveCurrency (code: string) {
"description": "The name of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -207,6 +234,7 @@ async function retrieveCurrency (code: string) {
"description": "The symbol of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -215,6 +243,7 @@ async function retrieveCurrency (code: string) {
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveMoneyAmount.mdx
+36 -1
View File
@@ -65,6 +65,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "The ID of the money amount to retrieve.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -73,6 +74,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -80,7 +82,18 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -88,6 +101,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -96,6 +110,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -104,6 +119,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -112,6 +128,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -120,6 +137,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -130,6 +148,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -137,6 +156,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -145,6 +165,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -153,6 +174,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -161,6 +183,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -169,6 +192,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -184,6 +208,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"optional": false,
"defaultValue": "",
"description": "The retrieved money amount.",
"expandable": false,
"children": [
{
"name": "amount",
@@ -191,6 +216,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -199,6 +225,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"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": "",
"expandable": false,
"children": [
{
"name": "code",
@@ -206,6 +233,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -214,6 +242,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "The name of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -222,6 +251,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "The symbol of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -230,6 +260,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -240,6 +271,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -248,6 +280,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -256,6 +289,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -264,6 +298,7 @@ async function retrieveMoneyAmount (moneyAmountId: string) {
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceRule.mdx
+42 -1
View File
@@ -60,6 +60,7 @@ async function retrievePriceRule (id: string) {
"description": "The ID of the price rule to retrieve.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -68,6 +69,7 @@ async function retrievePriceRule (id: string) {
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -75,7 +77,18 @@ async function retrievePriceRule (id: string) {
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -83,6 +96,7 @@ async function retrievePriceRule (id: string) {
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -91,6 +105,7 @@ async function retrievePriceRule (id: string) {
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -99,6 +114,7 @@ async function retrievePriceRule (id: string) {
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -107,6 +123,7 @@ async function retrievePriceRule (id: string) {
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -115,6 +132,7 @@ async function retrievePriceRule (id: string) {
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -125,6 +143,7 @@ async function retrievePriceRule (id: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -132,6 +151,7 @@ async function retrievePriceRule (id: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -140,6 +160,7 @@ async function retrievePriceRule (id: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -148,6 +169,7 @@ async function retrievePriceRule (id: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -156,6 +178,7 @@ async function retrievePriceRule (id: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -164,6 +187,7 @@ async function retrievePriceRule (id: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -179,6 +203,7 @@ async function retrievePriceRule (id: string) {
"optional": false,
"defaultValue": "",
"description": "The retrieved price rule.",
"expandable": false,
"children": [
{
"name": "id",
@@ -186,6 +211,7 @@ async function retrievePriceRule (id: string) {
"description": "The ID of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -194,6 +220,7 @@ async function retrievePriceRule (id: string) {
"description": "The ID of the associated price list.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -202,6 +229,7 @@ async function retrievePriceRule (id: string) {
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -209,6 +237,7 @@ async function retrievePriceRule (id: string) {
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -217,6 +246,7 @@ async function retrievePriceRule (id: string) {
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -225,6 +255,7 @@ async function retrievePriceRule (id: string) {
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -235,6 +266,7 @@ async function retrievePriceRule (id: string) {
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -243,6 +275,7 @@ async function retrievePriceRule (id: string) {
"description": "The ID of the associated price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -251,6 +284,7 @@ async function retrievePriceRule (id: string) {
"description": "The priority of the price rule in comparison to other applicable price rules.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -259,6 +293,7 @@ async function retrievePriceRule (id: string) {
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -266,6 +301,7 @@ async function retrievePriceRule (id: string) {
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -274,6 +310,7 @@ async function retrievePriceRule (id: string) {
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -282,6 +319,7 @@ async function retrievePriceRule (id: string) {
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -290,6 +328,7 @@ async function retrievePriceRule (id: 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.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -300,6 +339,7 @@ async function retrievePriceRule (id: string) {
"description": "The ID of the associated rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -308,6 +348,7 @@ async function retrievePriceRule (id: string) {
"description": "The value of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx
+40 -1
View File
@@ -60,6 +60,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "The ID of the price set money amount rule to retrieve.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -68,6 +69,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -75,7 +77,18 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -83,6 +96,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -91,6 +105,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -99,6 +114,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -107,6 +123,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -115,6 +132,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -125,6 +143,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -132,6 +151,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -140,6 +160,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -148,6 +169,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -156,6 +178,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -164,6 +187,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -179,6 +203,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"optional": false,
"defaultValue": "",
"description": "The retrieved price set money amount rule.",
"expandable": false,
"children": [
{
"name": "id",
@@ -186,6 +211,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "The ID of the price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -194,6 +220,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -201,6 +228,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "The ID of a price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -209,6 +237,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"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": "",
"expandable": false,
"children": []
},
{
@@ -217,6 +246,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -225,6 +255,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"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": "",
"expandable": false,
"children": []
},
{
@@ -233,6 +264,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -241,6 +273,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "The title of the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -251,6 +284,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -258,6 +292,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -266,6 +301,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -274,6 +310,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -282,6 +319,7 @@ async function retrievePriceSetMoneyAmountRule (id: 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.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -292,6 +330,7 @@ async function retrievePriceSetMoneyAmountRule (id: string) {
"description": "The value of the price set money amount rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveRuleType.mdx
+30 -1
View File
@@ -60,6 +60,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "The ID of the rule type to retrieve.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -68,6 +69,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"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": "",
"expandable": false,
"children": [
{
"name": "order",
@@ -75,7 +77,18 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -83,6 +96,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -91,6 +105,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -99,6 +114,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -107,6 +123,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -115,6 +132,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -125,6 +143,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -132,6 +151,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -140,6 +160,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -148,6 +169,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -156,6 +178,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -164,6 +187,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -179,6 +203,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"optional": false,
"defaultValue": "",
"description": "The retrieved rule type.",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -186,6 +211,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -194,6 +220,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -202,6 +229,7 @@ async function retrieveRuleType (ruleTypeId: string) {
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -210,6 +238,7 @@ async function retrieveRuleType (ruleTypeId: 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.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateCurrencies.mdx
+20 -5
View File
@@ -18,18 +18,16 @@ This method is used to update existing currencies with the provided data. In eac
## Example
```ts
import {
initialize as initializePricingModule,
} from "@medusajs/pricing"
import { initialize as initializePricingModule } from "@medusajs/pricing"
async function updateCurrencies () {
async function updateCurrencies() {
const pricingService = await initializePricingModule()
const currencies = await pricingService.updateCurrencies([
{
code: "USD",
symbol: "$",
}
},
])
// do something with the currencies or return them
@@ -45,6 +43,7 @@ async function updateCurrencies () {
"description": "The currencies to update, each having the attributes that should be updated in a currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "code",
@@ -52,6 +51,7 @@ async function updateCurrencies () {
"description": "The code of the currency to update.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -60,6 +60,7 @@ async function updateCurrencies () {
"description": "The name of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -68,6 +69,7 @@ async function updateCurrencies () {
"description": "The symbol of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -76,6 +78,7 @@ async function updateCurrencies () {
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -86,6 +89,7 @@ async function updateCurrencies () {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -93,6 +97,7 @@ async function updateCurrencies () {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -101,6 +106,7 @@ async function updateCurrencies () {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -109,6 +115,7 @@ async function updateCurrencies () {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -117,6 +124,7 @@ async function updateCurrencies () {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -125,6 +133,7 @@ async function updateCurrencies () {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -140,6 +149,7 @@ async function updateCurrencies () {
"optional": false,
"defaultValue": "",
"description": "The list of updated currencies.",
"expandable": false,
"children": [
{
"name": "CurrencyDTO[]",
@@ -147,6 +157,7 @@ async function updateCurrencies () {
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "code",
@@ -154,6 +165,7 @@ async function updateCurrencies () {
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -162,6 +174,7 @@ async function updateCurrencies () {
"description": "The name of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -170,6 +183,7 @@ async function updateCurrencies () {
"description": "The symbol of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -178,6 +192,7 @@ async function updateCurrencies () {
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateMoneyAmounts.mdx
+20
View File
@@ -45,6 +45,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "The money amounts to update, each having the attributes that should be updated in a money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -52,6 +53,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -60,6 +62,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "The code of the currency to associate with the money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -68,6 +71,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "The ID of the money amount to update.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -76,6 +80,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -84,6 +89,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -94,6 +100,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -101,6 +108,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -109,6 +117,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -117,6 +126,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -125,6 +135,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -133,6 +144,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -148,6 +160,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"optional": false,
"defaultValue": "",
"description": "The list of updated money amounts.",
"expandable": false,
"children": [
{
"name": "MoneyAmountDTO[]",
@@ -155,6 +168,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -162,6 +176,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -170,6 +185,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"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": "",
"expandable": false,
"children": []
},
{
@@ -178,6 +194,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -186,6 +203,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -194,6 +212,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -202,6 +221,7 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) {
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceRules.mdx
+25
View File
@@ -48,6 +48,7 @@ async function updatePriceRules (
"description": "The price rules to update, each having attributes that should be updated in a price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -55,6 +56,7 @@ async function updatePriceRules (
"description": "The ID of the price rule to update.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -63,6 +65,7 @@ async function updatePriceRules (
"description": "The ID of the associated price list.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -71,6 +74,7 @@ async function updatePriceRules (
"description": "The ID of the associated price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -79,6 +83,7 @@ async function updatePriceRules (
"description": "The ID of the associated price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -87,6 +92,7 @@ async function updatePriceRules (
"description": "The priority of the price rule in comparison to other applicable price rules.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -95,6 +101,7 @@ async function updatePriceRules (
"description": "The ID of the associated rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -103,6 +110,7 @@ async function updatePriceRules (
"description": "The value of the price rule.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -113,6 +121,7 @@ async function updatePriceRules (
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -120,6 +129,7 @@ async function updatePriceRules (
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -128,6 +138,7 @@ async function updatePriceRules (
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -136,6 +147,7 @@ async function updatePriceRules (
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -144,6 +156,7 @@ async function updatePriceRules (
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -152,6 +165,7 @@ async function updatePriceRules (
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -167,6 +181,7 @@ async function updatePriceRules (
"optional": false,
"defaultValue": "",
"description": "The list of updated price rules.",
"expandable": false,
"children": [
{
"name": "PriceRuleDTO[]",
@@ -174,6 +189,7 @@ async function updatePriceRules (
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -181,6 +197,7 @@ async function updatePriceRules (
"description": "The ID of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -189,6 +206,7 @@ async function updatePriceRules (
"description": "The ID of the associated price list.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -197,6 +215,7 @@ async function updatePriceRules (
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -205,6 +224,7 @@ async function updatePriceRules (
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -213,6 +233,7 @@ async function updatePriceRules (
"description": "The ID of the associated price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -221,6 +242,7 @@ async function updatePriceRules (
"description": "The priority of the price rule in comparison to other applicable price rules.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -229,6 +251,7 @@ async function updatePriceRules (
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -237,6 +260,7 @@ async function updatePriceRules (
"description": "The ID of the associated rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -245,6 +269,7 @@ async function updatePriceRules (
"description": "The value of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceSetMoneyAmountRules.mdx
+17
View File
@@ -45,6 +45,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "The price set money amounts to update, each having the attributes to update in a price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -52,6 +53,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "The ID of the price set money amount rule to update.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -60,6 +62,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "The ID of a price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -68,6 +71,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "The ID of a rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -76,6 +80,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "The value of the price set money amount rule.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -86,6 +91,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -93,6 +99,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -101,6 +108,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -109,6 +117,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -117,6 +126,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -125,6 +135,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -140,6 +151,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"optional": false,
"defaultValue": "",
"description": "The list of updated price set money amount rules.",
"expandable": false,
"children": [
{
"name": "PriceSetMoneyAmountRulesDTO[]",
@@ -147,6 +159,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -154,6 +167,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "The ID of the price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -162,6 +176,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -170,6 +185,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -178,6 +194,7 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) {
"description": "The value of the price set money amount rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateRuleTypes.mdx
+17
View File
@@ -45,6 +45,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"description": "The rule types to update, each having the attributes that should be updated in a rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -52,6 +53,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -60,6 +62,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"description": "The ID of the rule type to update.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -68,6 +71,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"description": "The display name of the rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -76,6 +80,7 @@ async function updateRuleTypes (ruleTypeId: 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.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -86,6 +91,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"description": "A context used to share resources, such as transaction manager, between the application and the module.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "enableNestedTransactions",
@@ -93,6 +99,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -101,6 +108,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -109,6 +117,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -117,6 +126,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -125,6 +135,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -140,6 +151,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"optional": false,
"defaultValue": "",
"description": "The list of updated rule types.",
"expandable": false,
"children": [
{
"name": "RuleTypeDTO[]",
@@ -147,6 +159,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -154,6 +167,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -162,6 +176,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -170,6 +185,7 @@ async function updateRuleTypes (ruleTypeId: string) {
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -178,6 +194,7 @@ async function updateRuleTypes (ruleTypeId: 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.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]