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

chore(docs): Generated References (#5516)

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

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]
2023-11-02 09:16:47 +00:00
committed by GitHub
co-authored by Oli Juhl Shahed Nasser
parent 80fe362f33
commit aa2bb7a31b
271 changed files with 38146 additions and 9809 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/pricing/interfaces/AddPricesDTO.mdx
+2 -2
View File
@@ -93,7 +93,7 @@ The prices to add to a price set.
},
{
"name": "max_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
@@ -101,7 +101,7 @@ The prices to add to a price set.
},
{
"name": "min_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/CreateMoneyAmountDTO.mdx
+2 -2
View File
@@ -78,7 +78,7 @@ The money amount to create.
},
{
"name": "max_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
@@ -86,7 +86,7 @@ The money amount to create.
},
{
"name": "min_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/CreatePriceSetDTO.mdx
+2 -2
View File
@@ -85,7 +85,7 @@ A price set to create.
},
{
"name": "max_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
@@ -93,7 +93,7 @@ A price set to create.
},
{
"name": "min_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/CreatePricesDTO.mdx
+2 -2
View File
@@ -78,7 +78,7 @@ The prices to create part of a price set.
},
{
"name": "max_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
@@ -86,7 +86,7 @@ The prices to create part of a price set.
},
{
"name": "min_quantity",
"type": "`number`",
"type": "``null`` \\| `number`",
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/pricing/interfaces/FilterablePriceSetMoneyAmountProps.mdx
+46
View File
@@ -0,0 +1,46 @@
---
displayed_sidebar: pricingReference
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# FilterablePriceSetMoneyAmountProps
Filters to apply on price set money amounts.
## Properties
<ParameterTypes parameters={[
{
"name": "$and",
"type": "([`FilterablePriceSetMoneyAmountProps`](FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
"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": "",
"children": []
},
{
"name": "$or",
"type": "([`FilterablePriceSetMoneyAmountProps`](FilterablePriceSetMoneyAmountProps.mdx) \\| [`BaseFilterable`](BaseFilterable.mdx)<[`FilterablePriceSetMoneyAmountProps`](FilterablePriceSetMoneyAmountProps.mdx)\\>)[]",
"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": "",
"children": []
},
{
"name": "id",
"type": "`string`[]",
"description": "The IDs to filter the price set money amounts by.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "price_set_id",
"type": "`string`[]",
"description": "The IDs to filter the price set money amount's associated price set.",
"optional": true,
"defaultValue": "",
"children": []
}
]} />
www/apps/docs/content/references/pricing/interfaces/IPricingModuleService.mdx
+2
View File
@@ -35,11 +35,13 @@ This section of the documentation provides a reference to the `IPricingModuleSer
- [listAndCountMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.listAndCountMoneyAmounts.mdx)
- [listAndCountPriceRules](../IPricingModuleService/methods/IPricingModuleService.listAndCountPriceRules.mdx)
- [listAndCountPriceSetMoneyAmountRules](../IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmountRules.mdx)
- [listAndCountPriceSetMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.listAndCountPriceSetMoneyAmounts.mdx)
- [listAndCountRuleTypes](../IPricingModuleService/methods/IPricingModuleService.listAndCountRuleTypes.mdx)
- [listCurrencies](../IPricingModuleService/methods/IPricingModuleService.listCurrencies.mdx)
- [listMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.listMoneyAmounts.mdx)
- [listPriceRules](../IPricingModuleService/methods/IPricingModuleService.listPriceRules.mdx)
- [listPriceSetMoneyAmountRules](../IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmountRules.mdx)
- [listPriceSetMoneyAmounts](../IPricingModuleService/methods/IPricingModuleService.listPriceSetMoneyAmounts.mdx)
- [listRuleTypes](../IPricingModuleService/methods/IPricingModuleService.listRuleTypes.mdx)
- [removeRules](../IPricingModuleService/methods/IPricingModuleService.removeRules.mdx)
- [retrieve](../IPricingModuleService/methods/IPricingModuleService.retrieve.mdx)
www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx
+147
View File
@@ -109,6 +109,145 @@ A price set money amount's data.
}
]
},
{
"name": "price_rules",
"type": "[`PriceRuleDTO`](PriceRuleDTO.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
"children": [
{
"name": "id",
"type": "`string`",
"description": "The ID of the price rule.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "price_list_id",
"type": "`string`",
"description": "The ID of the associated price list.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](PriceSetDTO.mdx)",
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
"children": [
{
"name": "id",
"type": "`string`",
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "money_amounts",
"type": "[`MoneyAmountDTO`](MoneyAmountDTO.mdx)[]",
"description": "The prices that belong to this price set.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "rule_types",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)[]",
"description": "The rule types applied on this price set.",
"optional": true,
"defaultValue": "",
"children": []
}
]
},
{
"name": "price_set_id",
"type": "`string`",
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "price_set_money_amount_id",
"type": "`string`",
"description": "The ID of the associated price set money amount.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "priority",
"type": "`number`",
"description": "The priority of the price rule in comparison to other applicable price rules.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
"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": "",
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The ID of the rule type.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The display name of the rule type.",
"optional": false,
"defaultValue": "",
"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": "",
"children": []
}
]
},
{
"name": "rule_type_id",
"type": "`string`",
"description": "The ID of the associated rule type.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "value",
"type": "`string`",
"description": "The value of the price rule.",
"optional": false,
"defaultValue": "",
"children": []
}
]
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](PriceSetDTO.mdx)",
@@ -224,6 +363,14 @@ A price set money amount's data.
}
]
},
{
"name": "price_set_id",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "title",
"type": "`string`",
www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx
+89
View File
@@ -91,6 +91,87 @@ A price set money amount rule's data.
}
]
},
{
"name": "price_rules",
"type": "[`PriceRuleDTO`](PriceRuleDTO.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
"children": [
{
"name": "id",
"type": "`string`",
"description": "The ID of the price rule.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "price_list_id",
"type": "`string`",
"description": "The ID of the associated price list.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](PriceSetDTO.mdx)",
"description": "The associated price set. It may only be available if the relation `price_set` is expanded.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "price_set_id",
"type": "`string`",
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "price_set_money_amount_id",
"type": "`string`",
"description": "The ID of the associated price set money amount.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "priority",
"type": "`number`",
"description": "The priority of the price rule in comparison to other applicable price rules.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "rule_type",
"type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)",
"description": "The associated rule type. It may only be available if the relation `rule_type` is expanded.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "rule_type_id",
"type": "`string`",
"description": "The ID of the associated rule type.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "value",
"type": "`string`",
"description": "The value of the price rule.",
"optional": false,
"defaultValue": "",
"children": []
}
]
},
{
"name": "price_set",
"type": "[`PriceSetDTO`](PriceSetDTO.mdx)",
@@ -124,6 +205,14 @@ A price set money amount rule's data.
}
]
},
{
"name": "price_set_id",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "title",
"type": "`string`",