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

chore(docs): Generated References (#5743)

Browse Source 
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

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-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

268
www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSet.mdx Normal file
View File

@@ -0,0 +1,268 @@
---
displayed_sidebar: pricingReference
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CalculatedPriceSet
The calculated price for a specific price set and context.
## Properties
<ParameterTypes parameters={[
{
"name": "calculated_amount",
"type": "`null` \\| `number`",
"description": "The amount of the calculated price, or `null` if there isn't a calculated price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculated_price",
"type": "`object`",
"description": "The details of the calculated price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "max_quantity",
"type": "`null` \\| `number`",
"description": "The `max_quantity` field defined on a money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "min_quantity",
"type": "`null` \\| `number`",
"description": "The `min_quantity` field defined on a money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "money_amount_id",
"type": "`null` \\| `string`",
"description": "The ID of the money amount selected as the calculated price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_id",
"type": "`null` \\| `string`",
"description": "The ID of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_type",
"type": "`null` \\| `string`",
"description": "The type of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "calculated_price.max_quantity",
"type": "`null` \\| `number`",
"description": "The `max_quantity` field defined on a money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculated_price.min_quantity",
"type": "`null` \\| `number`",
"description": "The `min_quantity` field defined on a money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculated_price.money_amount_id",
"type": "`null` \\| `string`",
"description": "The ID of the money amount selected as the calculated price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculated_price.price_list_id",
"type": "`null` \\| `string`",
"description": "The ID of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "calculated_price.price_list_type",
"type": "`null` \\| `string`",
"description": "The type of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "currency_code",
"type": "`null` \\| `string`",
"description": "The currency code of the calculated price, or null if there isn't a calculated price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The ID of the price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_calculated_price_price_list",
"type": "`boolean`",
"description": "Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found, the calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is `false`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "is_original_price_price_list",
"type": "`boolean`",
"description": "Whether the original price is associated with a price list. During the calculation process, if the price list of the calculated price is of type override, the original price will be the same as the calculated price. In that case, the value of this property is `true`.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_amount",
"type": "`null` \\| `number`",
"description": "The amount of the original price, or `null` if there isn't a calculated price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_price",
"type": "`object`",
"description": "The details of the original price.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "max_quantity",
"type": "`null` \\| `number`",
"description": "The `max_quantity` field defined on a money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "min_quantity",
"type": "`null` \\| `number`",
"description": "The `min_quantity` field defined on a money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "money_amount_id",
"type": "`null` \\| `string`",
"description": "The ID of the money amount selected as the original price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_id",
"type": "`null` \\| `string`",
"description": "The ID of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_type",
"type": "`null` \\| `string`",
"description": "The type of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "original_price.max_quantity",
"type": "`null` \\| `number`",
"description": "The `max_quantity` field defined on a money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_price.min_quantity",
"type": "`null` \\| `number`",
"description": "The `min_quantity` field defined on a money amount.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_price.money_amount_id",
"type": "`null` \\| `string`",
"description": "The ID of the money amount selected as the original price.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_price.price_list_id",
"type": "`null` \\| `string`",
"description": "The ID of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "original_price.price_list_type",
"type": "`null` \\| `string`",
"description": "The type of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />

86
www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSetDTO.mdx
View File

@@ -1,86 +0,0 @@
---
displayed_sidebar: pricingReference
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CalculatedPriceSetDTO
A calculated price set's data.
## Properties
<ParameterTypes parameters={[
{
"name": "amount",
"type": "`null` \\| `string`",
"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": []
},
{
"name": "currency_code",
"type": "`null` \\| `string`",
"description": "The currency code of the calculated price. It can possibly be `null`.",
"optional": false,
"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": "`null` \\| `string`",
"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": []
},
{
"name": "min_quantity",
"type": "`null` \\| `string`",
"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": []
},
{
"name": "price_list_id",
"type": "`null` \\| `string`",
"description": "The ID of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_list_type",
"type": "`null` \\| `string`",
"description": "The type of the associated price list, if any.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "price_set_id",
"type": "`string`",
"description": "The ID of the associated price set.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />

2
www/apps/docs/content/references/pricing/interfaces/CreatePriceListRules.mdx
View File

@@ -7,4 +7,4 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# CreatePriceListRules
The price list's rules to be set. Each key of the object is a rule type's `rule_attribute`, and its value
* is the values of the rule.
is the values of the rule.

18
www/apps/docs/content/references/pricing/interfaces/FindConfig.mdx
View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# FindConfig
An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class,
An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an `Entity` class,
which provides correct typing of field names in its properties.
## Type parameters
@@ -33,17 +33,7 @@ which provides correct typing of field names in its properties.
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "__type",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
"children": []
},
{
"name": "relations",
@@ -65,7 +55,7 @@ which provides correct typing of field names in its properties.
},
{
"name": "skip",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to skip before retrieving the results.",
"optional": true,
"defaultValue": "",
@@ -74,7 +64,7 @@ which provides correct typing of field names in its properties.
},
{
"name": "take",
"type": "`number`",
"type": "`null` \\| `number`",
"description": "A number indicating the number of records to return in the result.",
"optional": true,
"defaultValue": "",

4
www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.mdx
View File

@@ -108,7 +108,7 @@ A money amount's data. A money amount represents a price.
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": true,
"expandable": false,
"children": [
{
"name": "id",
@@ -187,7 +187,7 @@ A money amount's data. A money amount represents a price.
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": true,
"expandable": false,
"children": []
}
]

4
www/apps/docs/content/references/pricing/interfaces/PriceListDTO.mdx
View File

@@ -134,7 +134,7 @@ A price list's details.
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": true,
"expandable": false,
"children": [
{
"name": "id",
@@ -517,7 +517,7 @@ A price list's details.
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": true,
"expandable": false,
"children": []
}
]

2
www/apps/docs/content/references/pricing/interfaces/PriceListRuleDTO.mdx
View File

@@ -114,7 +114,7 @@ The price list rule's details.
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": true,
"expandable": false,
"children": []
}
]

2
www/apps/docs/content/references/pricing/interfaces/PriceRuleDTO.mdx
View File

@@ -114,7 +114,7 @@ A price rule's data.
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": true,
"expandable": false,
"children": []
}
]

2
www/apps/docs/content/references/pricing/interfaces/PriceSetDTO.mdx
View File

@@ -125,7 +125,7 @@ A price set's data.
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": true,
"expandable": false,
"children": [
{
"name": "id",

6
www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountDTO.mdx
View File

@@ -125,7 +125,7 @@ A price set money amount's data.
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": true,
"expandable": false,
"children": [
{
"name": "id",
@@ -288,7 +288,7 @@ A price set money amount's data.
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": true,
"expandable": false,
"children": []
}
]
@@ -820,7 +820,7 @@ A price set money amount's data.
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": true,
"expandable": false,
"children": []
}
]

2
www/apps/docs/content/references/pricing/interfaces/PriceSetMoneyAmountRulesDTO.mdx
View File

@@ -105,7 +105,7 @@ A price set money amount rule's data.
"description": "The details of the relation between the money amount and its associated price set.",
"optional": true,
"defaultValue": "",
"expandable": true,
"expandable": false,
"children": []
}
]

4
www/apps/docs/content/references/pricing/interfaces/UpdatePriceListDTO.mdx
View File

@@ -13,7 +13,7 @@ The attributes to update in a price list.
<ParameterTypes parameters={[
{
"name": "ends_at",
"type": "`string`",
"type": "`null` \\| `string`",
"description": "The price list expires after this date.",
"optional": true,
"defaultValue": "",
@@ -49,7 +49,7 @@ The attributes to update in a price list.
},
{
"name": "starts_at",
"type": "`string`",
"type": "`null` \\| `string`",
"description": "The price list is enabled starting from this date.",
"optional": true,
"defaultValue": "",