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

docs: enhance how references are generated (#5805)

Browse Source 
* adjusted configurations

* enhancements to tool and configurations

* change reference in docs

* fixed issue in workflows reference

* added project name

* more optimizations

* fix context error

* added a types reference

* resolved missing types

* fix reference reflection types not having children

* add an expand url parameter

* added new option to the README

* added details about new option
This commit is contained in:
Shahed Nasser authored and GitHub committed 2023-12-05 15:29:41 +02:00
1 parent a418e6cebc
commit 892d737c1f
4358 files changed
+947876 -534760
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/docs/content/references/pricing/interfaces/IPricingModuleService.mdx
-72
View File
@@ -1,72 +0,0 @@
---
displayed_sidebar: pricingReference
badge:
variant: orange
text: Beta
slug: /references/pricing
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# IPricingModuleService Reference
This section of the documentation provides a reference to the `IPricingModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Pricing Module.
## Methods
- [addPriceListPrices](../IPricingModuleService/methods/IPricingModuleService.addPriceListPrices.mdx)
- [addPrices](../IPricingModuleService/methods/IPricingModuleService.addPrices.mdx)
- [addRules](../IPricingModuleService/methods/IPricingModuleService.addRules.mdx)
- [calculatePrices](../IPricingModuleService/methods/IPricingModuleService.calculatePrices.mdx)
- [create](../IPricingModuleService/methods/IPricingModuleService.create.mdx)
- [createCurrencies](../IPricingModuleService/methods/IPricingModuleService.createCurrencies.mdx)
- [createMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.createMoneyAmounts.mdx)
- [createPriceListRules](../IPricingModuleService/methods/IPricingModuleService.createPriceListRules.mdx)
- [createPriceLists](../IPricingModuleService/methods/IPricingModuleService.createPriceLists.mdx)
- [createPriceRules](../IPricingModuleService/methods/IPricingModuleService.createPriceRules.mdx)
- [createPriceSetMoneyAmountRules](../IPricingModuleService/methods/IPricingModuleService.createPriceSetMoneyAmountRules.mdx)
- [createRuleTypes](../IPricingModuleService/methods/IPricingModuleService.createRuleTypes.mdx)
- [delete](../IPricingModuleService/methods/IPricingModuleService.delete.mdx)
- [deleteCurrencies](../IPricingModuleService/methods/IPricingModuleService.deleteCurrencies.mdx)
- [deleteMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.deleteMoneyAmounts.mdx)
- [deletePriceListRules](../IPricingModuleService/methods/IPricingModuleService.deletePriceListRules.mdx)
- [deletePriceLists](../IPricingModuleService/methods/IPricingModuleService.deletePriceLists.mdx)
- [deletePriceRules](../IPricingModuleService/methods/IPricingModuleService.deletePriceRules.mdx)
- [deletePriceSetMoneyAmountRules](../IPricingModuleService/methods/IPricingModuleService.deletePriceSetMoneyAmountRules.mdx)
- [deleteRuleTypes](../IPricingModuleService/methods/IPricingModuleService.deleteRuleTypes.mdx)
- [list](../IPricingModuleService/methods/IPricingModuleService.list.mdx)
- [listAndCount](../IPricingModuleService/methods/IPricingModuleService.listAndCount.mdx)
- [listAndCountCurrencies](../IPricingModuleService/methods/IPricingModuleService.listAndCountCurrencies.mdx)
- [listAndCountMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.listAndCountMoneyAmounts.mdx)
- [listAndCountPriceListRules](../IPricingModuleService/methods/IPricingModuleService.listAndCountPriceListRules.mdx)
- [listAndCountPriceLists](../IPricingModuleService/methods/IPricingModuleService.listAndCountPriceLists.mdx)
- [listAndCountPriceRules](../IPricingModuleService/methods/IPricingModuleService.listAndCountPriceRules.mdx)
- [listAndCountPriceSetMoneyAmountRules](../IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx)
- [listAndCountPriceSetMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx)
- [listAndCountRuleTypes](../IPricingModuleService/methods/IPricingModuleService.listAndCountRuleTypes.mdx)
- [listCurrencies](../IPricingModuleService/methods/IPricingModuleService.listCurrencies.mdx)
- [listMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.listMoneyAmounts.mdx)
- [listPriceListRules](../IPricingModuleService/methods/IPricingModuleService.listPriceListRules.mdx)
- [listPriceLists](../IPricingModuleService/methods/IPricingModuleService.listPriceLists.mdx)
- [listPriceRules](../IPricingModuleService/methods/IPricingModuleService.listPriceRules.mdx)
- [listPriceSetMoneyAmountRules](../IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmountRules.mdx)
- [listPriceSetMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmounts.mdx)
- [listRuleTypes](../IPricingModuleService/methods/IPricingModuleService.listRuleTypes.mdx)
- [removePriceListRules](../IPricingModuleService/methods/IPricingModuleService.removePriceListRules.mdx)
- [removeRules](../IPricingModuleService/methods/IPricingModuleService.removeRules.mdx)
- [retrieve](../IPricingModuleService/methods/IPricingModuleService.retrieve.mdx)
- [retrieveCurrency](../IPricingModuleService/methods/IPricingModuleService.retrieveCurrency.mdx)
- [retrieveMoneyAmount](../IPricingModuleService/methods/IPricingModuleService.retrieveMoneyAmount.mdx)
- [retrievePriceList](../IPricingModuleService/methods/IPricingModuleService.retrievePriceList.mdx)
- [retrievePriceListRule](../IPricingModuleService/methods/IPricingModuleService.retrievePriceListRule.mdx)
- [retrievePriceRule](../IPricingModuleService/methods/IPricingModuleService.retrievePriceRule.mdx)
- [retrievePriceSetMoneyAmountRules](../IPricingModuleService/methods/IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx)
- [retrieveRuleType](../IPricingModuleService/methods/IPricingModuleService.retrieveRuleType.mdx)
- [setPriceListRules](../IPricingModuleService/methods/IPricingModuleService.setPriceListRules.mdx)
- [updateCurrencies](../IPricingModuleService/methods/IPricingModuleService.updateCurrencies.mdx)
- [updateMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.updateMoneyAmounts.mdx)
- [updatePriceListRules](../IPricingModuleService/methods/IPricingModuleService.updatePriceListRules.mdx)
- [updatePriceLists](../IPricingModuleService/methods/IPricingModuleService.updatePriceLists.mdx)
- [updatePriceRules](../IPricingModuleService/methods/IPricingModuleService.updatePriceRules.mdx)
- [updatePriceSetMoneyAmountRules](../IPricingModuleService/methods/IPricingModuleService.updatePriceSetMoneyAmountRules.mdx)
- [updateRuleTypes](../IPricingModuleService/methods/IPricingModuleService.updateRuleTypes.mdx)
www/apps/docs/content/references/pricing/interfaces/AddPriceListPricesDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.AddPriceListPricesDTO.mdx
+2 -4
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The prices to be added to a price list.
## Properties
<ParameterTypes parameters={[
{
"name": "priceListId",
@@ -22,7 +20,7 @@ The prices to be added to a price list.
},
{
"name": "prices",
"type": "[PriceListPriceDTO](PriceListPriceDTO.mdx)[]",
"type": "[PriceListPriceDTO](pricing.PriceListPriceDTO.mdx)[]",
"description": "The prices to add.",
"optional": false,
"defaultValue": "",
@@ -39,7 +37,7 @@ The prices to be added to a price list.
},
{
"name": "currency",
"type": "[CreateCurrencyDTO](CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/AddPricesDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.AddPricesDTO.mdx
+2 -4
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The prices to add to a price set.
## Properties
<ParameterTypes parameters={[
{
"name": "priceSetId",
@@ -22,7 +20,7 @@ The prices to add to a price set.
},
{
"name": "prices",
"type": "[CreatePricesDTO](CreatePricesDTO.mdx)[]",
"type": "[CreatePricesDTO](pricing.CreatePricesDTO.mdx)[]",
"description": "The prices to add to the price set.",
"optional": false,
"defaultValue": "",
@@ -39,7 +37,7 @@ The prices to add to a price set.
},
{
"name": "currency",
"type": "[CreateCurrencyDTO](CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/AddRulesDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.AddRulesDTO.mdx
+1 -3
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The rules to add to a price set.
## Properties
<ParameterTypes parameters={[
{
"name": "priceSetId",
@@ -22,7 +20,7 @@ The rules to add to a price set.
},
{
"name": "rules",
"type": "``{ attribute: string }``[]",
"type": "`object`[]",
"description": "The rules to add to a price set.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/BaseFilterable.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.BaseFilterable.mdx
+2 -4
View File
@@ -22,12 +22,10 @@ An object used to allow specifying flexible queries with and/or conditions.
}
]} />
## Properties
<ParameterTypes parameters={[
{
"name": "$and",
"type": "(`T` \\| [BaseFilterable](BaseFilterable.mdx)&#60;T&#62;)[]",
"type": "(`T` \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;T&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -36,7 +34,7 @@ An object used to allow specifying flexible queries with and/or conditions.
},
{
"name": "$or",
"type": "(`T` \\| [BaseFilterable](BaseFilterable.mdx)&#60;T&#62;)[]",
"type": "(`T` \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;T&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSet.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.CalculatedPriceSet.mdx
+2 -4
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The calculated price for a specific price set and context.
## Properties
<ParameterTypes parameters={[
{
"name": "calculated_amount",
@@ -141,7 +139,7 @@ The calculated price for a specific price set and context.
{
"name": "is_calculated_price_price_list",
"type": "`boolean`",
"description": "Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found, the calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is `false`.",
"description": "Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found, \nthe calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is `false`.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -150,7 +148,7 @@ The calculated price for a specific price set and context.
{
"name": "is_original_price_price_list",
"type": "`boolean`",
"description": "Whether the original price is associated with a price list. During the calculation process, if the price list of the calculated price is of type override, the original price will be the same as the calculated price. In that case, the value of this property is `true`.",
"description": "Whether the original price is associated with a price list. During the calculation process, if the price list of the calculated price is of type override, \nthe original price will be the same as the calculated price. In that case, the value of this property is `true`.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/Context.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.Context.mdx
-2
View File
@@ -22,8 +22,6 @@ A shared context object that is used to share resources between the application
}
]} />
## Properties
<ParameterTypes parameters={[
{
"name": "enableNestedTransactions",
www/apps/docs/content/references/pricing/interfaces/CreateCurrencyDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.CreateCurrencyDTO.mdx
-2
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
A currency to create.
## Properties
<ParameterTypes parameters={[
{
"name": "code",
www/apps/docs/content/references/pricing/interfaces/CreateMoneyAmountDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.CreateMoneyAmountDTO.mdx
+1 -3
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The money amount to create.
## Properties
<ParameterTypes parameters={[
{
"name": "amount",
@@ -22,7 +20,7 @@ The money amount to create.
},
{
"name": "currency",
"type": "[CreateCurrencyDTO](CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/CreatePriceListDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.CreatePriceListDTO.mdx
+5 -7
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The price list to create.
## Properties
<ParameterTypes parameters={[
{
"name": "description",
@@ -40,7 +38,7 @@ The price list to create.
},
{
"name": "prices",
"type": "[PriceListPriceDTO](PriceListPriceDTO.mdx)[]",
"type": "[PriceListPriceDTO](pricing.PriceListPriceDTO.mdx)[]",
"description": "The prices associated with the price list.",
"optional": true,
"defaultValue": "",
@@ -57,7 +55,7 @@ The price list to create.
},
{
"name": "currency",
"type": "[CreateCurrencyDTO](CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
@@ -150,7 +148,7 @@ The price list to create.
},
{
"name": "rules",
"type": "[CreatePriceListRules](CreatePriceListRules.mdx)",
"type": "[CreatePriceListRules](pricing.CreatePriceListRules.mdx)",
"description": "The rules to be created and associated with the price list.",
"optional": true,
"defaultValue": "",
@@ -168,7 +166,7 @@ The price list to create.
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../enums/pricing.PriceListStatus.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
@@ -205,7 +203,7 @@ The price list to create.
},
{
"name": "type",
"type": "[PriceListType](../enums/PriceListType.mdx)",
"type": "[PriceListType](../enums/pricing.PriceListType.mdx)",
"description": "The price list's type.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/CreatePriceListRuleDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.CreatePriceListRuleDTO.mdx
+2 -4
View File
@@ -8,12 +8,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The price list rule to create.
## Properties
<ParameterTypes parameters={[
{
"name": "price_list",
"type": "`string` \\| [PriceListDTO](PriceListDTO.mdx)",
"type": "`string` \\| [PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The ID of a price list or the details of an existing price list to be associated with the price list rule.",
"optional": true,
"defaultValue": "",
@@ -31,7 +29,7 @@ The price list rule to create.
},
{
"name": "rule_type",
"type": "`string` \\| [RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "`string` \\| [RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The ID of a rule type or the details of an existing rule type to be associated with the price list rule.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/CreatePriceListRules.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.CreatePriceListRules.mdx
View File
File renamed without changes.
www/apps/docs/content/references/pricing/interfaces/CreatePriceRuleDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.CreatePriceRuleDTO.mdx
-2
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
A price rule to create.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
www/apps/docs/content/references/pricing/interfaces/CreatePriceSetDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.CreatePriceSetDTO.mdx
+3 -5
View File
@@ -8,12 +8,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
A price set to create.
## Properties
<ParameterTypes parameters={[
{
"name": "prices",
"type": "[CreatePricesDTO](CreatePricesDTO.mdx)[]",
"type": "[CreatePricesDTO](pricing.CreatePricesDTO.mdx)[]",
"description": "The prices to create and add to this price set.",
"optional": true,
"defaultValue": "",
@@ -30,7 +28,7 @@ A price set to create.
},
{
"name": "currency",
"type": "[CreateCurrencyDTO](CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
@@ -123,7 +121,7 @@ A price set to create.
},
{
"name": "rules",
"type": "``{ rule_attribute: string }``[]",
"type": "`object`[]",
"description": "The rules to associate with the price set.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/CreatePriceSetMoneyAmountRulesDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.CreatePriceSetMoneyAmountRulesDTO.mdx
-2
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The price set money amount rule to create.
## Properties
<ParameterTypes parameters={[
{
"name": "price_set_money_amount",
www/apps/docs/content/references/pricing/interfaces/CreatePricesDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.CreatePricesDTO.mdx
+1 -3
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The prices to create part of a price set.
## Properties
<ParameterTypes parameters={[
{
"name": "amount",
@@ -22,7 +20,7 @@ The prices to create part of a price set.
},
{
"name": "currency",
"type": "[CreateCurrencyDTO](CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/CreateRuleTypeDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.CreateRuleTypeDTO.mdx
+2 -4
View File
@@ -8,13 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The rule type to create.
## Properties
<ParameterTypes parameters={[
{
"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.",
"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. \nThe higher the value, the higher the priority of the rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -41,7 +39,7 @@ The rule type to create.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` \nmethod to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/CurrencyDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.CurrencyDTO.mdx
-2
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
A currency's data.
## Properties
<ParameterTypes parameters={[
{
"name": "code",
www/apps/docs/content/references/pricing/interfaces/FilterableCurrencyProps.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.FilterableCurrencyProps.mdx
+2 -4
View File
@@ -8,12 +8,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters to apply on a currency.
## Properties
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([FilterableCurrencyProps](FilterableCurrencyProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableCurrencyProps](FilterableCurrencyProps.mdx)&#62;)[]",
"type": "([FilterableCurrencyProps](pricing.FilterableCurrencyProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterableCurrencyProps](pricing.FilterableCurrencyProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +20,7 @@ Filters to apply on a currency.
},
{
"name": "$or",
"type": "([FilterableCurrencyProps](FilterableCurrencyProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableCurrencyProps](FilterableCurrencyProps.mdx)&#62;)[]",
"type": "([FilterableCurrencyProps](pricing.FilterableCurrencyProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterableCurrencyProps](pricing.FilterableCurrencyProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterableMoneyAmountProps.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.FilterableMoneyAmountProps.mdx
+2 -4
View File
@@ -8,12 +8,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters to apply on a money amount.
## Properties
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx)&#62;)[]",
"type": "([FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +20,7 @@ Filters to apply on a money amount.
},
{
"name": "$or",
"type": "([FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx)&#62;)[]",
"type": "([FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterablePriceListProps.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.FilterablePriceListProps.mdx
+3 -5
View File
@@ -8,12 +8,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters to apply on price lists.
## Properties
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([FilterablePriceListProps](FilterablePriceListProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceListProps](FilterablePriceListProps.mdx)&#62;)[]",
"type": "([FilterablePriceListProps](pricing.FilterablePriceListProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterablePriceListProps](pricing.FilterablePriceListProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +20,7 @@ Filters to apply on price lists.
},
{
"name": "$or",
"type": "([FilterablePriceListProps](FilterablePriceListProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceListProps](FilterablePriceListProps.mdx)&#62;)[]",
"type": "([FilterablePriceListProps](pricing.FilterablePriceListProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterablePriceListProps](pricing.FilterablePriceListProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
@@ -67,7 +65,7 @@ Filters to apply on price lists.
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)[]",
"type": "[PriceListStatus](../enums/pricing.PriceListStatus.mdx)[]",
"description": "The statuses to filter price lists by.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterablePriceListRuleProps.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.FilterablePriceListRuleProps.mdx
+2 -4
View File
@@ -8,12 +8,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters to apply on price list rules.
## Properties
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([FilterablePriceListRuleProps](FilterablePriceListRuleProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceListRuleProps](FilterablePriceListRuleProps.mdx)&#62;)[]",
"type": "([FilterablePriceListRuleProps](pricing.FilterablePriceListRuleProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterablePriceListRuleProps](pricing.FilterablePriceListRuleProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +20,7 @@ Filters to apply on price list rules.
},
{
"name": "$or",
"type": "([FilterablePriceListRuleProps](FilterablePriceListRuleProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceListRuleProps](FilterablePriceListRuleProps.mdx)&#62;)[]",
"type": "([FilterablePriceListRuleProps](pricing.FilterablePriceListRuleProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterablePriceListRuleProps](pricing.FilterablePriceListRuleProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterablePriceRuleProps.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.FilterablePriceRuleProps.mdx
+2 -4
View File
@@ -8,12 +8,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters to apply on price rules.
## Properties
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([FilterablePriceRuleProps](FilterablePriceRuleProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceRuleProps](FilterablePriceRuleProps.mdx)&#62;)[]",
"type": "([FilterablePriceRuleProps](pricing.FilterablePriceRuleProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterablePriceRuleProps](pricing.FilterablePriceRuleProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +20,7 @@ Filters to apply on price rules.
},
{
"name": "$or",
"type": "([FilterablePriceRuleProps](FilterablePriceRuleProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceRuleProps](FilterablePriceRuleProps.mdx)&#62;)[]",
"type": "([FilterablePriceRuleProps](pricing.FilterablePriceRuleProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterablePriceRuleProps](pricing.FilterablePriceRuleProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountProps.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.FilterablePriceSetMoneyAmountProps.mdx
+2 -4
View File
@@ -8,12 +8,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters to apply on price set money amounts.
## Properties
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([FilterablePriceSetMoneyAmountProps](FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountProps](FilterablePriceSetMoneyAmountProps.mdx)&#62;)[]",
"type": "([FilterablePriceSetMoneyAmountProps](pricing.FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountProps](pricing.FilterablePriceSetMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +20,7 @@ Filters to apply on price set money amounts.
},
{
"name": "$or",
"type": "([FilterablePriceSetMoneyAmountProps](FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountProps](FilterablePriceSetMoneyAmountProps.mdx)&#62;)[]",
"type": "([FilterablePriceSetMoneyAmountProps](pricing.FilterablePriceSetMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountProps](pricing.FilterablePriceSetMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.FilterablePriceSetMoneyAmountRulesProps.mdx
+2 -4
View File
@@ -8,12 +8,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters to apply on price set money amount rules.
## Properties
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([FilterablePriceSetMoneyAmountRulesProps](FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountRulesProps](FilterablePriceSetMoneyAmountRulesProps.mdx)&#62;)[]",
"type": "([FilterablePriceSetMoneyAmountRulesProps](pricing.FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountRulesProps](pricing.FilterablePriceSetMoneyAmountRulesProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +20,7 @@ Filters to apply on price set money amount rules.
},
{
"name": "$or",
"type": "([FilterablePriceSetMoneyAmountRulesProps](FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountRulesProps](FilterablePriceSetMoneyAmountRulesProps.mdx)&#62;)[]",
"type": "([FilterablePriceSetMoneyAmountRulesProps](pricing.FilterablePriceSetMoneyAmountRulesProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterablePriceSetMoneyAmountRulesProps](pricing.FilterablePriceSetMoneyAmountRulesProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetProps.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.FilterablePriceSetProps.mdx
+5 -7
View File
@@ -8,12 +8,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters to apply on price sets.
## Properties
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([FilterablePriceSetProps](FilterablePriceSetProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetProps](FilterablePriceSetProps.mdx)&#62;)[]",
"type": "([FilterablePriceSetProps](pricing.FilterablePriceSetProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterablePriceSetProps](pricing.FilterablePriceSetProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +20,7 @@ Filters to apply on price sets.
},
{
"name": "$or",
"type": "([FilterablePriceSetProps](FilterablePriceSetProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterablePriceSetProps](FilterablePriceSetProps.mdx)&#62;)[]",
"type": "([FilterablePriceSetProps](pricing.FilterablePriceSetProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterablePriceSetProps](pricing.FilterablePriceSetProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
@@ -40,7 +38,7 @@ Filters to apply on price sets.
},
{
"name": "money_amounts",
"type": "[FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx)",
"type": "[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)",
"description": "Filters to apply on a price set's associated money amounts.",
"optional": true,
"defaultValue": "",
@@ -48,7 +46,7 @@ Filters to apply on price sets.
"children": [
{
"name": "$and",
"type": "([FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx)&#62;)[]",
"type": "([FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -57,7 +55,7 @@ Filters to apply on price sets.
},
{
"name": "$or",
"type": "([FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](FilterableMoneyAmountProps.mdx)&#62;)[]",
"type": "([FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterableMoneyAmountProps](pricing.FilterableMoneyAmountProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterableRuleTypeProps.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.FilterableRuleTypeProps.mdx
+2 -4
View File
@@ -8,12 +8,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters to apply on rule types.
## Properties
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([FilterableRuleTypeProps](FilterableRuleTypeProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableRuleTypeProps](FilterableRuleTypeProps.mdx)&#62;)[]",
"type": "([FilterableRuleTypeProps](pricing.FilterableRuleTypeProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterableRuleTypeProps](pricing.FilterableRuleTypeProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
@@ -22,7 +20,7 @@ Filters to apply on rule types.
},
{
"name": "$or",
"type": "([FilterableRuleTypeProps](FilterableRuleTypeProps.mdx) \\| [BaseFilterable](BaseFilterable.mdx)&#60;[FilterableRuleTypeProps](FilterableRuleTypeProps.mdx)&#62;)[]",
"type": "([FilterableRuleTypeProps](pricing.FilterableRuleTypeProps.mdx) \\| [BaseFilterable](pricing.BaseFilterable.mdx)&#60;[FilterableRuleTypeProps](pricing.FilterableRuleTypeProps.mdx)&#62;)[]",
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FindConfig.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.FindConfig.mdx
+2 -4
View File
@@ -23,13 +23,11 @@ which provides correct typing of field names in its properties.
}
]} />
## Properties
<ParameterTypes parameters={[
{
"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.",
"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`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -74,7 +72,7 @@ which provides correct typing of field names in its properties.
{
"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.",
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/pricing.IPricingModuleService.mdx
+72
View File
@@ -0,0 +1,72 @@
---
displayed_sidebar: pricingReference
badge:
variant: orange
text: Beta
slug: /references/pricing
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# IPricingModuleService Reference
This section of the documentation provides a reference to the `IPricingModuleService` interface’s methods. This is the interface developers use to use the functionalities provided by the Pricing Module.
## Methods
- [addPriceListPrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices.mdx)
- [addPrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx)
- [addRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.addRules.mdx)
- [calculatePrices](../../IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices.mdx)
- [create](../../IPricingModuleService/methods/pricing.IPricingModuleService.create.mdx)
- [createCurrencies](../../IPricingModuleService/methods/pricing.IPricingModuleService.createCurrencies.mdx)
- [createMoneyAmounts](../../IPricingModuleService/methods/pricing.IPricingModuleService.createMoneyAmounts.mdx)
- [createPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceListRules.mdx)
- [createPriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceLists.mdx)
- [createPriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceRules.mdx)
- [createPriceSetMoneyAmountRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.createPriceSetMoneyAmountRules.mdx)
- [createRuleTypes](../../IPricingModuleService/methods/pricing.IPricingModuleService.createRuleTypes.mdx)
- [delete](../../IPricingModuleService/methods/pricing.IPricingModuleService.delete.mdx)
- [deleteCurrencies](../../IPricingModuleService/methods/pricing.IPricingModuleService.deleteCurrencies.mdx)
- [deleteMoneyAmounts](../../IPricingModuleService/methods/pricing.IPricingModuleService.deleteMoneyAmounts.mdx)
- [deletePriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceListRules.mdx)
- [deletePriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceLists.mdx)
- [deletePriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceRules.mdx)
- [deletePriceSetMoneyAmountRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.deletePriceSetMoneyAmountRules.mdx)
- [deleteRuleTypes](../../IPricingModuleService/methods/pricing.IPricingModuleService.deleteRuleTypes.mdx)
- [list](../../IPricingModuleService/methods/pricing.IPricingModuleService.list.mdx)
- [listAndCount](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCount.mdx)
- [listAndCountCurrencies](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountCurrencies.mdx)
- [listAndCountMoneyAmounts](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountMoneyAmounts.mdx)
- [listAndCountPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceListRules.mdx)
- [listAndCountPriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceLists.mdx)
- [listAndCountPriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceRules.mdx)
- [listAndCountPriceSetMoneyAmountRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx)
- [listAndCountPriceSetMoneyAmounts](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx)
- [listAndCountRuleTypes](../../IPricingModuleService/methods/pricing.IPricingModuleService.listAndCountRuleTypes.mdx)
- [listCurrencies](../../IPricingModuleService/methods/pricing.IPricingModuleService.listCurrencies.mdx)
- [listMoneyAmounts](../../IPricingModuleService/methods/pricing.IPricingModuleService.listMoneyAmounts.mdx)
- [listPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceListRules.mdx)
- [listPriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceLists.mdx)
- [listPriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceRules.mdx)
- [listPriceSetMoneyAmountRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmountRules.mdx)
- [listPriceSetMoneyAmounts](../../IPricingModuleService/methods/pricing.IPricingModuleService.listPriceSetMoneyAmounts.mdx)
- [listRuleTypes](../../IPricingModuleService/methods/pricing.IPricingModuleService.listRuleTypes.mdx)
- [removePriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.removePriceListRules.mdx)
- [removeRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.removeRules.mdx)
- [retrieve](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrieve.mdx)
- [retrieveCurrency](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveCurrency.mdx)
- [retrieveMoneyAmount](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveMoneyAmount.mdx)
- [retrievePriceList](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceList.mdx)
- [retrievePriceListRule](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceListRule.mdx)
- [retrievePriceRule](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceRule.mdx)
- [retrievePriceSetMoneyAmountRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrievePriceSetMoneyAmountRules.mdx)
- [retrieveRuleType](../../IPricingModuleService/methods/pricing.IPricingModuleService.retrieveRuleType.mdx)
- [setPriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.setPriceListRules.mdx)
- [updateCurrencies](../../IPricingModuleService/methods/pricing.IPricingModuleService.updateCurrencies.mdx)
- [updateMoneyAmounts](../../IPricingModuleService/methods/pricing.IPricingModuleService.updateMoneyAmounts.mdx)
- [updatePriceListRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceListRules.mdx)
- [updatePriceLists](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceLists.mdx)
- [updatePriceRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceRules.mdx)
- [updatePriceSetMoneyAmountRules](../../IPricingModuleService/methods/pricing.IPricingModuleService.updatePriceSetMoneyAmountRules.mdx)
- [updateRuleTypes](../../IPricingModuleService/methods/pricing.IPricingModuleService.updateRuleTypes.mdx)
www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfig.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.JoinerServiceConfig.mdx
+7 -9
View File
@@ -6,12 +6,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# JoinerServiceConfig
## Properties
<ParameterTypes parameters={[
{
"name": "alias",
"type": "[JoinerServiceConfigAlias](JoinerServiceConfigAlias.mdx) \\| [JoinerServiceConfigAlias](JoinerServiceConfigAlias.mdx)[]",
"type": "[JoinerServiceConfigAlias](pricing.JoinerServiceConfigAlias.mdx) \\| [JoinerServiceConfigAlias](pricing.JoinerServiceConfigAlias.mdx)[]",
"description": "Property name to use as entrypoint to the service",
"optional": true,
"defaultValue": "",
@@ -29,7 +27,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "extends",
"type": "``{ relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string }``[]",
"type": "`object`[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -37,7 +35,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"children": [
{
"name": "relationship",
"type": "[JoinerRelationship](../types/JoinerRelationship.mdx)",
"type": "[JoinerRelationship](../types/pricing.JoinerRelationship.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -82,7 +80,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"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",
"description": "If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -130,7 +128,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "fieldAlias",
"type": "`Record<string, string \\| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;>`",
"type": "`Record<string, string \\| object>`",
"description": "alias for deeper nested relationships (e.g. &#123; 'price': 'prices.calculated\\_price\\_set.amount' &#125;)",
"optional": true,
"defaultValue": "",
@@ -148,7 +146,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "relationships",
"type": "[JoinerRelationship](../types/JoinerRelationship.mdx)[]",
"type": "[JoinerRelationship](../types/pricing.JoinerRelationship.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -193,7 +191,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
{
"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",
"description": "If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfigAlias.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.JoinerServiceConfigAlias.mdx
-2
View File
@@ -6,8 +6,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# JoinerServiceConfigAlias
## Properties
<ParameterTypes parameters={[
{
"name": "args",
www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.MoneyAmountDTO.mdx
+18 -20
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
A money amount's data. A money amount represents a price.
## Properties
<ParameterTypes parameters={[
{
"name": "amount",
@@ -22,7 +20,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "currency",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](pricing.CurrencyDTO.mdx)",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
@@ -104,7 +102,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
@@ -121,7 +119,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "money_amount",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -138,7 +136,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "currency",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](pricing.CurrencyDTO.mdx)",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
@@ -183,7 +181,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
@@ -194,7 +192,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The price list associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -220,7 +218,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The associated money amounts.",
"optional": true,
"defaultValue": "",
@@ -238,7 +236,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "price_list_rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -247,7 +245,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "price_set_money_amounts",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]",
"description": "The associated price set money amounts.",
"optional": true,
"defaultValue": "",
@@ -256,7 +254,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The associated rule types.",
"optional": true,
"defaultValue": "",
@@ -265,7 +263,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -283,7 +281,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../enums/pricing.PriceListStatus.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
@@ -303,7 +301,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "price_rules",
"type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](pricing.PriceRuleDTO.mdx)[]",
"description": "The price rules associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -329,7 +327,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The associated price set.",
"optional": false,
"defaultValue": "",
@@ -365,7 +363,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -394,7 +392,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -411,7 +409,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -420,7 +418,7 @@ A money amount's data. A money amount represents a price.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/PriceListDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.PriceListDTO.mdx
+54 -56
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
A price list's details.
## Properties
<ParameterTypes parameters={[
{
"name": "ends_at",
@@ -31,7 +29,7 @@ A price list's details.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The associated money amounts.",
"optional": true,
"defaultValue": "",
@@ -48,7 +46,7 @@ A price list's details.
},
{
"name": "currency",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](pricing.CurrencyDTO.mdx)",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
@@ -130,7 +128,7 @@ A price list's details.
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
@@ -147,7 +145,7 @@ A price list's details.
},
{
"name": "money_amount",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -156,7 +154,7 @@ A price list's details.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The price list associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -165,7 +163,7 @@ A price list's details.
},
{
"name": "price_rules",
"type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](pricing.PriceRuleDTO.mdx)[]",
"description": "The price rules associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -174,7 +172,7 @@ A price list's details.
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -214,7 +212,7 @@ A price list's details.
},
{
"name": "price_list_rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -231,7 +229,7 @@ A price list's details.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The associated price list.",
"optional": false,
"defaultValue": "",
@@ -257,7 +255,7 @@ A price list's details.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The associated money amounts.",
"optional": true,
"defaultValue": "",
@@ -275,7 +273,7 @@ A price list's details.
},
{
"name": "price_list_rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -284,7 +282,7 @@ A price list's details.
},
{
"name": "price_set_money_amounts",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]",
"description": "The associated price set money amounts.",
"optional": true,
"defaultValue": "",
@@ -293,7 +291,7 @@ A price list's details.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The associated rule types.",
"optional": true,
"defaultValue": "",
@@ -302,7 +300,7 @@ A price list's details.
},
{
"name": "rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -320,7 +318,7 @@ A price list's details.
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../enums/pricing.PriceListStatus.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
@@ -340,7 +338,7 @@ A price list's details.
},
{
"name": "price_list_rule_values",
"type": "[PriceListRuleValueDTO](PriceListRuleValueDTO.mdx)[]",
"type": "[PriceListRuleValueDTO](pricing.PriceListRuleValueDTO.mdx)[]",
"description": "The associated rule values.",
"optional": true,
"defaultValue": "",
@@ -357,7 +355,7 @@ A price list's details.
},
{
"name": "price_list_rule",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)",
"description": "The associated price list rule.",
"optional": false,
"defaultValue": "",
@@ -377,7 +375,7 @@ A price list's details.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -386,7 +384,7 @@ A price list's details.
{
"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.",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -413,7 +411,7 @@ A price list's details.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -434,7 +432,7 @@ A price list's details.
},
{
"name": "price_set_money_amounts",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]",
"description": "The associated price set money amounts.",
"optional": true,
"defaultValue": "",
@@ -451,7 +449,7 @@ A price list's details.
},
{
"name": "money_amount",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -468,7 +466,7 @@ A price list's details.
},
{
"name": "currency",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](pricing.CurrencyDTO.mdx)",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
@@ -513,7 +511,7 @@ A price list's details.
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
@@ -524,7 +522,7 @@ A price list's details.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The price list associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -550,7 +548,7 @@ A price list's details.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The associated money amounts.",
"optional": true,
"defaultValue": "",
@@ -568,7 +566,7 @@ A price list's details.
},
{
"name": "price_list_rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -577,7 +575,7 @@ A price list's details.
},
{
"name": "price_set_money_amounts",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]",
"description": "The associated price set money amounts.",
"optional": true,
"defaultValue": "",
@@ -586,7 +584,7 @@ A price list's details.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The associated rule types.",
"optional": true,
"defaultValue": "",
@@ -595,7 +593,7 @@ A price list's details.
},
{
"name": "rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -613,7 +611,7 @@ A price list's details.
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../enums/pricing.PriceListStatus.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
@@ -633,7 +631,7 @@ A price list's details.
},
{
"name": "price_rules",
"type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](pricing.PriceRuleDTO.mdx)[]",
"description": "The price rules associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -659,7 +657,7 @@ A price list's details.
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The associated price set.",
"optional": false,
"defaultValue": "",
@@ -695,7 +693,7 @@ A price list's details.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -724,7 +722,7 @@ A price list's details.
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -741,7 +739,7 @@ A price list's details.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -750,7 +748,7 @@ A price list's details.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -781,7 +779,7 @@ A price list's details.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The associated rule types.",
"optional": true,
"defaultValue": "",
@@ -790,7 +788,7 @@ A price list's details.
{
"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.",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -817,7 +815,7 @@ A price list's details.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -827,7 +825,7 @@ A price list's details.
},
{
"name": "rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -844,7 +842,7 @@ A price list's details.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The associated price list.",
"optional": false,
"defaultValue": "",
@@ -870,7 +868,7 @@ A price list's details.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The associated money amounts.",
"optional": true,
"defaultValue": "",
@@ -888,7 +886,7 @@ A price list's details.
},
{
"name": "price_list_rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -897,7 +895,7 @@ A price list's details.
},
{
"name": "price_set_money_amounts",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]",
"description": "The associated price set money amounts.",
"optional": true,
"defaultValue": "",
@@ -906,7 +904,7 @@ A price list's details.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The associated rule types.",
"optional": true,
"defaultValue": "",
@@ -915,7 +913,7 @@ A price list's details.
},
{
"name": "rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -933,7 +931,7 @@ A price list's details.
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../enums/pricing.PriceListStatus.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
@@ -953,7 +951,7 @@ A price list's details.
},
{
"name": "price_list_rule_values",
"type": "[PriceListRuleValueDTO](PriceListRuleValueDTO.mdx)[]",
"type": "[PriceListRuleValueDTO](pricing.PriceListRuleValueDTO.mdx)[]",
"description": "The associated rule values.",
"optional": true,
"defaultValue": "",
@@ -970,7 +968,7 @@ A price list's details.
},
{
"name": "price_list_rule",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)",
"description": "The associated price list rule.",
"optional": false,
"defaultValue": "",
@@ -990,7 +988,7 @@ A price list's details.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -999,7 +997,7 @@ A price list's details.
{
"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.",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -1026,7 +1024,7 @@ A price list's details.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -1056,7 +1054,7 @@ A price list's details.
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../enums/pricing.PriceListStatus.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/PriceListPriceDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.PriceListPriceDTO.mdx
+1 -3
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The prices associated with a price list.
## Properties
<ParameterTypes parameters={[
{
"name": "amount",
@@ -22,7 +20,7 @@ The prices associated with a price list.
},
{
"name": "currency",
"type": "[CreateCurrencyDTO](CreateCurrencyDTO.mdx)",
"type": "[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/PriceListRuleDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.PriceListRuleDTO.mdx
+29 -31
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The price list rule's details.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
@@ -22,7 +20,7 @@ The price list rule's details.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The associated price list.",
"optional": false,
"defaultValue": "",
@@ -48,7 +46,7 @@ The price list rule's details.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The associated money amounts.",
"optional": true,
"defaultValue": "",
@@ -65,7 +63,7 @@ The price list rule's details.
},
{
"name": "currency",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](pricing.CurrencyDTO.mdx)",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
@@ -110,7 +108,7 @@ The price list rule's details.
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
@@ -130,7 +128,7 @@ The price list rule's details.
},
{
"name": "price_list_rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -147,7 +145,7 @@ The price list rule's details.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The associated price list.",
"optional": false,
"defaultValue": "",
@@ -156,7 +154,7 @@ The price list rule's details.
},
{
"name": "price_list_rule_values",
"type": "[PriceListRuleValueDTO](PriceListRuleValueDTO.mdx)[]",
"type": "[PriceListRuleValueDTO](pricing.PriceListRuleValueDTO.mdx)[]",
"description": "The associated rule values.",
"optional": true,
"defaultValue": "",
@@ -165,7 +163,7 @@ The price list rule's details.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -185,7 +183,7 @@ The price list rule's details.
},
{
"name": "price_set_money_amounts",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]",
"description": "The associated price set money amounts.",
"optional": true,
"defaultValue": "",
@@ -202,7 +200,7 @@ The price list rule's details.
},
{
"name": "money_amount",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -211,7 +209,7 @@ The price list rule's details.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The price list associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -220,7 +218,7 @@ The price list rule's details.
},
{
"name": "price_rules",
"type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](pricing.PriceRuleDTO.mdx)[]",
"description": "The price rules associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -229,7 +227,7 @@ The price list rule's details.
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -258,7 +256,7 @@ The price list rule's details.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The associated rule types.",
"optional": true,
"defaultValue": "",
@@ -267,7 +265,7 @@ The price list rule's details.
{
"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.",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -294,7 +292,7 @@ The price list rule's details.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -304,7 +302,7 @@ The price list rule's details.
},
{
"name": "rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -321,7 +319,7 @@ The price list rule's details.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The associated price list.",
"optional": false,
"defaultValue": "",
@@ -330,7 +328,7 @@ The price list rule's details.
},
{
"name": "price_list_rule_values",
"type": "[PriceListRuleValueDTO](PriceListRuleValueDTO.mdx)[]",
"type": "[PriceListRuleValueDTO](pricing.PriceListRuleValueDTO.mdx)[]",
"description": "The associated rule values.",
"optional": true,
"defaultValue": "",
@@ -339,7 +337,7 @@ The price list rule's details.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -368,7 +366,7 @@ The price list rule's details.
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../enums/pricing.PriceListStatus.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
@@ -407,7 +405,7 @@ The price list rule's details.
},
{
"name": "price_list_rule_values",
"type": "[PriceListRuleValueDTO](PriceListRuleValueDTO.mdx)[]",
"type": "[PriceListRuleValueDTO](pricing.PriceListRuleValueDTO.mdx)[]",
"description": "The associated rule values.",
"optional": true,
"defaultValue": "",
@@ -424,7 +422,7 @@ The price list rule's details.
},
{
"name": "price_list_rule",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)",
"description": "The associated price list rule.",
"optional": false,
"defaultValue": "",
@@ -441,7 +439,7 @@ The price list rule's details.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The associated price list.",
"optional": false,
"defaultValue": "",
@@ -450,7 +448,7 @@ The price list rule's details.
},
{
"name": "price_list_rule_values",
"type": "[PriceListRuleValueDTO](PriceListRuleValueDTO.mdx)[]",
"type": "[PriceListRuleValueDTO](pricing.PriceListRuleValueDTO.mdx)[]",
"description": "The associated rule values.",
"optional": true,
"defaultValue": "",
@@ -459,7 +457,7 @@ The price list rule's details.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -490,7 +488,7 @@ The price list rule's details.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -499,7 +497,7 @@ The price list rule's details.
{
"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.",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -526,7 +524,7 @@ The price list rule's details.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/PriceListRuleValueDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.PriceListRuleValueDTO.mdx
+13 -15
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The price list rule value's details.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
@@ -22,7 +20,7 @@ The price list rule value's details.
},
{
"name": "price_list_rule",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)",
"description": "The associated price list rule.",
"optional": false,
"defaultValue": "",
@@ -39,7 +37,7 @@ The price list rule value's details.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The associated price list.",
"optional": false,
"defaultValue": "",
@@ -65,7 +63,7 @@ The price list rule value's details.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The associated money amounts.",
"optional": true,
"defaultValue": "",
@@ -83,7 +81,7 @@ The price list rule value's details.
},
{
"name": "price_list_rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -92,7 +90,7 @@ The price list rule value's details.
},
{
"name": "price_set_money_amounts",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]",
"description": "The associated price set money amounts.",
"optional": true,
"defaultValue": "",
@@ -101,7 +99,7 @@ The price list rule value's details.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The associated rule types.",
"optional": true,
"defaultValue": "",
@@ -110,7 +108,7 @@ The price list rule value's details.
},
{
"name": "rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -128,7 +126,7 @@ The price list rule value's details.
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../enums/pricing.PriceListStatus.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
@@ -148,7 +146,7 @@ The price list rule value's details.
},
{
"name": "price_list_rule_values",
"type": "[PriceListRuleValueDTO](PriceListRuleValueDTO.mdx)[]",
"type": "[PriceListRuleValueDTO](pricing.PriceListRuleValueDTO.mdx)[]",
"description": "The associated rule values.",
"optional": true,
"defaultValue": "",
@@ -165,7 +163,7 @@ The price list rule value's details.
},
{
"name": "price_list_rule",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)",
"description": "The associated price list rule.",
"optional": false,
"defaultValue": "",
@@ -185,7 +183,7 @@ The price list rule value's details.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -194,7 +192,7 @@ The price list rule value's details.
{
"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.",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -221,7 +219,7 @@ The price list rule value's details.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.PriceRuleDTO.mdx
+10 -12
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
A price rule's data.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
@@ -31,7 +29,7 @@ A price rule's data.
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The associated price set.",
"optional": false,
"defaultValue": "",
@@ -48,7 +46,7 @@ A price rule's data.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -65,7 +63,7 @@ A price rule's data.
},
{
"name": "currency",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](pricing.CurrencyDTO.mdx)",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
@@ -110,7 +108,7 @@ A price rule's data.
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
@@ -121,7 +119,7 @@ A price rule's data.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -130,7 +128,7 @@ A price rule's data.
{
"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.",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -157,7 +155,7 @@ A price rule's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -196,7 +194,7 @@ A price rule's data.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -205,7 +203,7 @@ A price rule's data.
{
"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.",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -232,7 +230,7 @@ A price rule's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.PriceSetDTO.mdx
+10 -12
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
A price set's data.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
@@ -22,7 +20,7 @@ A price set's data.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -39,7 +37,7 @@ A price set's data.
},
{
"name": "currency",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](pricing.CurrencyDTO.mdx)",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
@@ -121,7 +119,7 @@ A price set's data.
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
@@ -138,7 +136,7 @@ A price set's data.
},
{
"name": "money_amount",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -147,7 +145,7 @@ A price set's data.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The price list associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -156,7 +154,7 @@ A price set's data.
},
{
"name": "price_rules",
"type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](pricing.PriceRuleDTO.mdx)[]",
"description": "The price rules associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -165,7 +163,7 @@ A price set's data.
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -196,7 +194,7 @@ A price set's data.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -205,7 +203,7 @@ A price set's data.
{
"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.",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -232,7 +230,7 @@ A price set's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.PriceSetMoneyAmountDTO.mdx
+42 -44
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
A price set money amount's data.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
@@ -22,7 +20,7 @@ A price set money amount's data.
},
{
"name": "money_amount",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -39,7 +37,7 @@ A price set money amount's data.
},
{
"name": "currency",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](pricing.CurrencyDTO.mdx)",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
@@ -121,7 +119,7 @@ A price set money amount's data.
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
@@ -138,7 +136,7 @@ A price set money amount's data.
},
{
"name": "money_amount",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -147,7 +145,7 @@ A price set money amount's data.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The price list associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -156,7 +154,7 @@ A price set money amount's data.
},
{
"name": "price_rules",
"type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](pricing.PriceRuleDTO.mdx)[]",
"description": "The price rules associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -165,7 +163,7 @@ A price set money amount's data.
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -196,7 +194,7 @@ A price set money amount's data.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The price list associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -222,7 +220,7 @@ A price set money amount's data.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The associated money amounts.",
"optional": true,
"defaultValue": "",
@@ -239,7 +237,7 @@ A price set money amount's data.
},
{
"name": "currency",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](pricing.CurrencyDTO.mdx)",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
@@ -284,7 +282,7 @@ A price set money amount's data.
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
@@ -304,7 +302,7 @@ A price set money amount's data.
},
{
"name": "price_list_rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -321,7 +319,7 @@ A price set money amount's data.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The associated price list.",
"optional": false,
"defaultValue": "",
@@ -330,7 +328,7 @@ A price set money amount's data.
},
{
"name": "price_list_rule_values",
"type": "[PriceListRuleValueDTO](PriceListRuleValueDTO.mdx)[]",
"type": "[PriceListRuleValueDTO](pricing.PriceListRuleValueDTO.mdx)[]",
"description": "The associated rule values.",
"optional": true,
"defaultValue": "",
@@ -339,7 +337,7 @@ A price set money amount's data.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -359,7 +357,7 @@ A price set money amount's data.
},
{
"name": "price_set_money_amounts",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]",
"description": "The associated price set money amounts.",
"optional": true,
"defaultValue": "",
@@ -376,7 +374,7 @@ A price set money amount's data.
},
{
"name": "money_amount",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -385,7 +383,7 @@ A price set money amount's data.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The price list associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -394,7 +392,7 @@ A price set money amount's data.
},
{
"name": "price_rules",
"type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](pricing.PriceRuleDTO.mdx)[]",
"description": "The price rules associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -403,7 +401,7 @@ A price set money amount's data.
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -432,7 +430,7 @@ A price set money amount's data.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The associated rule types.",
"optional": true,
"defaultValue": "",
@@ -441,7 +439,7 @@ A price set money amount's data.
{
"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.",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -468,7 +466,7 @@ A price set money amount's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -478,7 +476,7 @@ A price set money amount's data.
},
{
"name": "rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -495,7 +493,7 @@ A price set money amount's data.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The associated price list.",
"optional": false,
"defaultValue": "",
@@ -504,7 +502,7 @@ A price set money amount's data.
},
{
"name": "price_list_rule_values",
"type": "[PriceListRuleValueDTO](PriceListRuleValueDTO.mdx)[]",
"type": "[PriceListRuleValueDTO](pricing.PriceListRuleValueDTO.mdx)[]",
"description": "The associated rule values.",
"optional": true,
"defaultValue": "",
@@ -513,7 +511,7 @@ A price set money amount's data.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -542,7 +540,7 @@ A price set money amount's data.
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../enums/pricing.PriceListStatus.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
@@ -581,7 +579,7 @@ A price set money amount's data.
},
{
"name": "price_rules",
"type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](pricing.PriceRuleDTO.mdx)[]",
"description": "The price rules associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -607,7 +605,7 @@ A price set money amount's data.
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The associated price set.",
"optional": false,
"defaultValue": "",
@@ -624,7 +622,7 @@ A price set money amount's data.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -633,7 +631,7 @@ A price set money amount's data.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -671,7 +669,7 @@ A price set money amount's data.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -680,7 +678,7 @@ A price set money amount's data.
{
"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.",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -707,7 +705,7 @@ A price set money amount's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -737,7 +735,7 @@ A price set money amount's data.
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -754,7 +752,7 @@ A price set money amount's data.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -771,7 +769,7 @@ A price set money amount's data.
},
{
"name": "currency",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](pricing.CurrencyDTO.mdx)",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
@@ -816,7 +814,7 @@ A price set money amount's data.
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
@@ -827,7 +825,7 @@ A price set money amount's data.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -836,7 +834,7 @@ A price set money amount's data.
{
"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.",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -863,7 +861,7 @@ A price set money amount's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.PriceSetMoneyAmountRulesDTO.mdx
+20 -22
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
A price set money amount rule's data.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
@@ -22,7 +20,7 @@ A price set money amount rule's data.
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)",
"description": "The associated price set money amount.",
"optional": false,
"defaultValue": "",
@@ -39,7 +37,7 @@ A price set money amount rule's data.
},
{
"name": "money_amount",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -56,7 +54,7 @@ A price set money amount rule's data.
},
{
"name": "currency",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"type": "[CurrencyDTO](pricing.CurrencyDTO.mdx)",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
@@ -101,7 +99,7 @@ A price set money amount rule's data.
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
@@ -112,7 +110,7 @@ A price set money amount rule's data.
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"type": "[PriceListDTO](pricing.PriceListDTO.mdx)",
"description": "The price list associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -138,7 +136,7 @@ A price set money amount rule's data.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The associated money amounts.",
"optional": true,
"defaultValue": "",
@@ -156,7 +154,7 @@ A price set money amount rule's data.
},
{
"name": "price_list_rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -165,7 +163,7 @@ A price set money amount rule's data.
},
{
"name": "price_set_money_amounts",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]",
"type": "[PriceSetMoneyAmountDTO](pricing.PriceSetMoneyAmountDTO.mdx)[]",
"description": "The associated price set money amounts.",
"optional": true,
"defaultValue": "",
@@ -174,7 +172,7 @@ A price set money amount rule's data.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The associated rule types.",
"optional": true,
"defaultValue": "",
@@ -183,7 +181,7 @@ A price set money amount rule's data.
},
{
"name": "rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"type": "[PriceListRuleDTO](pricing.PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
@@ -201,7 +199,7 @@ A price set money amount rule's data.
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../enums/pricing.PriceListStatus.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
@@ -221,7 +219,7 @@ A price set money amount rule's data.
},
{
"name": "price_rules",
"type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]",
"type": "[PriceRuleDTO](pricing.PriceRuleDTO.mdx)[]",
"description": "The price rules associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -247,7 +245,7 @@ A price set money amount rule's data.
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The associated price set.",
"optional": false,
"defaultValue": "",
@@ -283,7 +281,7 @@ A price set money amount rule's data.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -312,7 +310,7 @@ A price set money amount rule's data.
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"type": "[PriceSetDTO](pricing.PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount.",
"optional": true,
"defaultValue": "",
@@ -329,7 +327,7 @@ A price set money amount rule's data.
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"type": "[MoneyAmountDTO](pricing.MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
@@ -338,7 +336,7 @@ A price set money amount rule's data.
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
@@ -369,7 +367,7 @@ A price set money amount rule's data.
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"type": "[RuleTypeDTO](pricing.RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
@@ -378,7 +376,7 @@ A price set money amount rule's data.
{
"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.",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -405,7 +403,7 @@ A price set money amount rule's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/PricingContext.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.PricingContext.mdx
+1 -3
View File
@@ -8,13 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The context to calculate prices. For example, you can specify the currency code to calculate prices in.
## Properties
<ParameterTypes parameters={[
{
"name": "context",
"type": "`Record<string, string \\| number>`",
"description": "an object whose keys are the name of the context attribute. Its value can be a string or a number. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in. Another example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.",
"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.\nAnother example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/PricingFilters.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.PricingFilters.mdx
-2
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Filters to apply on prices.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
www/apps/docs/content/references/pricing/interfaces/RemovePriceListRulesDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.RemovePriceListRulesDTO.mdx
-2
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The rules to remove from a price list.
## Properties
<ParameterTypes parameters={[
{
"name": "priceListId",
www/apps/docs/content/references/pricing/interfaces/RemovePriceSetRulesDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.RemovePriceSetRulesDTO.mdx
-2
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The rules to remove from a price set.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
www/apps/docs/content/references/pricing/interfaces/RuleTypeDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.RuleTypeDTO.mdx
+2 -4
View File
@@ -8,13 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
A rule type's data.
## Properties
<ParameterTypes parameters={[
{
"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.",
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
@@ -41,7 +39,7 @@ A rule type's data.
{
"name": "rule_attribute",
"type": "`string`",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of \nthe `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/SetPriceListRulesDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.SetPriceListRulesDTO.mdx
+1 -3
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The rules to add to a price list.
## Properties
<ParameterTypes parameters={[
{
"name": "priceListId",
@@ -23,7 +21,7 @@ The rules to add to a price list.
{
"name": "rules",
"type": "`Record<string, string \\| string[]>`",
"description": "The rules to add to the price list. Each key of the object is a rule type's `rule_attribute`, and its value is the value(s) of the rule.",
"description": "The rules to add to the price list. Each key of the object is a rule type's `rule_attribute`, and its value\nis the value(s) of the rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/pricing/interfaces/UpdateCurrencyDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.UpdateCurrencyDTO.mdx
-2
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The data to update in a currency. The `code` is used to identify which currency to update.
## Properties
<ParameterTypes parameters={[
{
"name": "code",
www/apps/docs/content/references/pricing/interfaces/UpdateMoneyAmountDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.UpdateMoneyAmountDTO.mdx
-2
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The data to update in a money amount. The `id` is used to identify which money amount to update.
## Properties
<ParameterTypes parameters={[
{
"name": "amount",
www/apps/docs/content/references/pricing/interfaces/UpdatePriceListDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.UpdatePriceListDTO.mdx
+2 -4
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The attributes to update in a price list.
## Properties
<ParameterTypes parameters={[
{
"name": "ends_at",
@@ -40,7 +38,7 @@ The attributes to update in a price list.
},
{
"name": "rules",
"type": "[CreatePriceListRules](CreatePriceListRules.mdx)",
"type": "[CreatePriceListRules](pricing.CreatePriceListRules.mdx)",
"description": "The rules to be created and associated with the price list.",
"optional": true,
"defaultValue": "",
@@ -58,7 +56,7 @@ The attributes to update in a price list.
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"type": "[PriceListStatus](../enums/pricing.PriceListStatus.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/UpdatePriceListRuleDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.UpdatePriceListRuleDTO.mdx
-2
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The attributes to update in a price list rule.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
www/apps/docs/content/references/pricing/interfaces/UpdatePriceRuleDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.UpdatePriceRuleDTO.mdx
-2
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The data to update in a price rule. The `id` is used to identify which money amount to update.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
www/apps/docs/content/references/pricing/interfaces/UpdatePriceSetDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.UpdatePriceSetDTO.mdx
-2
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The data to update in a price set. The `id` is used to identify which price set to update.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
www/apps/docs/content/references/pricing/interfaces/UpdatePriceSetMoneyAmountRulesDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.UpdatePriceSetMoneyAmountRulesDTO.mdx
-2
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The data to update in a price set money amount rule. The `id` is used to identify which money amount to update.
## Properties
<ParameterTypes parameters={[
{
"name": "id",
www/apps/docs/content/references/pricing/interfaces/UpdateRuleTypeDTO.mdx → www/apps/docs/content/references/pricing/interfaces/pricing.UpdateRuleTypeDTO.mdx
-2
View File
@@ -8,8 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
The data to update in a rule type. The `id` is used to identify which price set to update.
## Properties
<ParameterTypes parameters={[
{
"name": "default_priority",