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

chore(docs): Generated References (#5666)

Browse Source 
Generated the following references:
- `entities`
- `js-client`
- `pricing`
- `services`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-21 12:36:09 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 4774b8ff3a
commit 2b9e8bda5e
178 changed files with 10576 additions and 718 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx
+349 -2
View File
@@ -23,10 +23,10 @@ A money amount's data. A money amount represents a price.
{
"name": "currency",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
"expandable": false,
"expandable": true,
"children": [
{
"name": "code",
@@ -101,5 +101,352 @@ A money amount's data. A money amount represents a price.
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "id",
"type": "`string`",
"description": "The ID of a price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "money_amount",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
"description": "The money amount associated with the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "amount",
"type": "`number`",
"description": "The price of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currency",
"type": "[CurrencyDTO](CurrencyDTO.mdx)",
"description": "The money amount's currency.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "currency_code",
"type": "`string`",
"description": "The currency code of this money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The ID of the money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "max_quantity",
"type": "`number`",
"description": "The maximum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "min_quantity",
"type": "`number`",
"description": "The minimum quantity required to be purchased for this price to be applied.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set_money_amount",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)",
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
}
]
},
{
"name": "price_list",
"type": "[PriceListDTO](PriceListDTO.mdx)",
"description": "The price list associated with the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "ends_at",
"type": "`null` \\| `string`",
"description": "The price list expires after this date.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The price list's ID.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"description": "The associated money amounts.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "number_rules",
"type": "`number`",
"description": "The number of rules associated with this price list.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "price_set_money_amounts",
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]",
"description": "The associated price set money amounts.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"description": "The associated rule types.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "rules",
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
"description": "The price set's rules.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "starts_at",
"type": "`null` \\| `string`",
"description": "The price list is enabled starting from this date.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "status",
"type": "[PriceListStatus](../enums/PriceListStatus.mdx)",
"description": "The price list's status.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`string`",
"description": "The price list's title.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "price_rules",
"type": "[PriceRuleDTO](PriceRuleDTO.mdx)[]",
"description": "The price rules associated with the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "id",
"type": "`string`",
"description": "The ID of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_id",
"type": "`string`",
"description": "The ID of the associated price list.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"description": "The associated price set.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "price_set_id",
"type": "`string`",
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set_money_amount_id",
"type": "`string`",
"description": "The ID of the associated price set money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "priority",
"type": "`number`",
"description": "The priority of the price rule in comparison to other applicable price rules.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rule_type",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
"description": "The associated rule type.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "rule_type_id",
"type": "`string`",
"description": "The ID of the associated rule type.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "value",
"type": "`string`",
"description": "The value of the price rule.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "price_set",
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
"description": "The price set associated with the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": true,
"children": [
{
"name": "id",
"type": "`string`",
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "money_amounts",
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "rule_types",
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "price_set_id",
"type": "`string`",
"description": "The ID of the associated price set.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "title",
"type": "`string`",
"description": "The title of the price set money amount.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]} />