chore(docs): Generated References (#5666)
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]
co-authored by
Shahed Nasser
Shahed Nasser
parent
4774b8ff3a
commit
2b9e8bda5e
@@ -23,10 +23,10 @@ A price set money amount's data.
|
||||
{
|
||||
"name": "money_amount",
|
||||
"type": "[MoneyAmountDTO](MoneyAmountDTO.mdx)",
|
||||
"description": "The money amount associated with the price set money amount. It may only be available if the relation `money_amount` is expanded.",
|
||||
"description": "The money amount associated with the price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": [
|
||||
{
|
||||
"name": "amount",
|
||||
@@ -40,10 +40,10 @@ A price set money amount's data.
|
||||
{
|
||||
"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",
|
||||
@@ -118,16 +118,474 @@ A price set money amount's data.
|
||||
"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": "price_list",
|
||||
"type": "[PriceListDTO](PriceListDTO.mdx)",
|
||||
"description": "The price list associated with the price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"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": "price_set",
|
||||
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
|
||||
"description": "The price set associated with the price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"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": []
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"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": "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": "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": "id",
|
||||
"type": "`string`",
|
||||
"description": "The price list rule's ID.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list",
|
||||
"type": "[PriceListDTO](PriceListDTO.mdx)",
|
||||
"description": "The associated price list.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_rule_values",
|
||||
"type": "[PriceListRuleValueDTO](PriceListRuleValueDTO.mdx)[]",
|
||||
"description": "The associated rule values.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
|
||||
"description": "The associated rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "price_set_money_amounts",
|
||||
"type": "[PriceSetMoneyAmountDTO](PriceSetMoneyAmountDTO.mdx)[]",
|
||||
"description": "The associated price set money amounts.",
|
||||
"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": "price_list",
|
||||
"type": "[PriceListDTO](PriceListDTO.mdx)",
|
||||
"description": "The price list associated with the price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"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": "price_set",
|
||||
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
|
||||
"description": "The price set associated with the price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"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": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rule_types",
|
||||
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)[]",
|
||||
"description": "The associated rule types.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": [
|
||||
{
|
||||
"name": "default_priority",
|
||||
"type": "`number`",
|
||||
"description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The ID of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "name",
|
||||
"type": "`string`",
|
||||
"description": "The display name of the rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_attribute",
|
||||
"type": "`string`",
|
||||
"description": "The unique name used to later identify the rule\\_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "rules",
|
||||
"type": "[PriceListRuleDTO](PriceListRuleDTO.mdx)[]",
|
||||
"description": "The price set's rules.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
"type": "`string`",
|
||||
"description": "The price list rule's ID.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list",
|
||||
"type": "[PriceListDTO](PriceListDTO.mdx)",
|
||||
"description": "The associated price list.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "price_list_rule_values",
|
||||
"type": "[PriceListRuleValueDTO](PriceListRuleValueDTO.mdx)[]",
|
||||
"description": "The associated rule values.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
|
||||
"description": "The associated rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": true,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"type": "`string`",
|
||||
"description": "The value of the rule.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"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": "ACTIVE",
|
||||
"type": "`\"active\"`",
|
||||
"description": "The price list is enabled and its prices can be used.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"children": []
|
||||
},
|
||||
{
|
||||
"name": "DRAFT",
|
||||
"type": "`\"draft\"`",
|
||||
"description": "The price list is disabled, meaning its prices can't be used yet.",
|
||||
"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": "",
|
||||
"description": "The price rules associated with the price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
@@ -150,10 +608,10 @@ A price set money amount's data.
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
|
||||
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
|
||||
"description": "The associated price set.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
@@ -214,10 +672,10 @@ A price set money amount's data.
|
||||
{
|
||||
"name": "rule_type",
|
||||
"type": "[RuleTypeDTO](RuleTypeDTO.mdx)",
|
||||
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
|
||||
"description": "The associated rule type.",
|
||||
"optional": false,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": [
|
||||
{
|
||||
"name": "default_priority",
|
||||
@@ -280,10 +738,10 @@ A price set money amount's data.
|
||||
{
|
||||
"name": "price_set",
|
||||
"type": "[PriceSetDTO](PriceSetDTO.mdx)",
|
||||
"description": "The price set associated with the price set money amount. It may only be available if the relation `price_set` is expanded.",
|
||||
"description": "The price set associated with the price set money amount.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
"expandable": true,
|
||||
"children": [
|
||||
{
|
||||
"name": "id",
|
||||
@@ -314,10 +772,10 @@ A price set money amount's data.
|
||||
{
|
||||
"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": []
|
||||
},
|
||||
{
|
||||
@@ -355,6 +813,15 @@ A price set money amount's data.
|
||||
"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": []
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -409,7 +876,7 @@ A price set money amount's data.
|
||||
{
|
||||
"name": "price_set_id",
|
||||
"type": "`string`",
|
||||
"description": "",
|
||||
"description": "The ID of the associated price set.",
|
||||
"optional": true,
|
||||
"defaultValue": "",
|
||||
"expandable": false,
|
||||
|
||||
Reference in New Issue
Block a user