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

chore(docs): Generated Pricing Module Reference (#5432)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-10-20 12:08:59 +00:00
committed by GitHub
parent 39de54e2e8
commit 0ffa48b07f
81 changed files with 9511 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files

109
www/apps/docs/content/references/pricing/interfaces/AddPricesDTO.mdx
View File

@@ -10,4 +10,111 @@ The prices to add to a price set.
## Properties
<ParameterTypes parameters={[{"name":"priceSetId","type":"`string`","description":"The ID of the price set to add prices to.","optional":false,"defaultValue":"","children":[]},{"name":"prices","type":"[`CreatePricesDTO`](CreatePricesDTO.mdx)[]","description":"The prices to add to the price set.","optional":false,"defaultValue":"","children":[{"name":"amount","type":"`number`","description":"The amount of this money amount.","optional":true,"defaultValue":"","children":[]},{"name":"currency","type":"[`CreateCurrencyDTO`](CreateCurrencyDTO.mdx)","description":"The currency of this money amount.","optional":true,"defaultValue":"","children":[{"name":"code","type":"`string`","description":"The code of the currency.","optional":false,"defaultValue":"","children":[]},{"name":"name","type":"`string`","description":"The name of the currency.","optional":false,"defaultValue":"","children":[]},{"name":"symbol","type":"`string`","description":"The symbol of the currency.","optional":false,"defaultValue":"","children":[]},{"name":"symbol_native","type":"`string`","description":"The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.","optional":false,"defaultValue":"","children":[]}]},{"name":"currency_code","type":"`string`","description":"The currency code of this money amount.","optional":false,"defaultValue":"","children":[]},{"name":"id","type":"`string`","description":"The ID of the money amount.","optional":true,"defaultValue":"","children":[]},{"name":"max_quantity","type":"`number`","description":"The maximum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","children":[]},{"name":"min_quantity","type":"`number`","description":"The minimum quantity required to be purchased for this money amount to be applied.","optional":true,"defaultValue":"","children":[]},{"name":"rules","type":"Record<`string`, `string`\\>","description":"The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.","optional":false,"defaultValue":"","children":[]}]}]} />
<ParameterTypes parameters={[
{
"name": "priceSetId",
"type": "`string`",
"description": "The ID of the price set to add prices to.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "prices",
"type": "[`CreatePricesDTO`](CreatePricesDTO.mdx)[]",
"description": "The prices to add to the price set.",
"optional": false,
"defaultValue": "",
"children": [
{
"name": "amount",
"type": "`number`",
"description": "The amount of this money amount.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "currency",
"type": "[`CreateCurrencyDTO`](CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
"children": [
{
"name": "code",
"type": "`string`",
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The name of the currency.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "symbol",
"type": "`string`",
"description": "The symbol of the currency.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "symbol_native",
"type": "`string`",
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": false,
"defaultValue": "",
"children": []
}
]
},
{
"name": "currency_code",
"type": "`string`",
"description": "The currency code of this money amount.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The ID of the money amount.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "max_quantity",
"type": "`number`",
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "min_quantity",
"type": "`number`",
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "rules",
"type": "Record<`string`, `string`\\>",
"description": "The rules to add to the price. The object's keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.",
"optional": false,
"defaultValue": "",
"children": []
}
]
}
]} />