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

chore(docs): Generated References (#5602)

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

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]Oli JuhlShahed Nasser
 authored and GitHub committed 2023-11-10 17:31:02 +00:00
1 parent 5f4317b9d7
commit 39649b3552
2110 files changed
+148777 -4448445
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/docs/content/references/pricing/interfaces/AddPricesDTO.mdx
+13
View File
@@ -17,6 +17,7 @@ The prices to add to a price set.
"description": "The ID of the price set to add prices to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ The prices to add to a price set.
"description": "The prices to add to the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -32,6 +34,7 @@ The prices to add to a price set.
"description": "The amount of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -40,6 +43,7 @@ The prices to add to a price set.
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "code",
@@ -47,6 +51,7 @@ The prices to add to a price set.
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -55,6 +60,7 @@ The prices to add to a price set.
"description": "The name of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -63,6 +69,7 @@ The prices to add to a price set.
"description": "The symbol of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -71,6 +78,7 @@ The prices to add to a price set.
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -81,6 +89,7 @@ The prices to add to a price set.
"description": "The currency code of this money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -89,6 +98,7 @@ The prices to add to a price set.
"description": "The ID of the money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -97,6 +107,7 @@ The prices to add to a price set.
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -105,6 +116,7 @@ The prices to add to a price set.
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -113,6 +125,7 @@ The prices to add to a price set.
"description": "The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/interfaces/AddRulesDTO.mdx
+13 -1
View File
@@ -17,6 +17,7 @@ The rules to add to a price set.
"description": "The ID of the price set to add the rules to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,17 @@ The rules to add to a price set.
"description": "The rules to add to a price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.",
"optional": false,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "attribute",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]} />
www/apps/docs/content/references/pricing/interfaces/BaseFilterable.mdx
+3
View File
@@ -17,6 +17,7 @@ An object used to allow specifying flexible queries with and/or conditions.
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
@@ -30,6 +31,7 @@ An object used to allow specifying flexible queries with and/or conditions.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -38,6 +40,7 @@ An object used to allow specifying flexible queries with and/or conditions.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSetDTO.mdx
+5
View File
@@ -17,6 +17,7 @@ A calculated price set's data.
"description": "The calculated amount. It can possibly be `null` if there's no price set up for the provided context.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ A calculated price set's data.
"description": "The currency code of the calculated price. It can possibly be `null`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ A calculated price set's data.
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ A calculated price set's data.
"description": "The maximum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -49,6 +53,7 @@ A calculated price set's data.
"description": "The minimum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/Context.mdx
+6
View File
@@ -19,6 +19,7 @@ A shared context object that is used to share resources between the application
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
@@ -32,6 +33,7 @@ A shared context object that is used to share resources between the application
"description": "a boolean value indicating whether nested transactions are enabled.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -40,6 +42,7 @@ A shared context object that is used to share resources between the application
"description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -48,6 +51,7 @@ A shared context object that is used to share resources between the application
"description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -56,6 +60,7 @@ A shared context object that is used to share resources between the application
"description": "a string indicating the ID of the current transaction.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -64,6 +69,7 @@ A shared context object that is used to share resources between the application
"description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/CreateCurrencyDTO.mdx
+4
View File
@@ -17,6 +17,7 @@ A currency to create.
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ A currency to create.
"description": "The name of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ A currency to create.
"description": "The symbol of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ A currency to create.
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/CreateMoneyAmountDTO.mdx
+10
View File
@@ -17,6 +17,7 @@ The money amount to create.
"description": "The amount of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ The money amount to create.
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "code",
@@ -32,6 +34,7 @@ The money amount to create.
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -40,6 +43,7 @@ The money amount to create.
"description": "The name of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -48,6 +52,7 @@ The money amount to create.
"description": "The symbol of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -56,6 +61,7 @@ The money amount to create.
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -66,6 +72,7 @@ The money amount to create.
"description": "The currency code of this money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -74,6 +81,7 @@ The money amount to create.
"description": "The ID of the money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -82,6 +90,7 @@ The money amount to create.
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -90,6 +99,7 @@ The money amount to create.
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/CreatePriceRuleDTO.mdx
+7
View File
@@ -17,6 +17,7 @@ A price rule to create.
"description": "The ID of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ A price rule to create.
"description": "The ID of the associated price list.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ A price rule to create.
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ A price rule to create.
"description": "The ID of the associated price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -49,6 +53,7 @@ A price rule to create.
"description": "The priority of the price rule in comparison to other applicable price rules.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -57,6 +62,7 @@ A price rule to create.
"description": "The ID of the associated rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -65,6 +71,7 @@ A price rule to create.
"description": "The value of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/CreatePriceSetDTO.mdx
+24 -1
View File
@@ -17,6 +17,7 @@ A price set to create.
"description": "The prices to create and add to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -24,6 +25,7 @@ A price set to create.
"description": "The amount of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -32,6 +34,7 @@ A price set to create.
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "code",
@@ -39,6 +42,7 @@ A price set to create.
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -47,6 +51,7 @@ A price set to create.
"description": "The name of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -55,6 +60,7 @@ A price set to create.
"description": "The symbol of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -63,6 +69,7 @@ A price set to create.
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -73,6 +80,7 @@ A price set to create.
"description": "The currency code of this money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -81,6 +89,7 @@ A price set to create.
"description": "The ID of the money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -89,6 +98,7 @@ A price set to create.
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -97,6 +107,7 @@ A price set to create.
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -105,6 +116,7 @@ A price set to create.
"description": "The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -115,6 +127,17 @@ A price set to create.
"description": "The rules to associate with the price set. The value of `attribute` is the value of the rule's `rule_attribute` attribute.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "rule_attribute",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]} />
www/apps/docs/content/references/pricing/interfaces/CreatePriceSetMoneyAmountRulesDTO.mdx
+3
View File
@@ -17,6 +17,7 @@ The price set money amount rule to create.
"description": "The ID of a price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ The price set money amount rule to create.
"description": "The ID of a rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ The price set money amount rule to create.
"description": "The value of the price set money amount rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/CreatePricesDTO.mdx
+11
View File
@@ -17,6 +17,7 @@ The prices to create part of a price set.
"description": "The amount of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ The prices to create part of a price set.
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "code",
@@ -32,6 +34,7 @@ The prices to create part of a price set.
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -40,6 +43,7 @@ The prices to create part of a price set.
"description": "The name of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -48,6 +52,7 @@ The prices to create part of a price set.
"description": "The symbol of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -56,6 +61,7 @@ The prices to create part of a price set.
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -66,6 +72,7 @@ The prices to create part of a price set.
"description": "The currency code of this money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -74,6 +81,7 @@ The prices to create part of a price set.
"description": "The ID of the money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -82,6 +90,7 @@ The prices to create part of a price set.
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -90,6 +99,7 @@ The prices to create part of a price set.
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -98,6 +108,7 @@ The prices to create part of a price set.
"description": "The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/CreateRuleTypeDTO.mdx
+4
View File
@@ -17,6 +17,7 @@ The rule type to create.
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ The rule type to create.
"description": "The ID of the rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ The rule type to create.
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ The rule type to create.
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/CurrencyDTO.mdx
+4
View File
@@ -17,6 +17,7 @@ A currency's data.
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ A currency's data.
"description": "The name of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ A currency's data.
"description": "The symbol of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ A currency's data.
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/FilterableCurrencyProps.mdx
+3
View File
@@ -17,6 +17,7 @@ Filters to apply on a currency.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ Filters to apply on a currency.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ Filters to apply on a currency.
"description": "The codes to filter the currencies by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/FilterableMoneyAmountProps.mdx
+4
View File
@@ -17,6 +17,7 @@ Filters to apply on a money amount.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ Filters to apply on a money amount.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ Filters to apply on a money amount.
"description": "Currency codes to filter money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ Filters to apply on a money amount.
"description": "IDs to filter money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/FilterablePriceRuleProps.mdx
+6
View File
@@ -17,6 +17,7 @@ Filters to apply to price rules.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ Filters to apply to price rules.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ Filters to apply to price rules.
"description": "The IDs to filter price rules by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ Filters to apply to price rules.
"description": "The names to filter price rules by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -49,6 +53,7 @@ Filters to apply to price rules.
"description": "The IDs to filter the price rule's associated price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -57,6 +62,7 @@ Filters to apply to price rules.
"description": "The IDs to filter the price rule's associated rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountProps.mdx
+4
View File
@@ -17,6 +17,7 @@ Filters to apply on price set money amounts.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ Filters to apply on price set money amounts.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ Filters to apply on price set money amounts.
"description": "The IDs to filter the price set money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ Filters to apply on price set money amounts.
"description": "The IDs to filter the price set money amount's associated price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountRulesProps.mdx
+6
View File
@@ -17,6 +17,7 @@ Filters to apply on price set money amount rules.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ Filters to apply on price set money amount rules.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ Filters to apply on price set money amount rules.
"description": "The ID to filter price set money amount rules by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ Filters to apply on price set money amount rules.
"description": "The IDs to filter the price set money amount rule's associated price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -49,6 +53,7 @@ Filters to apply on price set money amount rules.
"description": "The IDs to filter the price set money amount rule's associated rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -57,6 +62,7 @@ Filters to apply on price set money amount rules.
"description": "The value to filter price set money amount rules by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetProps.mdx
+8
View File
@@ -17,6 +17,7 @@ Filters to apply on price sets.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ Filters to apply on price sets.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ Filters to apply on price sets.
"description": "IDs to filter price sets by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ Filters to apply on price sets.
"description": "Filters to apply on a price set's associated money amounts.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "$and",
@@ -48,6 +52,7 @@ Filters to apply on price sets.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -56,6 +61,7 @@ Filters to apply on price sets.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -64,6 +70,7 @@ Filters to apply on price sets.
"description": "Currency codes to filter money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -72,6 +79,7 @@ Filters to apply on price sets.
"description": "IDs to filter money amounts by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/interfaces/FilterableRuleTypeProps.mdx
+5
View File
@@ -17,6 +17,7 @@ Filters to apply on rule types.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ Filters to apply on rule types.
"description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ Filters to apply on rule types.
"description": "The IDs to filter rule types by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ Filters to apply on rule types.
"description": "The names to filter rule types by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -49,6 +53,7 @@ Filters to apply on rule types.
"description": "The rule attributes to filter rule types by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/FindConfig.mdx
+18 -1
View File
@@ -18,6 +18,7 @@ which provides correct typing of field names in its properties.
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
@@ -31,7 +32,18 @@ which provides correct typing of field names in its properties.
"description": "An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC` to sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "relations",
@@ -39,6 +51,7 @@ which provides correct typing of field names in its properties.
"description": "An array of strings, each being relation names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -47,6 +60,7 @@ which provides correct typing of field names in its properties.
"description": "An array of strings, each being attribute names of the entity to retrieve in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -55,6 +69,7 @@ which provides correct typing of field names in its properties.
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -63,6 +78,7 @@ which provides correct typing of field names in its properties.
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -71,6 +87,7 @@ which provides correct typing of field names in its properties.
"description": "A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the `SoftDeletableEntity` class.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfig.mdx
+174 -2
View File
@@ -15,6 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"description": "Property name to use as entrypoint to the service",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -23,6 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -31,7 +33,100 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"description": "",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "relationship",
"type": "[`JoinerRelationship`](../types/JoinerRelationship.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "alias",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "args",
"type": "Record<`string`, `any`\\>",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "foreignKey",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inverse",
"type": "`boolean`",
"description": "In an inverted relationship the foreign key is on the other service and the primary key is on the current service",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isInternalService",
"type": "`boolean`",
"description": "If true, the relationship is an internal service from the medusa core TODO: Remove when there are no more \"internal\" services",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isList",
"type": "`boolean`",
"description": "Force the relationship to return a list",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "primaryKey",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "serviceName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "serviceName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "fieldAlias",
@@ -39,6 +134,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"description": "alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -47,6 +143,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -55,7 +152,81 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"description": "",
"optional": true,
"defaultValue": "",
"children": []
"expandable": false,
"children": [
{
"name": "alias",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "args",
"type": "Record<`string`, `any`\\>",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "foreignKey",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "inverse",
"type": "`boolean`",
"description": "In an inverted relationship the foreign key is on the other service and the primary key is on the current service",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isInternalService",
"type": "`boolean`",
"description": "If true, the relationship is an internal service from the medusa core TODO: Remove when there are no more \"internal\" services",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isList",
"type": "`boolean`",
"description": "Force the relationship to return a list",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "primaryKey",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "serviceName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "serviceName",
@@ -63,6 +234,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/JoinerServiceConfigAlias.mdx
+3 -1
View File
@@ -15,14 +15,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "name",
"type": "`string`",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx
+10
View File
@@ -17,6 +17,7 @@ A money amount's data. A money amount represents a price.
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ A money amount's data. A money amount represents a price.
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "code",
@@ -32,6 +34,7 @@ A money amount's data. A money amount represents a price.
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -40,6 +43,7 @@ A money amount's data. A money amount represents a price.
"description": "The name of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -48,6 +52,7 @@ A money amount's data. A money amount represents a price.
"description": "The symbol of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -56,6 +61,7 @@ A money amount's data. A money amount represents a price.
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -66,6 +72,7 @@ A money amount's data. A money amount represents a price.
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -74,6 +81,7 @@ A money amount's data. A money amount represents a price.
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -82,6 +90,7 @@ A money amount's data. A money amount represents a price.
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -90,6 +99,7 @@ A money amount's data. A money amount represents a price.
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx
+26
View File
@@ -17,6 +17,7 @@ A price rule's data.
"description": "The ID of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ A price rule's data.
"description": "The ID of the associated price list.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ A price rule's data.
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -40,6 +43,7 @@ A price rule's data.
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -48,6 +52,7 @@ A price rule's data.
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -55,6 +60,7 @@ A price rule's data.
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -63,6 +69,7 @@ A price rule's data.
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -71,6 +78,7 @@ A price rule's data.
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -79,6 +87,7 @@ A price rule's data.
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -87,6 +96,7 @@ A price rule's data.
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -95,6 +105,7 @@ A price rule's data.
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -105,6 +116,7 @@ A price rule's data.
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -112,6 +124,7 @@ A price rule's data.
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -120,6 +133,7 @@ A price rule's data.
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -128,6 +142,7 @@ A price rule's data.
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -136,6 +151,7 @@ A price rule's data.
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -148,6 +164,7 @@ A price rule's data.
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -156,6 +173,7 @@ A price rule's data.
"description": "The ID of the associated price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -164,6 +182,7 @@ A price rule's data.
"description": "The priority of the price rule in comparison to other applicable price rules.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -172,6 +191,7 @@ A price rule's data.
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -179,6 +199,7 @@ A price rule's data.
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -187,6 +208,7 @@ A price rule's data.
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -195,6 +217,7 @@ A price rule's data.
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -203,6 +226,7 @@ A price rule's data.
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -213,6 +237,7 @@ A price rule's data.
"description": "The ID of the associated rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -221,6 +246,7 @@ A price rule's data.
"description": "The value of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx
+17
View File
@@ -17,6 +17,7 @@ A price set's data.
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ A price set's data.
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -32,6 +34,7 @@ A price set's data.
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -40,6 +43,7 @@ A price set's data.
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "code",
@@ -47,6 +51,7 @@ A price set's data.
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -55,6 +60,7 @@ A price set's data.
"description": "The name of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -63,6 +69,7 @@ A price set's data.
"description": "The symbol of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -71,6 +78,7 @@ A price set's data.
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -81,6 +89,7 @@ A price set's data.
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -89,6 +98,7 @@ A price set's data.
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -97,6 +107,7 @@ A price set's data.
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -105,6 +116,7 @@ A price set's data.
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -115,6 +127,7 @@ A price set's data.
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -122,6 +135,7 @@ A price set's data.
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -130,6 +144,7 @@ A price set's data.
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -138,6 +153,7 @@ A price set's data.
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -146,6 +162,7 @@ A price set's data.
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx
+45
View File
@@ -17,6 +17,7 @@ A price set money amount's data.
"description": "The ID of a price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ A price set money amount's data.
"description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -32,6 +34,7 @@ A price set money amount's data.
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -40,6 +43,7 @@ A price set money amount's data.
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "code",
@@ -47,6 +51,7 @@ A price set money amount's data.
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -55,6 +60,7 @@ A price set money amount's data.
"description": "The name of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -63,6 +69,7 @@ A price set money amount's data.
"description": "The symbol of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -71,6 +78,7 @@ A price set money amount's data.
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -81,6 +89,7 @@ A price set money amount's data.
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -89,6 +98,7 @@ A price set money amount's data.
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -97,6 +107,7 @@ A price set money amount's data.
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -105,6 +116,7 @@ A price set money amount's data.
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -115,6 +127,7 @@ A price set money amount's data.
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -122,6 +135,7 @@ A price set money amount's data.
"description": "The ID of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -130,6 +144,7 @@ A price set money amount's data.
"description": "The ID of the associated price list.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -138,6 +153,7 @@ A price set money amount's data.
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -145,6 +161,7 @@ A price set money amount's data.
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -153,6 +170,7 @@ A price set money amount's data.
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -161,6 +179,7 @@ A price set money amount's data.
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -171,6 +190,7 @@ A price set money amount's data.
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -179,6 +199,7 @@ A price set money amount's data.
"description": "The ID of the associated price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -187,6 +208,7 @@ A price set money amount's data.
"description": "The priority of the price rule in comparison to other applicable price rules.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -195,6 +217,7 @@ A price set money amount's data.
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -202,6 +225,7 @@ A price set money amount's data.
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -210,6 +234,7 @@ A price set money amount's data.
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -218,6 +243,7 @@ A price set money amount's data.
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -226,6 +252,7 @@ A price set money amount's data.
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -236,6 +263,7 @@ A price set money amount's data.
"description": "The ID of the associated rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -244,6 +272,7 @@ A price set money amount's data.
"description": "The value of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -254,6 +283,7 @@ A price set money amount's data.
"description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -261,6 +291,7 @@ A price set money amount's data.
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -269,6 +300,7 @@ A price set money amount's data.
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -276,6 +308,7 @@ A price set money amount's data.
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -284,6 +317,7 @@ A price set money amount's data.
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -292,6 +326,7 @@ A price set money amount's data.
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -300,6 +335,7 @@ A price set money amount's data.
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -308,6 +344,7 @@ A price set money amount's data.
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -316,6 +353,7 @@ A price set money amount's data.
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -326,6 +364,7 @@ A price set money amount's data.
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -333,6 +372,7 @@ A price set money amount's data.
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -341,6 +381,7 @@ A price set money amount's data.
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -349,6 +390,7 @@ A price set money amount's data.
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -357,6 +399,7 @@ A price set money amount's data.
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -369,6 +412,7 @@ A price set money amount's data.
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -377,6 +421,7 @@ A price set money amount's data.
"description": "The title of the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx
+32
View File
@@ -17,6 +17,7 @@ A price set money amount rule's data.
"description": "The ID of the price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ A price set money amount rule's data.
"description": "The associated price set money amount. It may only be available if the relation `price_set_money_amount` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -32,6 +34,7 @@ A price set money amount rule's data.
"description": "The ID of a price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -40,6 +43,7 @@ A price set money amount rule's data.
"description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "amount",
@@ -47,6 +51,7 @@ A price set money amount rule's data.
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -55,6 +60,7 @@ A price set money amount rule's data.
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -63,6 +69,7 @@ A price set money amount rule's data.
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -71,6 +78,7 @@ A price set money amount rule's data.
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -79,6 +87,7 @@ A price set money amount rule's data.
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -87,6 +96,7 @@ A price set money amount rule's data.
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -97,6 +107,7 @@ A price set money amount rule's data.
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -104,6 +115,7 @@ A price set money amount rule's data.
"description": "The ID of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -112,6 +124,7 @@ A price set money amount rule's data.
"description": "The ID of the associated price list.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -120,6 +133,7 @@ A price set money amount rule's data.
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -128,6 +142,7 @@ A price set money amount rule's data.
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -136,6 +151,7 @@ A price set money amount rule's data.
"description": "The ID of the associated price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -144,6 +160,7 @@ A price set money amount rule's data.
"description": "The priority of the price rule in comparison to other applicable price rules.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -152,6 +169,7 @@ A price set money amount rule's data.
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -160,6 +178,7 @@ A price set money amount rule's data.
"description": "The ID of the associated rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -168,6 +187,7 @@ A price set money amount rule's data.
"description": "The value of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -178,6 +198,7 @@ A price set money amount rule's data.
"description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "id",
@@ -185,6 +206,7 @@ A price set money amount rule's data.
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -193,6 +215,7 @@ A price set money amount rule's data.
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -201,6 +224,7 @@ A price set money amount rule's data.
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -211,6 +235,7 @@ A price set money amount rule's data.
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -219,6 +244,7 @@ A price set money amount rule's data.
"description": "The title of the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -229,6 +255,7 @@ A price set money amount rule's data.
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "default_priority",
@@ -236,6 +263,7 @@ A price set money amount rule's data.
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -244,6 +272,7 @@ A price set money amount rule's data.
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -252,6 +281,7 @@ A price set money amount rule's data.
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -260,6 +290,7 @@ A price set money amount rule's data.
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
@@ -270,6 +301,7 @@ A price set money amount rule's data.
"description": "The value of the price set money amount rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/PricingContext.mdx
+1
View File
@@ -17,6 +17,7 @@ The context to calculate prices. For example, you can specify the currency code
"description": "an object whose keys are the name of the context attribute. Its value can be a string or a number. For example, you can pass the `currency_code` property with its value being the currency code to calculate the price in. Another example is passing the `quantity` property to calculate the price for that specified quantity, which finds a price set whose `min_quantity` and `max_quantity` conditions match the specified quantity.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/PricingFilters.mdx
+1
View File
@@ -17,6 +17,7 @@ Filters to apply on prices.
"description": "IDs to filter prices.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/RemovePriceSetRulesDTO.mdx
+2
View File
@@ -17,6 +17,7 @@ The rules to remove from a price set.
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ The rules to remove from a price set.
"description": "The rules to remove. Each string is the `rule_attribute` of a rule to remove.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/RuleTypeDTO.mdx
+4
View File
@@ -17,6 +17,7 @@ A rule type's data.
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ A rule type's data.
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ A rule type's data.
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ A rule type's data.
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/UpdateCurrencyDTO.mdx
+4
View File
@@ -17,6 +17,7 @@ The data to update in a currency. The `code` is used to identify which currency
"description": "The code of the currency to update.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ The data to update in a currency. The `code` is used to identify which currency
"description": "The name of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ The data to update in a currency. The `code` is used to identify which currency
"description": "The symbol of the currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ The data to update in a currency. The `code` is used to identify which currency
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/UpdateMoneyAmountDTO.mdx
+5
View File
@@ -19,6 +19,7 @@ The data to update in a money amount. The `id` is used to identify which money a
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -27,6 +28,7 @@ The data to update in a money amount. The `id` is used to identify which money a
"description": "The code of the currency to associate with the money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -35,6 +37,7 @@ The data to update in a money amount. The `id` is used to identify which money a
"description": "The ID of the money amount to update.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -43,6 +46,7 @@ The data to update in a money amount. The `id` is used to identify which money a
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -51,6 +55,7 @@ The data to update in a money amount. The `id` is used to identify which money a
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/UpdatePriceRuleDTO.mdx
+7
View File
@@ -17,6 +17,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
"description": "The ID of the price rule to update.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
"description": "The ID of the associated price list.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
"description": "The ID of the associated price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
"description": "The ID of the associated price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -49,6 +53,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
"description": "The priority of the price rule in comparison to other applicable price rules.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -57,6 +62,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
"description": "The ID of the associated rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -65,6 +71,7 @@ The data to update in a price rule. The `id` is used to identify which money amo
"description": "The value of the price rule.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/UpdatePriceSetDTO.mdx
+1
View File
@@ -17,6 +17,7 @@ The data to update in a price set. The `id` is used to identify which price set
"description": "A string indicating the ID of the price set to update.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/UpdatePriceSetMoneyAmountRulesDTO.mdx
+4
View File
@@ -17,6 +17,7 @@ The data to update in a price set money amount rule. The `id` is used to identif
"description": "The ID of the price set money amount rule to update.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ The data to update in a price set money amount rule. The `id` is used to identif
"description": "The ID of a price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ The data to update in a price set money amount rule. The `id` is used to identif
"description": "The ID of a rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ The data to update in a price set money amount rule. The `id` is used to identif
"description": "The value of the price set money amount rule.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/UpdateRuleTypeDTO.mdx
+4
View File
@@ -17,6 +17,7 @@ The data to update in a rule type. The `id` is used to identify which price set
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -25,6 +26,7 @@ The data to update in a rule type. The `id` is used to identify which price set
"description": "The ID of the rule type to update.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -33,6 +35,7 @@ The data to update in a rule type. The `id` is used to identify which price set
"description": "The display name of the rule type.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
@@ -41,6 +44,7 @@ The data to update in a rule type. The `id` is used to identify which price set
"description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />