From 0ffa48b07f8be4e6f3ae4631816d46da705dc7d7 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 20 Oct 2023 12:08:59 +0000 Subject: [PATCH] chore(docs): Generated Pricing Module Reference (#5432) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com> --- .../IPricingModuleService.addPrices.mdx | 431 +++++++++++++++++- .../IPricingModuleService.addRules.mdx | 317 ++++++++++++- .../IPricingModuleService.calculatePrices.mdx | 138 +++++- .../methods/IPricingModuleService.create.mdx | 431 +++++++++++++++++- ...IPricingModuleService.createCurrencies.mdx | 146 +++++- ...ricingModuleService.createMoneyAmounts.mdx | 211 ++++++++- ...IPricingModuleService.createPriceRules.mdx | 210 ++++++++- ...Service.createPriceSetMoneyAmountRules.mdx | 138 +++++- .../IPricingModuleService.createRuleTypes.mdx | 146 +++++- .../methods/IPricingModuleService.delete.mdx | 71 ++- ...IPricingModuleService.deleteCurrencies.mdx | 71 ++- ...ricingModuleService.deleteMoneyAmounts.mdx | 71 ++- ...IPricingModuleService.deletePriceRules.mdx | 71 ++- ...Service.deletePriceSetMoneyAmountRules.mdx | 71 ++- .../IPricingModuleService.deleteRuleTypes.mdx | 71 ++- .../methods/IPricingModuleService.list.mdx | 228 ++++++++- .../IPricingModuleService.listAndCount.mdx | 211 ++++++++- ...ngModuleService.listAndCountCurrencies.mdx | 170 ++++++- ...ModuleService.listAndCountMoneyAmounts.mdx | 178 +++++++- ...ngModuleService.listAndCountPriceRules.mdx | 194 +++++++- ...e.listAndCountPriceSetMoneyAmountRules.mdx | 194 +++++++- ...ingModuleService.listAndCountRuleTypes.mdx | 186 +++++++- .../IPricingModuleService.listCurrencies.mdx | 195 +++++++- ...IPricingModuleService.listMoneyAmounts.mdx | 219 ++++++++- .../IPricingModuleService.listPriceRules.mdx | 259 ++++++++++- ...leService.listPriceSetMoneyAmountRules.mdx | 219 ++++++++- .../IPricingModuleService.listRuleTypes.mdx | 211 ++++++++- .../IPricingModuleService.removeRules.mdx | 88 +++- .../IPricingModuleService.retrieve.mdx | 235 +++++++++- ...IPricingModuleService.retrieveCurrency.mdx | 161 ++++++- ...icingModuleService.retrieveMoneyAmount.mdx | 210 ++++++++- ...PricingModuleService.retrievePriceRule.mdx | 259 ++++++++++- ...rvice.retrievePriceSetMoneyAmountRules.mdx | 227 ++++++++- ...IPricingModuleService.retrieveRuleType.mdx | 161 ++++++- ...IPricingModuleService.updateCurrencies.mdx | 146 +++++- ...ricingModuleService.updateMoneyAmounts.mdx | 170 ++++++- ...IPricingModuleService.updatePriceRules.mdx | 210 ++++++++- ...Service.updatePriceSetMoneyAmountRules.mdx | 146 +++++- .../IPricingModuleService.updateRuleTypes.mdx | 146 +++++- .../pricing/interfaces/AddPricesDTO.mdx | 109 ++++- .../pricing/interfaces/AddRulesDTO.mdx | 19 +- .../pricing/interfaces/BaseFilterable.mdx | 30 +- .../interfaces/CalculatedPriceSetDTO.mdx | 43 +- .../references/pricing/interfaces/Context.mdx | 54 ++- .../pricing/interfaces/CreateCurrencyDTO.mdx | 35 +- .../interfaces/CreateMoneyAmountDTO.mdx | 84 +++- .../pricing/interfaces/CreatePriceRuleDTO.mdx | 59 ++- .../pricing/interfaces/CreatePriceSetDTO.mdx | 109 ++++- .../CreatePriceSetMoneyAmountRulesDTO.mdx | 27 +- .../pricing/interfaces/CreatePricesDTO.mdx | 92 +++- .../pricing/interfaces/CreateRuleTypeDTO.mdx | 35 +- .../pricing/interfaces/CurrencyDTO.mdx | 35 +- .../interfaces/FilterableCurrencyProps.mdx | 27 +- .../interfaces/FilterableMoneyAmountProps.mdx | 35 +- .../interfaces/FilterablePriceRuleProps.mdx | 51 ++- ...ilterablePriceSetMoneyAmountRulesProps.mdx | 51 ++- .../interfaces/FilterablePriceSetProps.mdx | 68 ++- .../interfaces/FilterableRuleTypeProps.mdx | 43 +- .../pricing/interfaces/FindConfig.mdx | 62 ++- .../interfaces/JoinerServiceConfig.mdx | 59 ++- .../interfaces/JoinerServiceConfigAlias.mdx | 19 +- .../pricing/interfaces/MoneyAmountDTO.mdx | 84 +++- .../pricing/interfaces/PriceRuleDTO.mdx | 215 ++++++++- .../pricing/interfaces/PriceSetDTO.mdx | 142 +++++- .../interfaces/PriceSetMoneyAmountDTO.mdx | 224 ++++++++- .../PriceSetMoneyAmountRulesDTO.mdx | 175 ++++++- .../pricing/interfaces/PricingContext.mdx | 11 +- .../pricing/interfaces/PricingFilters.mdx | 11 +- .../interfaces/RemovePriceSetRulesDTO.mdx | 19 +- .../pricing/interfaces/RuleTypeDTO.mdx | 35 +- .../pricing/interfaces/UpdateCurrencyDTO.mdx | 35 +- .../interfaces/UpdateMoneyAmountDTO.mdx | 43 +- .../pricing/interfaces/UpdatePriceRuleDTO.mdx | 59 ++- .../pricing/interfaces/UpdatePriceSetDTO.mdx | 11 +- .../UpdatePriceSetMoneyAmountRulesDTO.mdx | 35 +- .../pricing/interfaces/UpdateRuleTypeDTO.mdx | 35 +- .../references/pricing/types/Exclude.mdx | 19 +- .../pricing/types/JoinerRelationship.mdx | 67 ++- .../content/references/pricing/types/Omit.mdx | 19 +- .../content/references/pricing/types/Pick.mdx | 19 +- .../references/pricing/types/Record.mdx | 19 +- 81 files changed, 9511 insertions(+), 129 deletions(-) diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPrices.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPrices.mdx index 3e1425b0ae..55a219c630 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPrices.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addPrices.mdx @@ -90,11 +90,259 @@ async function addPricesToPriceSet (priceSetId: string) { ### Parameters -","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":"","children":[]}]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +", + "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": "", + "children": [] + } + ] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ### Returns -","optional":false,"defaultValue":"","description":"The price set that the prices were added to.","children":[{"name":"PriceSetDTO","type":"`object`","description":"A price set's data.","optional":false,"defaultValue":"","children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","children":[]},{"name":"money_amounts","type":"[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","children":[]},{"name":"rule_types","type":"[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]","description":"The rule types applied on this price set.","optional":true,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The price set that the prices were added to.", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "money_amounts", + "type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]", + "description": "The prices that belong to this price set.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "amount", + "type": "`number`", + "description": "The price of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)", + "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "The currency code of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "`number`", + "description": "The maximum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "`number`", + "description": "The minimum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule_types", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]", + "description": "The rule types applied on this price set.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "default_priority", + "type": "`number`", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The display name of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_attribute", + "type": "`string`", + "description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> ## addPrices(data, sharedContext?): Promise @@ -173,8 +421,183 @@ async function addPricesToPriceSet (priceSetId: string) { ### Parameters -","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":"","children":[]}]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +", + "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": "", + "children": [] + } + ] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ### Returns -","optional":false,"defaultValue":"","description":"The list of the price sets that prices were added to.","children":[{"name":"PriceSetDTO[]","type":"[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"PriceSetDTO","type":"`object`","description":"A price set's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of the price sets that prices were added to.", + "children": [ + { + "name": "PriceSetDTO[]", + "type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "money_amounts", + "type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]", + "description": "The prices that belong to this price set.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_types", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]", + "description": "The rule types applied on this price set.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addRules.mdx index d1b9c419c7..a1063b4ef0 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.addRules.mdx @@ -40,11 +40,202 @@ async function addRulesToPriceSet (priceSetId: string) { ### Parameters - + ### Returns -","optional":false,"defaultValue":"","description":"The price set that the rules were added to.","children":[{"name":"PriceSetDTO","type":"`object`","description":"A price set's data.","optional":false,"defaultValue":"","children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","children":[]},{"name":"money_amounts","type":"[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","children":[]},{"name":"rule_types","type":"[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]","description":"The rule types applied on this price set.","optional":true,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The price set that the rules were added to.", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "money_amounts", + "type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]", + "description": "The prices that belong to this price set.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "amount", + "type": "`number`", + "description": "The price of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)", + "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "The currency code of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "`number`", + "description": "The maximum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "`number`", + "description": "The minimum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule_types", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]", + "description": "The rule types applied on this price set.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "default_priority", + "type": "`number`", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The display name of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_attribute", + "type": "`string`", + "description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> ## addRules(data, sharedContext?): Promise @@ -73,8 +264,126 @@ async function addRulesToPriceSet (priceSetId: string) { ### Parameters - + ### Returns -","optional":false,"defaultValue":"","description":"The list of the price sets that the rules were added to.","children":[{"name":"PriceSetDTO[]","type":"[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"PriceSetDTO","type":"`object`","description":"A price set's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of the price sets that the rules were added to.", + "children": [ + { + "name": "PriceSetDTO[]", + "type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "money_amounts", + "type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]", + "description": "The prices that belong to this price set.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_types", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]", + "description": "The rule types applied on this price set.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.calculatePrices.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.calculatePrices.mdx index 37b5c1d400..c2fef52961 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.calculatePrices.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.calculatePrices.mdx @@ -87,8 +87,142 @@ async function calculatePrice (priceSetId: string, currencyCode: string) { ## Parameters -","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The calculated price matching the context and filters provided.","children":[{"name":"CalculatedPriceSetDTO","type":"`object`","description":"A calculated price set's data.","optional":false,"defaultValue":"","children":[{"name":"amount","type":"``null`` \\| `number`","description":"The calculated amount. It can possibly be `null` if there's no price set up for the provided context.","optional":false,"defaultValue":"","children":[]},{"name":"currency_code","type":"``null`` \\| `string`","description":"The currency code of the calculated price. It can possibly be `null`.","optional":false,"defaultValue":"","children":[]},{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","children":[]},{"name":"max_quantity","type":"``null`` \\| `number`","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":"","children":[]},{"name":"min_quantity","type":"``null`` \\| `number`","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":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The calculated price matching the context and filters provided.", + "children": [ + { + "name": "amount", + "type": "``null`` \\| `number`", + "description": "The calculated amount. It can possibly be `null` if there's no price set up for the provided context.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "``null`` \\| `string`", + "description": "The currency code of the calculated price. It can possibly be `null`.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "``null`` \\| `number`", + "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": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "``null`` \\| `number`", + "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": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.create.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.create.mdx index f5a3ad76f6..db39cc31dd 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.create.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.create.mdx @@ -101,11 +101,259 @@ async function createPriceSet () { ### Parameters -","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":"","children":[]}]},{"name":"rules","type":"{ `rule_attribute`: `string` }[]","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":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +", + "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": "", + "children": [] + } + ] + }, + { + "name": "rules", + "type": "{ `rule_attribute`: `string` }[]", + "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": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ### Returns -","optional":false,"defaultValue":"","description":"The created price set.","children":[{"name":"PriceSetDTO","type":"`object`","description":"A price set's data.","optional":false,"defaultValue":"","children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","children":[]},{"name":"money_amounts","type":"[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","children":[]},{"name":"rule_types","type":"[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]","description":"The rule types applied on this price set.","optional":true,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The created price set.", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "money_amounts", + "type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]", + "description": "The prices that belong to this price set.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "amount", + "type": "`number`", + "description": "The price of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)", + "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "The currency code of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "`number`", + "description": "The maximum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "`number`", + "description": "The minimum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule_types", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]", + "description": "The rule types applied on this price set.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "default_priority", + "type": "`number`", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The display name of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_attribute", + "type": "`string`", + "description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> ## create(data, sharedContext?): Promise @@ -188,8 +436,183 @@ async function createPriceSets () { ### Parameters -","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":"","children":[]}]},{"name":"rules","type":"{ `rule_attribute`: `string` }[]","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":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +", + "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": "", + "children": [] + } + ] + }, + { + "name": "rules", + "type": "{ `rule_attribute`: `string` }[]", + "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": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ### Returns -","optional":false,"defaultValue":"","description":"The list of created price sets.","children":[{"name":"PriceSetDTO[]","type":"[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"PriceSetDTO","type":"`object`","description":"A price set's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of created price sets.", + "children": [ + { + "name": "PriceSetDTO[]", + "type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "money_amounts", + "type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]", + "description": "The prices that belong to this price set.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_types", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]", + "description": "The rule types applied on this price set.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createCurrencies.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createCurrencies.mdx index f7ab223476..9efaa2ce16 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createCurrencies.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createCurrencies.mdx @@ -40,8 +40,150 @@ async function createCurrencies () { ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"The list of created currencies.","children":[{"name":"CurrencyDTO[]","type":"[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"CurrencyDTO","type":"`object`","description":"A currency's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of created currencies.", + "children": [ + { + "name": "CurrencyDTO[]", + "type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "code", + "type": "`string`", + "description": "The code of the currency.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The name of the currency.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "The symbol of the currency.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createMoneyAmounts.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createMoneyAmounts.mdx index 93fda6591a..846d29e7dc 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createMoneyAmounts.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createMoneyAmounts.mdx @@ -44,8 +44,215 @@ async function retrieveMoneyAmounts () { ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"The list of created money amounts.","children":[{"name":"MoneyAmountDTO[]","type":"[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"MoneyAmountDTO","type":"`object`","description":"A money amount's data. A money amount represents a price.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of created money amounts.", + "children": [ + { + "name": "MoneyAmountDTO[]", + "type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "amount", + "type": "`number`", + "description": "The price of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)", + "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "The currency code of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "`number`", + "description": "The maximum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "`number`", + "description": "The minimum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceRules.mdx index 6409d1c870..fe0bc65e7d 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceRules.mdx @@ -49,8 +49,214 @@ async function createPriceRules ( ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"The list of created price rules.","children":[{"name":"PriceRuleDTO[]","type":"[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"PriceRuleDTO","type":"`object`","description":"A price rule's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of created price rules.", + "children": [ + { + "name": "PriceRuleDTO[]", + "type": "[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price rule.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "`string`", + "description": "The ID of the associated price list.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set", + "type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)", + "description": "The associated price set. It may only be available if the relation `price_set` is expanded.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_id", + "type": "`string`", + "description": "The ID of the associated price set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_money_amount_id", + "type": "`string`", + "description": "The ID of the associated price set money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "priority", + "type": "`number`", + "description": "The priority of the price rule in comparison to other applicable price rules.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)", + "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type_id", + "type": "`string`", + "description": "The ID of the associated rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "The value of the price rule.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceSetMoneyAmountRules.mdx index 72e8d118d4..c81cee80b6 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceSetMoneyAmountRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createPriceSetMoneyAmountRules.mdx @@ -40,8 +40,142 @@ async function createPriceSetMoneyAmountRules (priceSetMoneyAmountId: string, ru ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"The list of created price set money amount rules.","children":[{"name":"PriceSetMoneyAmountRulesDTO[]","type":"[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"PriceSetMoneyAmountRulesDTO","type":"`object`","description":"A price set money amount rule's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of created price set money amount rules.", + "children": [ + { + "name": "PriceSetMoneyAmountRulesDTO[]", + "type": "[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)", + "description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)", + "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "The value of the price set money amount rule.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createRuleTypes.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createRuleTypes.mdx index 7760de6faf..d0c71a79cf 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createRuleTypes.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.createRuleTypes.mdx @@ -38,8 +38,150 @@ async function createRuleTypes () { ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"The list of created rule types.","children":[{"name":"RuleTypeDTO[]","type":"[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"RuleTypeDTO","type":"`object`","description":"A rule type's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of created rule types.", + "children": [ + { + "name": "RuleTypeDTO[]", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "default_priority", + "type": "`number`", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The display name of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_attribute", + "type": "`string`", + "description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.delete.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.delete.mdx index 987bb83814..29cfc17f02 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.delete.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.delete.mdx @@ -31,8 +31,75 @@ async function removePriceSetRule (priceSetIds: string[]) { ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"Resolves when the price sets are successfully deleted.","children":[]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "Resolves when the price sets are successfully deleted.", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteCurrencies.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteCurrencies.mdx index 6a66f76d9a..1cddde024b 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteCurrencies.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteCurrencies.mdx @@ -32,8 +32,75 @@ async function deleteCurrencies () { ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"Resolves once the currencies are deleted.","children":[]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "Resolves once the currencies are deleted.", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteMoneyAmounts.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteMoneyAmounts.mdx index 217ff7e042..e187ba7667 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteMoneyAmounts.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteMoneyAmounts.mdx @@ -33,8 +33,75 @@ async function deleteMoneyAmounts (moneyAmountIds: string[]) { ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"Resolves when the money amounts are successfully deleted.","children":[]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "Resolves when the money amounts are successfully deleted.", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceRules.mdx index 8ba61ffb59..4f75d62029 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceRules.mdx @@ -33,8 +33,75 @@ async function deletePriceRules ( ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"Resolves once the price rules are deleted.","children":[]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "Resolves once the price rules are deleted.", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceSetMoneyAmountRules.mdx index fada33a42a..8017e4d470 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceSetMoneyAmountRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deletePriceSetMoneyAmountRules.mdx @@ -31,8 +31,75 @@ async function deletePriceSetMoneyAmountRule (id: string) { ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"Resolves once the price set money amount rules are deleted.","children":[]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "Resolves once the price set money amount rules are deleted.", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteRuleTypes.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteRuleTypes.mdx index cb88fb618f..4011150e74 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteRuleTypes.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.deleteRuleTypes.mdx @@ -31,8 +31,75 @@ async function deleteRuleTypes (ruleTypeId: string) { ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"Resolves once the rule types are deleted.","children":[]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "Resolves once the rule types are deleted.", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.list.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.list.mdx index eddda24f5a..5248e76141 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.list.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.list.mdx @@ -121,8 +121,232 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[ ## Parameters -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx)\\>)[]","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":"","children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter price sets by.","optional":true,"defaultValue":"","children":[]},{"name":"money_amounts","type":"[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)","description":"Filters to apply on a price set's associated money amounts.","optional":true,"defaultValue":"","children":[{"name":"$and","type":"([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]","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":"","children":[]},{"name":"$or","type":"([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]","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":"","children":[]},{"name":"currency_code","type":"`string` \\| `string`[]","description":"Currency codes to filter money amounts by.","optional":true,"defaultValue":"","children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter money amounts by.","optional":true,"defaultValue":"","children":[]}]}]},{"name":"config","type":"[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)\\>","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "IDs to filter price sets by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "money_amounts", + "type": "[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)", + "description": "Filters to apply on a price set's associated money amounts.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "$and", + "type": "([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string` \\| `string`[]", + "description": "Currency codes to filter money amounts by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "IDs to filter money amounts by.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } + ] + }, + { + "name": "config", + "type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)\\>", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The list of price sets.","children":[{"name":"PriceSetDTO[]","type":"[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"PriceSetDTO","type":"`object`","description":"A price set's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of price sets.", + "children": [ + { + "name": "PriceSetDTO[]", + "type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "money_amounts", + "type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]", + "description": "The prices that belong to this price set.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_types", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]", + "description": "The rule types applied on this price set.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCount.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCount.mdx index 21261efbab..ae6261890c 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCount.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCount.mdx @@ -121,8 +121,215 @@ async function retrievePriceSets (priceSetIds: string[], moneyAmountIds: string[ ## Parameters -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx)\\>)[]","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":"","children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter price sets by.","optional":true,"defaultValue":"","children":[]},{"name":"money_amounts","type":"[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)","description":"Filters to apply on a price set's associated money amounts.","optional":true,"defaultValue":"","children":[{"name":"$and","type":"([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]","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":"","children":[]},{"name":"$or","type":"([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]","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":"","children":[]},{"name":"currency_code","type":"`string` \\| `string`[]","description":"Currency codes to filter money amounts by.","optional":true,"defaultValue":"","children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter money amounts by.","optional":true,"defaultValue":"","children":[]}]}]},{"name":"config","type":"[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)\\>","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetProps`](../../interfaces/FilterablePriceSetProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "IDs to filter price sets by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "money_amounts", + "type": "[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)", + "description": "Filters to apply on a price set's associated money amounts.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "$and", + "type": "([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string` \\| `string`[]", + "description": "Currency codes to filter money amounts by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "IDs to filter money amounts by.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } + ] + }, + { + "name": "config", + "type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)\\>", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The list of price sets along with their total count.","children":[{"name":"PriceSetDTO[]","type":"[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[]},{"name":"number","type":"`number`","optional":true,"defaultValue":"","description":"","children":[]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of price sets along with their total count.", + "children": [ + { + "name": "PriceSetDTO[]", + "type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountCurrencies.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountCurrencies.mdx index ae54fea90c..d88653972f 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountCurrencies.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountCurrencies.mdx @@ -87,8 +87,174 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number) ## Parameters -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx)\\>)[]","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":"","children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","children":[]}]},{"name":"config","type":"[`FindConfig`](../../interfaces/FindConfig.mdx)<[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)\\>","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "code", + "type": "`string`[]", + "description": "The codes to filter the currencies by.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "config", + "type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)\\>", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The list of currencies along with the total count.","children":[{"name":"CurrencyDTO[]","type":"[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[]},{"name":"number","type":"`number`","optional":true,"defaultValue":"","description":"","children":[]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of currencies along with the total count.", + "children": [ + { + "name": "CurrencyDTO[]", + "type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountMoneyAmounts.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountMoneyAmounts.mdx index 5e12436051..225f0f317b 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountMoneyAmounts.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountMoneyAmounts.mdx @@ -119,8 +119,182 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str ## Parameters -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]","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":"","children":[]},{"name":"currency_code","type":"`string` \\| `string`[]","description":"Currency codes to filter money amounts by.","optional":true,"defaultValue":"","children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter money amounts by.","optional":true,"defaultValue":"","children":[]}]},{"name":"config","type":"[`FindConfig`](../../interfaces/FindConfig.mdx)<[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)\\>","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string` \\| `string`[]", + "description": "Currency codes to filter money amounts by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "IDs to filter money amounts by.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "config", + "type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)\\>", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The list of money amounts along with their total count.","children":[{"name":"MoneyAmountDTO[]","type":"[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[]},{"name":"number","type":"`number`","optional":true,"defaultValue":"","description":"","children":[]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of money amounts along with their total count.", + "children": [ + { + "name": "MoneyAmountDTO[]", + "type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceRules.mdx index 78e3714fa0..e6a9a673c9 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceRules.mdx @@ -108,8 +108,198 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number, ## Parameters -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx)\\>)[]","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":"","children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter price rules by.","optional":true,"defaultValue":"","children":[]},{"name":"name","type":"`string`[]","description":"The names to filter price rules by.","optional":true,"defaultValue":"","children":[]},{"name":"price_set_id","type":"`string`[]","description":"The IDs to filter the price rule's associated price set.","optional":true,"defaultValue":"","children":[]},{"name":"rule_type_id","type":"`string`[]","description":"The IDs to filter the price rule's associated rule type.","optional":true,"defaultValue":"","children":[]}]},{"name":"config","type":"[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)\\>","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "The IDs to filter price rules by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`[]", + "description": "The names to filter price rules by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_id", + "type": "`string`[]", + "description": "The IDs to filter the price rule's associated price set.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type_id", + "type": "`string`[]", + "description": "The IDs to filter the price rule's associated rule type.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "config", + "type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)\\>", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The list of price rules along with their total count.","children":[{"name":"PriceRuleDTO[]","type":"[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[]},{"name":"number","type":"`number`","optional":true,"defaultValue":"","description":"","children":[]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of price rules along with their total count.", + "children": [ + { + "name": "PriceRuleDTO[]", + "type": "[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx index 6069c31807..b10544f6ac 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx @@ -109,8 +109,198 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri ## Parameters -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]","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":"","children":[]},{"name":"id","type":"`string`[]","description":"The ID to filter price set money amount rules by.","optional":true,"defaultValue":"","children":[]},{"name":"price_set_money_amount_id","type":"`string`[]","description":"The IDs to filter the price set money amount rule's associated price set money amount.","optional":true,"defaultValue":"","children":[]},{"name":"rule_type_id","type":"`string`[]","description":"The IDs to filter the price set money amount rule's associated rule type.","optional":true,"defaultValue":"","children":[]},{"name":"value","type":"`string`[]","description":"The value to filter price set money amount rules by.","optional":true,"defaultValue":"","children":[]}]},{"name":"config","type":"[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)\\>","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "The ID to filter price set money amount rules by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_money_amount_id", + "type": "`string`[]", + "description": "The IDs to filter the price set money amount rule's associated price set money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type_id", + "type": "`string`[]", + "description": "The IDs to filter the price set money amount rule's associated rule type.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`[]", + "description": "The value to filter price set money amount rules by.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "config", + "type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)\\>", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The list of price set money amount rules and their total count.","children":[{"name":"PriceSetMoneyAmountRulesDTO[]","type":"[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[]},{"name":"number","type":"`number`","optional":true,"defaultValue":"","description":"","children":[]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of price set money amount rules and their total count.", + "children": [ + { + "name": "PriceSetMoneyAmountRulesDTO[]", + "type": "[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountRuleTypes.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountRuleTypes.mdx index cce0d800c3..b01c95349d 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountRuleTypes.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listAndCountRuleTypes.mdx @@ -114,8 +114,190 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu ## Parameters -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx)\\>)[]","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":"","children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter rule types by.","optional":true,"defaultValue":"","children":[]},{"name":"name","type":"`string`[]","description":"The names to filter rule types by.","optional":true,"defaultValue":"","children":[]},{"name":"rule_attribute","type":"`string`[]","description":"The rule attributes to filter rule types by.","optional":true,"defaultValue":"","children":[]}]},{"name":"config","type":"[`FindConfig`](../../interfaces/FindConfig.mdx)<[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)\\>","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "The IDs to filter rule types by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`[]", + "description": "The names to filter rule types by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_attribute", + "type": "`string`[]", + "description": "The rule attributes to filter rule types by.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "config", + "type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)\\>", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The list of rule types along with their total count.","children":[{"name":"RuleTypeDTO[]","type":"[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[]},{"name":"number","type":"`number`","optional":true,"defaultValue":"","description":"","children":[]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of rule types along with their total count.", + "children": [ + { + "name": "RuleTypeDTO[]", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [] + }, + { + "name": "number", + "type": "`number`", + "optional": true, + "defaultValue": "", + "description": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listCurrencies.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listCurrencies.mdx index e878fb042c..89490aaedc 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listCurrencies.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listCurrencies.mdx @@ -87,8 +87,199 @@ async function retrieveCurrencies (codes: string[], skip: number, take: number) ## Parameters -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx)\\>)[]","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":"","children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","children":[]}]},{"name":"config","type":"[`FindConfig`](../../interfaces/FindConfig.mdx)<[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)\\>","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableCurrencyProps`](../../interfaces/FilterableCurrencyProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "code", + "type": "`string`[]", + "description": "The codes to filter the currencies by.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "config", + "type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)\\>", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The list of currencies.","children":[{"name":"CurrencyDTO[]","type":"[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"CurrencyDTO","type":"`object`","description":"A currency's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of currencies.", + "children": [ + { + "name": "CurrencyDTO[]", + "type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "code", + "type": "`string`", + "description": "The code of the currency.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The name of the currency.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "The symbol of the currency.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listMoneyAmounts.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listMoneyAmounts.mdx index 0a2868c66b..488f93c61b 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listMoneyAmounts.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listMoneyAmounts.mdx @@ -119,8 +119,223 @@ async function retrieveMoneyAmounts (moneyAmountIds: string[], currencyCode: str ## Parameters -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]","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":"","children":[]},{"name":"currency_code","type":"`string` \\| `string`[]","description":"Currency codes to filter money amounts by.","optional":true,"defaultValue":"","children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter money amounts by.","optional":true,"defaultValue":"","children":[]}]},{"name":"config","type":"[`FindConfig`](../../interfaces/FindConfig.mdx)<[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)\\>","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](../../interfaces/FilterableMoneyAmountProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string` \\| `string`[]", + "description": "Currency codes to filter money amounts by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "IDs to filter money amounts by.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "config", + "type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)\\>", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The list of money amounts.","children":[{"name":"MoneyAmountDTO[]","type":"[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"MoneyAmountDTO","type":"`object`","description":"A money amount's data. A money amount represents a price.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of money amounts.", + "children": [ + { + "name": "MoneyAmountDTO[]", + "type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "amount", + "type": "`number`", + "description": "The price of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)", + "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "The currency code of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "`number`", + "description": "The maximum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "`number`", + "description": "The minimum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceRules.mdx index 39ac311e00..05126e19b1 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceRules.mdx @@ -108,8 +108,263 @@ async function retrievePriceRules (ids: string[], name: string[], skip: number, ## Parameters -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx)\\>)[]","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":"","children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter price rules by.","optional":true,"defaultValue":"","children":[]},{"name":"name","type":"`string`[]","description":"The names to filter price rules by.","optional":true,"defaultValue":"","children":[]},{"name":"price_set_id","type":"`string`[]","description":"The IDs to filter the price rule's associated price set.","optional":true,"defaultValue":"","children":[]},{"name":"rule_type_id","type":"`string`[]","description":"The IDs to filter the price rule's associated rule type.","optional":true,"defaultValue":"","children":[]}]},{"name":"config","type":"[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)\\>","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceRuleProps`](../../interfaces/FilterablePriceRuleProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "The IDs to filter price rules by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`[]", + "description": "The names to filter price rules by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_id", + "type": "`string`[]", + "description": "The IDs to filter the price rule's associated price set.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type_id", + "type": "`string`[]", + "description": "The IDs to filter the price rule's associated rule type.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "config", + "type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)\\>", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The list of price rules.","children":[{"name":"PriceRuleDTO[]","type":"[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"PriceRuleDTO","type":"`object`","description":"A price rule's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of price rules.", + "children": [ + { + "name": "PriceRuleDTO[]", + "type": "[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price rule.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "`string`", + "description": "The ID of the associated price list.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set", + "type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)", + "description": "The associated price set. It may only be available if the relation `price_set` is expanded.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_id", + "type": "`string`", + "description": "The ID of the associated price set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_money_amount_id", + "type": "`string`", + "description": "The ID of the associated price set money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "priority", + "type": "`number`", + "description": "The priority of the price rule in comparison to other applicable price rules.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)", + "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type_id", + "type": "`string`", + "description": "The ID of the associated rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "The value of the price rule.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmountRules.mdx index c7e70628b4..5c1fa36a10 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmountRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmountRules.mdx @@ -108,8 +108,223 @@ async function retrievePriceSetMoneyAmountRules (ids: string[], ruleTypeId: stri ## Parameters -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]","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":"","children":[]},{"name":"id","type":"`string`[]","description":"The ID to filter price set money amount rules by.","optional":true,"defaultValue":"","children":[]},{"name":"price_set_money_amount_id","type":"`string`[]","description":"The IDs to filter the price set money amount rule's associated price set money amount.","optional":true,"defaultValue":"","children":[]},{"name":"rule_type_id","type":"`string`[]","description":"The IDs to filter the price set money amount rule's associated rule type.","optional":true,"defaultValue":"","children":[]},{"name":"value","type":"`string`[]","description":"The value to filter price set money amount rules by.","optional":true,"defaultValue":"","children":[]}]},{"name":"config","type":"[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)\\>","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](../../interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "The ID to filter price set money amount rules by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_money_amount_id", + "type": "`string`[]", + "description": "The IDs to filter the price set money amount rule's associated price set money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type_id", + "type": "`string`[]", + "description": "The IDs to filter the price set money amount rule's associated rule type.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`[]", + "description": "The value to filter price set money amount rules by.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "config", + "type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)\\>", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The list of price set money amount rules.","children":[{"name":"PriceSetMoneyAmountRulesDTO[]","type":"[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"PriceSetMoneyAmountRulesDTO","type":"`object`","description":"A price set money amount rule's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of price set money amount rules.", + "children": [ + { + "name": "PriceSetMoneyAmountRulesDTO[]", + "type": "[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)", + "description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)", + "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "The value of the price set money amount rule.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listRuleTypes.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listRuleTypes.mdx index 4901ebde25..4c2bfd2924 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listRuleTypes.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.listRuleTypes.mdx @@ -114,8 +114,215 @@ async function retrieveRuleTypes (ruleTypeId: string[], name: string[], skip: nu ## Parameters -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx)\\>)[]","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":"","children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter rule types by.","optional":true,"defaultValue":"","children":[]},{"name":"name","type":"`string`[]","description":"The names to filter rule types by.","optional":true,"defaultValue":"","children":[]},{"name":"rule_attribute","type":"`string`[]","description":"The rule attributes to filter rule types by.","optional":true,"defaultValue":"","children":[]}]},{"name":"config","type":"[`FindConfig`](../../interfaces/FindConfig.mdx)<[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)\\>","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](../../interfaces/BaseFilterable.mdx)<[`FilterableRuleTypeProps`](../../interfaces/FilterableRuleTypeProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "The IDs to filter rule types by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`[]", + "description": "The names to filter rule types by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_attribute", + "type": "`string`[]", + "description": "The rule attributes to filter rule types by.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "config", + "type": "[`FindConfig`](../../interfaces/FindConfig.mdx)<[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)\\>", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The list of rule types.","children":[{"name":"RuleTypeDTO[]","type":"[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"RuleTypeDTO","type":"`object`","description":"A rule type's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of rule types.", + "children": [ + { + "name": "RuleTypeDTO[]", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "default_priority", + "type": "`number`", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The display name of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_attribute", + "type": "`string`", + "description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.removeRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.removeRules.mdx index 38c49a5b00..2b1be99dd0 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.removeRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.removeRules.mdx @@ -36,8 +36,92 @@ async function removePriceSetRule (priceSetId: string, ruleAttributes: []) { ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"Resolves when rules are successfully removed.","children":[]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "Resolves when rules are successfully removed.", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieve.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieve.mdx index 6618bf92af..f1fda16a1e 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieve.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieve.mdx @@ -58,8 +58,239 @@ async function retrievePriceSet (priceSetId: string) { ## Parameters -","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The retrieved price set.","children":[{"name":"PriceSetDTO","type":"`object`","description":"A price set's data.","optional":false,"defaultValue":"","children":[{"name":"id","type":"`string`","description":"The ID of the price set.","optional":false,"defaultValue":"","children":[]},{"name":"money_amounts","type":"[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]","description":"The prices that belong to this price set.","optional":true,"defaultValue":"","children":[]},{"name":"rule_types","type":"[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]","description":"The rule types applied on this price set.","optional":true,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The retrieved price set.", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "money_amounts", + "type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]", + "description": "The prices that belong to this price set.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "amount", + "type": "`number`", + "description": "The price of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)", + "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "The currency code of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "`number`", + "description": "The maximum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "`number`", + "description": "The minimum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule_types", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]", + "description": "The rule types applied on this price set.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "default_priority", + "type": "`number`", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The display name of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_attribute", + "type": "`string`", + "description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveCurrency.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveCurrency.mdx index c40b6e52e6..c0dd6f7b10 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveCurrency.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveCurrency.mdx @@ -58,8 +58,165 @@ async function retrieveCurrency (code: string) { ## Parameters -","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The retrieved currency.","children":[{"name":"CurrencyDTO","type":"`object`","description":"A currency's data.","optional":false,"defaultValue":"","children":[{"name":"code","type":"`string`","description":"The code of the currency.","optional":false,"defaultValue":"","children":[]},{"name":"name","type":"`string`","description":"The name of the currency.","optional":true,"defaultValue":"","children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":true,"defaultValue":"","children":[]},{"name":"symbol_native","type":"`string`","description":"The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.","optional":true,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The retrieved currency.", + "children": [ + { + "name": "code", + "type": "`string`", + "description": "The code of the currency.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The name of the currency.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "The symbol of the currency.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveMoneyAmount.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveMoneyAmount.mdx index c7b9ae38fe..138d413a78 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveMoneyAmount.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveMoneyAmount.mdx @@ -58,8 +58,214 @@ async function retrieveMoneyAmount (moneyAmountId: string) { ## Parameters -","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The retrieved money amount.","children":[{"name":"MoneyAmountDTO","type":"`object`","description":"A money amount's data. A money amount represents a price.","optional":false,"defaultValue":"","children":[{"name":"amount","type":"`number`","description":"The price of this money amount.","optional":true,"defaultValue":"","children":[]},{"name":"currency","type":"[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)","description":"The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.","optional":true,"defaultValue":"","children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":true,"defaultValue":"","children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":false,"defaultValue":"","children":[]},{"name":"max_quantity","type":"`number`","description":"The maximum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","children":[]},{"name":"min_quantity","type":"`number`","description":"The minimum quantity required to be purchased for this price to be applied.","optional":true,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The retrieved money amount.", + "children": [ + { + "name": "amount", + "type": "`number`", + "description": "The price of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)", + "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "code", + "type": "`string`", + "description": "The code of the currency.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The name of the currency.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "The symbol of the currency.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "The currency code of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "`number`", + "description": "The maximum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "`number`", + "description": "The minimum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceRule.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceRule.mdx index 35b803b053..f8f778db70 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceRule.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceRule.mdx @@ -53,8 +53,263 @@ async function retrievePriceRule (id: string) { ## Parameters -","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The retrieved price rule.","children":[{"name":"PriceRuleDTO","type":"`object`","description":"A price rule's data.","optional":false,"defaultValue":"","children":[{"name":"id","type":"`string`","description":"The ID of the price rule.","optional":false,"defaultValue":"","children":[]},{"name":"price_list_id","type":"`string`","description":"The ID of the associated price list.","optional":false,"defaultValue":"","children":[]},{"name":"price_set","type":"[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)","description":"The associated price set. It may only be available if the relation `price_set` is expanded.","optional":false,"defaultValue":"","children":[]},{"name":"price_set_id","type":"`string`","description":"The ID of the associated price set.","optional":false,"defaultValue":"","children":[]},{"name":"price_set_money_amount_id","type":"`string`","description":"The ID of the associated price set money amount.","optional":false,"defaultValue":"","children":[]},{"name":"priority","type":"`number`","description":"The priority of the price rule in comparison to other applicable price rules.","optional":false,"defaultValue":"","children":[]},{"name":"rule_type","type":"[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)","description":"The associated rule type. It may only be available if the relation `rule_type` is expanded.","optional":false,"defaultValue":"","children":[]},{"name":"rule_type_id","type":"`string`","description":"The ID of the associated rule type.","optional":false,"defaultValue":"","children":[]},{"name":"value","type":"`string`","description":"The value of the price rule.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The retrieved price rule.", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price rule.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "`string`", + "description": "The ID of the associated price list.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set", + "type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)", + "description": "The associated price set. It may only be available if the relation `price_set` is expanded.", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "money_amounts", + "type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]", + "description": "The prices that belong to this price set.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_types", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]", + "description": "The rule types applied on this price set.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "price_set_id", + "type": "`string`", + "description": "The ID of the associated price set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_money_amount_id", + "type": "`string`", + "description": "The ID of the associated price set money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "priority", + "type": "`number`", + "description": "The priority of the price rule in comparison to other applicable price rules.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)", + "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "default_priority", + "type": "`number`", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The display name of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_attribute", + "type": "`string`", + "description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule_type_id", + "type": "`string`", + "description": "The ID of the associated rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "The value of the price rule.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx index 1c0ed8ea11..ee92a1ab46 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx @@ -53,8 +53,231 @@ async function retrievePriceSetMoneyAmountRule (id: string) { ## Parameters -","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The retrieved price set money amount rule.","children":[{"name":"PriceSetMoneyAmountRulesDTO","type":"`object`","description":"A price set money amount rule's data.","optional":false,"defaultValue":"","children":[{"name":"id","type":"`string`","description":"The ID of the price set money amount.","optional":false,"defaultValue":"","children":[]},{"name":"price_set_money_amount","type":"[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)","description":"The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.","optional":false,"defaultValue":"","children":[]},{"name":"rule_type","type":"[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)","description":"The associated rule type. It may only be available if the relation `rule_type` is expanded.","optional":false,"defaultValue":"","children":[]},{"name":"value","type":"`string`","description":"The value of the price set money amount rule.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The retrieved price set money amount rule.", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)", + "description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of a price set money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "money_amount", + "type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)", + "description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set", + "type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)", + "description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "title", + "type": "`string`", + "description": "The title of the price set money amount.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "rule_type", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)", + "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "optional": false, + "defaultValue": "", + "children": [ + { + "name": "default_priority", + "type": "`number`", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The display name of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_attribute", + "type": "`string`", + "description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + }, + { + "name": "value", + "type": "`string`", + "description": "The value of the price set money amount rule.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveRuleType.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveRuleType.mdx index ce4d923a3c..0247c4d143 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveRuleType.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.retrieveRuleType.mdx @@ -53,8 +53,165 @@ async function retrieveRuleType (ruleTypeId: string) { ## Parameters -","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":"","children":[{"name":"order","type":"`object`","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":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"select","type":"(`string` \\| keyof `Entity`)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","children":[]},{"name":"skip","type":"`number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","children":[]},{"name":"take","type":"`number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","children":[]},{"name":"withDeleted","type":"`boolean`","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":"","children":[]}]},{"name":"sharedContext","type":"[`Context`](../../interfaces/Context.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","children":[{"name":"enableNestedTransactions","type":"`boolean`","description":"a boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","children":[]},{"name":"isolationLevel","type":"`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":"","children":[]},{"name":"manager","type":"`TManager`","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":"","children":[]},{"name":"transactionId","type":"`string`","description":"a string indicating the ID of the current transaction.","optional":true,"defaultValue":"","children":[]},{"name":"transactionManager","type":"`TManager`","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":"","children":[]}]}]} /> +", + "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": "", + "children": [ + { + "name": "order", + "type": "`object`", + "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": [] + }, + { + "name": "relations", + "type": "`string`[]", + "description": "An array of strings, each being relation names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "select", + "type": "(`string` \\| keyof `Entity`)[]", + "description": "An array of strings, each being attribute names of the entity to retrieve in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "skip", + "type": "`number`", + "description": "A number indicating the number of records to skip before retrieving the results.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "take", + "type": "`number`", + "description": "A number indicating the number of records to return in the result.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "withDeleted", + "type": "`boolean`", + "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": "", + "children": [] + } + ] + }, + { + "name": "sharedContext", + "type": "[`Context`](../../interfaces/Context.mdx)", + "description": "A context used to share resources, such as transaction manager, between the application and the module.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "enableNestedTransactions", + "type": "`boolean`", + "description": "a boolean value indicating whether nested transactions are enabled.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isolationLevel", + "type": "`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": "", + "children": [] + }, + { + "name": "manager", + "type": "`TManager`", + "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": "", + "children": [] + }, + { + "name": "transactionId", + "type": "`string`", + "description": "a string indicating the ID of the current transaction.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "transactionManager", + "type": "`TManager`", + "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": "", + "children": [] + } + ] + } +]} /> ## Returns -","optional":false,"defaultValue":"","description":"The retrieved rule type.","children":[{"name":"RuleTypeDTO","type":"`object`","description":"A rule type's data.","optional":false,"defaultValue":"","children":[{"name":"default_priority","type":"`number`","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":"","children":[]},{"name":"id","type":"`string`","description":"The ID of the rule type.","optional":false,"defaultValue":"","children":[]},{"name":"name","type":"`string`","description":"The display name of the rule type.","optional":false,"defaultValue":"","children":[]},{"name":"rule_attribute","type":"`string`","description":"The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The retrieved rule type.", + "children": [ + { + "name": "default_priority", + "type": "`number`", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The display name of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_attribute", + "type": "`string`", + "description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateCurrencies.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateCurrencies.mdx index f755a9d95b..57045b415e 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateCurrencies.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateCurrencies.mdx @@ -38,8 +38,150 @@ async function updateCurrencies () { ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"The list of updated currencies.","children":[{"name":"CurrencyDTO[]","type":"[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"CurrencyDTO","type":"`object`","description":"A currency's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of updated currencies.", + "children": [ + { + "name": "CurrencyDTO[]", + "type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "code", + "type": "`string`", + "description": "The code of the currency.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The name of the currency.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol", + "type": "`string`", + "description": "The symbol of the currency.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "symbol_native", + "type": "`string`", + "description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateMoneyAmounts.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateMoneyAmounts.mdx index ebbe6d1655..a309c9d551 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateMoneyAmounts.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateMoneyAmounts.mdx @@ -38,8 +38,174 @@ async function updateMoneyAmounts (moneyAmountId: string, amount: number) { ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"The list of updated money amounts.","children":[{"name":"MoneyAmountDTO[]","type":"[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"MoneyAmountDTO","type":"`object`","description":"A money amount's data. A money amount represents a price.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of updated money amounts.", + "children": [ + { + "name": "MoneyAmountDTO[]", + "type": "[`MoneyAmountDTO`](../../interfaces/MoneyAmountDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "amount", + "type": "`number`", + "description": "The price of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency", + "type": "[`CurrencyDTO`](../../interfaces/CurrencyDTO.mdx)", + "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string`", + "description": "The currency code of this money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "max_quantity", + "type": "`number`", + "description": "The maximum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "min_quantity", + "type": "`number`", + "description": "The minimum quantity required to be purchased for this price to be applied.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceRules.mdx index b0b25da300..da18a66531 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceRules.mdx @@ -41,8 +41,214 @@ async function updatePriceRules ( ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"The list of updated price rules.","children":[{"name":"PriceRuleDTO[]","type":"[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"PriceRuleDTO","type":"`object`","description":"A price rule's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of updated price rules.", + "children": [ + { + "name": "PriceRuleDTO[]", + "type": "[`PriceRuleDTO`](../../interfaces/PriceRuleDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price rule.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_list_id", + "type": "`string`", + "description": "The ID of the associated price list.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set", + "type": "[`PriceSetDTO`](../../interfaces/PriceSetDTO.mdx)", + "description": "The associated price set. It may only be available if the relation `price_set` is expanded.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_id", + "type": "`string`", + "description": "The ID of the associated price set.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_money_amount_id", + "type": "`string`", + "description": "The ID of the associated price set money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "priority", + "type": "`number`", + "description": "The priority of the price rule in comparison to other applicable price rules.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)", + "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type_id", + "type": "`string`", + "description": "The ID of the associated rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "The value of the price rule.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceSetMoneyAmountRules.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceSetMoneyAmountRules.mdx index 68f778959e..e5865b22ff 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceSetMoneyAmountRules.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updatePriceSetMoneyAmountRules.mdx @@ -38,8 +38,150 @@ async function updatePriceSetMoneyAmountRules (id: string, value: string) { ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"The list of updated price set money amount rules.","children":[{"name":"PriceSetMoneyAmountRulesDTO[]","type":"[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"PriceSetMoneyAmountRulesDTO","type":"`object`","description":"A price set money amount rule's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of updated price set money amount rules.", + "children": [ + { + "name": "PriceSetMoneyAmountRulesDTO[]", + "type": "[`PriceSetMoneyAmountRulesDTO`](../../interfaces/PriceSetMoneyAmountRulesDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "id", + "type": "`string`", + "description": "The ID of the price set money amount.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_money_amount", + "type": "[`PriceSetMoneyAmountDTO`](../../interfaces/PriceSetMoneyAmountDTO.mdx)", + "description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)", + "description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`", + "description": "The value of the price set money amount rule.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateRuleTypes.mdx b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateRuleTypes.mdx index f785fca1a4..2062930c09 100644 --- a/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateRuleTypes.mdx +++ b/www/apps/docs/content/references/pricing/IPricingModuleService/methods/IPricingModuleService.updateRuleTypes.mdx @@ -38,8 +38,150 @@ async function updateRuleTypes (ruleTypeId: string) { ## Parameters - + ## Returns -","optional":false,"defaultValue":"","description":"The list of updated rule types.","children":[{"name":"RuleTypeDTO[]","type":"[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]","optional":false,"defaultValue":"","description":"","children":[{"name":"RuleTypeDTO","type":"`object`","description":"A rule type's data.","optional":false,"defaultValue":"","children":[]}]}]}]} /> +", + "optional": false, + "defaultValue": "", + "description": "The list of updated rule types.", + "children": [ + { + "name": "RuleTypeDTO[]", + "type": "[`RuleTypeDTO`](../../interfaces/RuleTypeDTO.mdx)[]", + "optional": false, + "defaultValue": "", + "description": "", + "children": [ + { + "name": "default_priority", + "type": "`number`", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`", + "description": "The ID of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "The display name of the rule type.", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_attribute", + "type": "`string`", + "description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.", + "optional": false, + "defaultValue": "", + "children": [] + } + ] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/AddPricesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/AddPricesDTO.mdx index c68b155d4c..dc83f19868 100644 --- a/www/apps/docs/content/references/pricing/interfaces/AddPricesDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/AddPricesDTO.mdx @@ -10,4 +10,111 @@ The prices to add to a price set. ## Properties -","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":"","children":[]}]}]} /> +", + "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": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/AddRulesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/AddRulesDTO.mdx index 2e7f23b266..635458e525 100644 --- a/www/apps/docs/content/references/pricing/interfaces/AddRulesDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/AddRulesDTO.mdx @@ -10,4 +10,21 @@ The rules to add to a price set. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/BaseFilterable.mdx b/www/apps/docs/content/references/pricing/interfaces/BaseFilterable.mdx index 3f46618653..53bdbaa57d 100644 --- a/www/apps/docs/content/references/pricing/interfaces/BaseFilterable.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/BaseFilterable.mdx @@ -10,8 +10,34 @@ An object used to allow specifying flexible queries with and/or conditions. ## Type parameters - + ## Properties -)[]","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":"","children":[]},{"name":"$or","type":"(`T` \\| [`BaseFilterable`](BaseFilterable.mdx)<`T`\\>)[]","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":"","children":[]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "(`T` \\| [`BaseFilterable`](BaseFilterable.mdx)<`T`\\>)[]", + "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": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSetDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSetDTO.mdx index 5ee83b8010..346ae6dfc5 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSetDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSetDTO.mdx @@ -10,4 +10,45 @@ A calculated price set's data. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/Context.mdx b/www/apps/docs/content/references/pricing/interfaces/Context.mdx index 5b4fe874de..0af869ebe5 100644 --- a/www/apps/docs/content/references/pricing/interfaces/Context.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/Context.mdx @@ -12,8 +12,58 @@ A shared context object that is used to share resources between the application ## Type parameters - + ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/CreateCurrencyDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CreateCurrencyDTO.mdx index 0c150beaef..b3662ce4d8 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CreateCurrencyDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CreateCurrencyDTO.mdx @@ -10,4 +10,37 @@ A currency to create. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/CreateMoneyAmountDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CreateMoneyAmountDTO.mdx index 951d1f8f3b..ac0af79b04 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CreateMoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CreateMoneyAmountDTO.mdx @@ -10,4 +10,86 @@ The money amount to create. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/CreatePriceRuleDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CreatePriceRuleDTO.mdx index 74a3c3a958..b65b4d02d8 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CreatePriceRuleDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CreatePriceRuleDTO.mdx @@ -10,4 +10,61 @@ A price rule to create. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/CreatePriceSetDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CreatePriceSetDTO.mdx index 0ded32ad82..49e0f98cc6 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CreatePriceSetDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CreatePriceSetDTO.mdx @@ -10,4 +10,111 @@ A price set to create. ## Properties -","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":"","children":[]}]},{"name":"rules","type":"{ `rule_attribute`: `string` }[]","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":[]}]} /> +", + "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": "", + "children": [] + } + ] + }, + { + "name": "rules", + "type": "{ `rule_attribute`: `string` }[]", + "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": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/CreatePriceSetMoneyAmountRulesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CreatePriceSetMoneyAmountRulesDTO.mdx index a8ed93d24c..25907f2cbe 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CreatePriceSetMoneyAmountRulesDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CreatePriceSetMoneyAmountRulesDTO.mdx @@ -10,4 +10,29 @@ The price set money amount rule to create. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/CreatePricesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CreatePricesDTO.mdx index da06bfaef0..8c2f89445b 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CreatePricesDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CreatePricesDTO.mdx @@ -10,4 +10,94 @@ The prices to create part of a price set. ## Properties -","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":"","children":[]}]} /> +", + "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": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/CreateRuleTypeDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CreateRuleTypeDTO.mdx index f8bd19e6b4..0677b3d73a 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CreateRuleTypeDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CreateRuleTypeDTO.mdx @@ -10,4 +10,37 @@ The rule type to create. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/CurrencyDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/CurrencyDTO.mdx index e4f449e18f..1fd231be43 100644 --- a/www/apps/docs/content/references/pricing/interfaces/CurrencyDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/CurrencyDTO.mdx @@ -10,4 +10,37 @@ A currency's data. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/FilterableCurrencyProps.mdx b/www/apps/docs/content/references/pricing/interfaces/FilterableCurrencyProps.mdx index a58adb67b4..c9c6f7e408 100644 --- a/www/apps/docs/content/references/pricing/interfaces/FilterableCurrencyProps.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/FilterableCurrencyProps.mdx @@ -10,4 +10,29 @@ Filters to apply on a currency. ## Properties -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterableCurrencyProps`](FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableCurrencyProps`](FilterableCurrencyProps.mdx)\\>)[]","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":"","children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","children":[]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterableCurrencyProps`](FilterableCurrencyProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableCurrencyProps`](FilterableCurrencyProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "code", + "type": "`string`[]", + "description": "The codes to filter the currencies by.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/FilterableMoneyAmountProps.mdx b/www/apps/docs/content/references/pricing/interfaces/FilterableMoneyAmountProps.mdx index 024c5cb5a0..0388bf7b48 100644 --- a/www/apps/docs/content/references/pricing/interfaces/FilterableMoneyAmountProps.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/FilterableMoneyAmountProps.mdx @@ -10,4 +10,37 @@ Filters to apply on a money amount. ## Properties -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)\\>)[]","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":"","children":[]},{"name":"currency_code","type":"`string` \\| `string`[]","description":"Currency codes to filter money amounts by.","optional":true,"defaultValue":"","children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter money amounts by.","optional":true,"defaultValue":"","children":[]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string` \\| `string`[]", + "description": "Currency codes to filter money amounts by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "IDs to filter money amounts by.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/FilterablePriceRuleProps.mdx b/www/apps/docs/content/references/pricing/interfaces/FilterablePriceRuleProps.mdx index a5620ffaff..f2dd353301 100644 --- a/www/apps/docs/content/references/pricing/interfaces/FilterablePriceRuleProps.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/FilterablePriceRuleProps.mdx @@ -10,4 +10,53 @@ Filters to apply to price rules. ## Properties -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterablePriceRuleProps`](FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceRuleProps`](FilterablePriceRuleProps.mdx)\\>)[]","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":"","children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter price rules by.","optional":true,"defaultValue":"","children":[]},{"name":"name","type":"`string`[]","description":"The names to filter price rules by.","optional":true,"defaultValue":"","children":[]},{"name":"price_set_id","type":"`string`[]","description":"The IDs to filter the price rule's associated price set.","optional":true,"defaultValue":"","children":[]},{"name":"rule_type_id","type":"`string`[]","description":"The IDs to filter the price rule's associated rule type.","optional":true,"defaultValue":"","children":[]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterablePriceRuleProps`](FilterablePriceRuleProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceRuleProps`](FilterablePriceRuleProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "The IDs to filter price rules by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`[]", + "description": "The names to filter price rules by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_id", + "type": "`string`[]", + "description": "The IDs to filter the price rule's associated price set.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type_id", + "type": "`string`[]", + "description": "The IDs to filter the price rule's associated rule type.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx b/www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx index 4fec70eac4..f7b031b34a 100644 --- a/www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx @@ -10,4 +10,53 @@ Filters to apply on price set money amount rules. ## Properties -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterablePriceSetMoneyAmountRulesProps`](FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]","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":"","children":[]},{"name":"id","type":"`string`[]","description":"The ID to filter price set money amount rules by.","optional":true,"defaultValue":"","children":[]},{"name":"price_set_money_amount_id","type":"`string`[]","description":"The IDs to filter the price set money amount rule's associated price set money amount.","optional":true,"defaultValue":"","children":[]},{"name":"rule_type_id","type":"`string`[]","description":"The IDs to filter the price set money amount rule's associated rule type.","optional":true,"defaultValue":"","children":[]},{"name":"value","type":"`string`[]","description":"The value to filter price set money amount rules by.","optional":true,"defaultValue":"","children":[]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterablePriceSetMoneyAmountRulesProps`](FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountRulesProps`](FilterablePriceSetMoneyAmountRulesProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "The ID to filter price set money amount rules by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "price_set_money_amount_id", + "type": "`string`[]", + "description": "The IDs to filter the price set money amount rule's associated price set money amount.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_type_id", + "type": "`string`[]", + "description": "The IDs to filter the price set money amount rule's associated rule type.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "value", + "type": "`string`[]", + "description": "The value to filter price set money amount rules by.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetProps.mdx b/www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetProps.mdx index 7a1050e3da..3077cda3e8 100644 --- a/www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetProps.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetProps.mdx @@ -10,4 +10,70 @@ Filters to apply on price sets. ## Properties -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterablePriceSetProps`](FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetProps`](FilterablePriceSetProps.mdx)\\>)[]","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":"","children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter price sets by.","optional":true,"defaultValue":"","children":[]},{"name":"money_amounts","type":"[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)","description":"Filters to apply on a price set's associated money amounts.","optional":true,"defaultValue":"","children":[{"name":"$and","type":"([`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)\\>)[]","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":"","children":[]},{"name":"$or","type":"([`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)\\>)[]","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":"","children":[]},{"name":"currency_code","type":"`string` \\| `string`[]","description":"Currency codes to filter money amounts by.","optional":true,"defaultValue":"","children":[]},{"name":"id","type":"`string`[]","description":"IDs to filter money amounts by.","optional":true,"defaultValue":"","children":[]}]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterablePriceSetProps`](FilterablePriceSetProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetProps`](FilterablePriceSetProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "IDs to filter price sets by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "money_amounts", + "type": "[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)", + "description": "Filters to apply on a price set's associated money amounts.", + "optional": true, + "defaultValue": "", + "children": [ + { + "name": "$and", + "type": "([`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableMoneyAmountProps`](FilterableMoneyAmountProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "currency_code", + "type": "`string` \\| `string`[]", + "description": "Currency codes to filter money amounts by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "IDs to filter money amounts by.", + "optional": true, + "defaultValue": "", + "children": [] + } + ] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/FilterableRuleTypeProps.mdx b/www/apps/docs/content/references/pricing/interfaces/FilterableRuleTypeProps.mdx index ec6f56e2b7..156b8c3eca 100644 --- a/www/apps/docs/content/references/pricing/interfaces/FilterableRuleTypeProps.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/FilterableRuleTypeProps.mdx @@ -10,4 +10,45 @@ Filters to apply on rule types. ## Properties -)[]","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":"","children":[]},{"name":"$or","type":"([`FilterableRuleTypeProps`](FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableRuleTypeProps`](FilterableRuleTypeProps.mdx)\\>)[]","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":"","children":[]},{"name":"id","type":"`string`[]","description":"The IDs to filter rule types by.","optional":true,"defaultValue":"","children":[]},{"name":"name","type":"`string`[]","description":"The names to filter rule types by.","optional":true,"defaultValue":"","children":[]},{"name":"rule_attribute","type":"`string`[]","description":"The rule attributes to filter rule types by.","optional":true,"defaultValue":"","children":[]}]} /> +)[]", + "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": "", + "children": [] + }, + { + "name": "$or", + "type": "([`FilterableRuleTypeProps`](FilterableRuleTypeProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterableRuleTypeProps`](FilterableRuleTypeProps.mdx)\\>)[]", + "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": "", + "children": [] + }, + { + "name": "id", + "type": "`string`[]", + "description": "The IDs to filter rule types by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`[]", + "description": "The names to filter rule types by.", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "rule_attribute", + "type": "`string`[]", + "description": "The rule attributes to filter rule types by.", + "optional": true, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/FindConfig.mdx b/www/apps/docs/content/references/pricing/interfaces/FindConfig.mdx index e8fddb9d7d..8047f1b599 100644 --- a/www/apps/docs/content/references/pricing/interfaces/FindConfig.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/FindConfig.mdx @@ -11,8 +11,66 @@ which provides correct typing of field names in its properties. ## Type parameters - + ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfig.mdx b/www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfig.mdx index 4b55c30b78..cd0b59726e 100644 --- a/www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfig.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfig.mdx @@ -8,4 +8,61 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Properties -","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","children":[]},{"name":"extends","type":"{ `relationship`: [`JoinerRelationship`](../types/JoinerRelationship.mdx) ; `serviceName`: `string` }[]","description":"","optional":true,"defaultValue":"","children":[]},{"name":"fieldAlias","type":"Record<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\>","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })","optional":true,"defaultValue":"","children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":false,"defaultValue":"","children":[]},{"name":"relationships","type":"[`JoinerRelationship`](../types/JoinerRelationship.mdx)[]","description":"","optional":true,"defaultValue":"","children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","children":[]}]} /> +", + "description": "Extra arguments to pass to the remoteFetchData callback", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "extends", + "type": "{ `relationship`: [`JoinerRelationship`](../types/JoinerRelationship.mdx) ; `serviceName`: `string` }[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "fieldAlias", + "type": "Record<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\>", + "description": "alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "primaryKeys", + "type": "`string`[]", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "relationships", + "type": "[`JoinerRelationship`](../types/JoinerRelationship.mdx)[]", + "description": "", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "serviceName", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfigAlias.mdx b/www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfigAlias.mdx index 8fe4c19c9a..3921ec5bcc 100644 --- a/www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfigAlias.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfigAlias.mdx @@ -8,4 +8,21 @@ import ParameterTypes from "@site/src/components/ParameterTypes" ## Properties -","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","children":[]}]} /> +", + "description": "Extra arguments to pass to the remoteFetchData callback", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "name", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx index 84db9efa03..8c93a4d5cf 100644 --- a/www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx @@ -10,4 +10,86 @@ A money amount's data. A money amount represents a price. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx index 906036e565..e72d1d291d 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx @@ -10,4 +10,217 @@ A price rule's data. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx index 9eea88ae14..70310eb057 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx @@ -10,4 +10,144 @@ A price set's data. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx index 68d9254f80..eb01740eb1 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx @@ -10,4 +10,226 @@ A price set money amount's data. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx index 69cefc4aa6..9c89093a6c 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx @@ -10,4 +10,177 @@ A price set money amount rule's data. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/PricingContext.mdx b/www/apps/docs/content/references/pricing/interfaces/PricingContext.mdx index 8ffd5c43fb..4056284481 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PricingContext.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PricingContext.mdx @@ -10,4 +10,13 @@ The context to calculate prices. For example, you can specify the currency code ## Properties -","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":"","children":[]}]} /> +", + "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": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/interfaces/PricingFilters.mdx b/www/apps/docs/content/references/pricing/interfaces/PricingFilters.mdx index efc83d3fa4..e726781248 100644 --- a/www/apps/docs/content/references/pricing/interfaces/PricingFilters.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/PricingFilters.mdx @@ -10,4 +10,13 @@ Filters to apply on prices. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/RemovePriceSetRulesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/RemovePriceSetRulesDTO.mdx index 340b39d481..6a59eebd98 100644 --- a/www/apps/docs/content/references/pricing/interfaces/RemovePriceSetRulesDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/RemovePriceSetRulesDTO.mdx @@ -10,4 +10,21 @@ The rules to remove from a price set. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/RuleTypeDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/RuleTypeDTO.mdx index 9215c32c75..3eee5f23e9 100644 --- a/www/apps/docs/content/references/pricing/interfaces/RuleTypeDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/RuleTypeDTO.mdx @@ -10,4 +10,37 @@ A rule type's data. ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/UpdateCurrencyDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/UpdateCurrencyDTO.mdx index 3e9ea28a20..e0411f4aa3 100644 --- a/www/apps/docs/content/references/pricing/interfaces/UpdateCurrencyDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/UpdateCurrencyDTO.mdx @@ -10,4 +10,37 @@ The data to update in a currency. The `code` is used to identify which currency ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/UpdateMoneyAmountDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/UpdateMoneyAmountDTO.mdx index cea40e5fb3..f0008e0d90 100644 --- a/www/apps/docs/content/references/pricing/interfaces/UpdateMoneyAmountDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/UpdateMoneyAmountDTO.mdx @@ -12,4 +12,45 @@ The data to update in a money amount. The `id` is used to identify which money a ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/UpdatePriceRuleDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/UpdatePriceRuleDTO.mdx index baaf876073..24ef617d0b 100644 --- a/www/apps/docs/content/references/pricing/interfaces/UpdatePriceRuleDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/UpdatePriceRuleDTO.mdx @@ -10,4 +10,61 @@ The data to update in a price rule. The `id` is used to identify which money amo ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/UpdatePriceSetDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/UpdatePriceSetDTO.mdx index b7f3ff5b3b..cb56fba532 100644 --- a/www/apps/docs/content/references/pricing/interfaces/UpdatePriceSetDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/UpdatePriceSetDTO.mdx @@ -10,4 +10,13 @@ The data to update in a price set. The `id` is used to identify which price set ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/UpdatePriceSetMoneyAmountRulesDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/UpdatePriceSetMoneyAmountRulesDTO.mdx index 4fde6f899b..42ca3d9e54 100644 --- a/www/apps/docs/content/references/pricing/interfaces/UpdatePriceSetMoneyAmountRulesDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/UpdatePriceSetMoneyAmountRulesDTO.mdx @@ -10,4 +10,37 @@ The data to update in a price set money amount rule. The `id` is used to identif ## Properties - + diff --git a/www/apps/docs/content/references/pricing/interfaces/UpdateRuleTypeDTO.mdx b/www/apps/docs/content/references/pricing/interfaces/UpdateRuleTypeDTO.mdx index 27d08d36d9..4aeb3bb9bd 100644 --- a/www/apps/docs/content/references/pricing/interfaces/UpdateRuleTypeDTO.mdx +++ b/www/apps/docs/content/references/pricing/interfaces/UpdateRuleTypeDTO.mdx @@ -10,4 +10,37 @@ The data to update in a rule type. The `id` is used to identify which price set ## Properties - + diff --git a/www/apps/docs/content/references/pricing/types/Exclude.mdx b/www/apps/docs/content/references/pricing/types/Exclude.mdx index 6d550cd10a..929dc1c28b 100644 --- a/www/apps/docs/content/references/pricing/types/Exclude.mdx +++ b/www/apps/docs/content/references/pricing/types/Exclude.mdx @@ -12,4 +12,21 @@ Exclude from T those types that are assignable to U #### Type parameters - + diff --git a/www/apps/docs/content/references/pricing/types/JoinerRelationship.mdx b/www/apps/docs/content/references/pricing/types/JoinerRelationship.mdx index a90fd5bd2a..1f97a4b757 100644 --- a/www/apps/docs/content/references/pricing/types/JoinerRelationship.mdx +++ b/www/apps/docs/content/references/pricing/types/JoinerRelationship.mdx @@ -10,4 +10,69 @@ import ParameterTypes from "@site/src/components/ParameterTypes" #### Type declaration -","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","children":[]},{"name":"foreignKey","type":"`string`","description":"","optional":false,"defaultValue":"","children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","children":[]},{"name":"isInternalService","type":"`boolean`","description":"If true, the relationship is an internal service from the medusa core TODO: Remove when there are no more \"internal\" services","optional":true,"defaultValue":"","children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","children":[]},{"name":"primaryKey","type":"`string`","description":"","optional":false,"defaultValue":"","children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","children":[]}]} /> +", + "description": "Extra arguments to pass to the remoteFetchData callback", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "foreignKey", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "inverse", + "type": "`boolean`", + "description": "In an inverted relationship the foreign key is on the other service and the primary key is on the current service", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isInternalService", + "type": "`boolean`", + "description": "If true, the relationship is an internal service from the medusa core TODO: Remove when there are no more \"internal\" services", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "isList", + "type": "`boolean`", + "description": "Force the relationship to return a list", + "optional": true, + "defaultValue": "", + "children": [] + }, + { + "name": "primaryKey", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + }, + { + "name": "serviceName", + "type": "`string`", + "description": "", + "optional": false, + "defaultValue": "", + "children": [] + } +]} /> diff --git a/www/apps/docs/content/references/pricing/types/Omit.mdx b/www/apps/docs/content/references/pricing/types/Omit.mdx index d7af53cec1..b28ace515b 100644 --- a/www/apps/docs/content/references/pricing/types/Omit.mdx +++ b/www/apps/docs/content/references/pricing/types/Omit.mdx @@ -12,4 +12,21 @@ Construct a type with the properties of T except for those in type K. #### Type parameters - + diff --git a/www/apps/docs/content/references/pricing/types/Pick.mdx b/www/apps/docs/content/references/pricing/types/Pick.mdx index a851fa44c7..fbb62c7c08 100644 --- a/www/apps/docs/content/references/pricing/types/Pick.mdx +++ b/www/apps/docs/content/references/pricing/types/Pick.mdx @@ -12,4 +12,21 @@ From T, pick a set of properties whose keys are in the union K #### Type parameters - + diff --git a/www/apps/docs/content/references/pricing/types/Record.mdx b/www/apps/docs/content/references/pricing/types/Record.mdx index 7e960964ff..ed8ee521a3 100644 --- a/www/apps/docs/content/references/pricing/types/Record.mdx +++ b/www/apps/docs/content/references/pricing/types/Record.mdx @@ -12,4 +12,21 @@ Construct a type with a set of properties K of type T #### Type parameters - +