docs: generate pricing module reference (#5349)

* docs: generate pricing module reference * added notes about new configurations
2023-10-11 14:08:19 +03:00
parent 9c1c19f409
commit f0af8ecc89
110 changed files with 7170 additions and 146 deletions
@@ -0,0 +1,121 @@
+---
+displayed_sidebar: pricingReference
+---
+
+# CreatePricesDTO
+
+An object used to pass prices data when creating a price set.
+
+## Hierarchy
+
+- [`CreateMoneyAmountDTO`](CreateMoneyAmountDTO.md)
+
+  ↳ **`CreatePricesDTO`**
+
+## Properties
+
+### amount
+
+ `Optional` **amount**: `number`
+
+A number indicating the amount of this money amount.
+
+#### Inherited from
+
+[CreateMoneyAmountDTO](CreateMoneyAmountDTO.md).[amount](CreateMoneyAmountDTO.md#amount)
+
+#### Defined in
+
+[packages/types/src/pricing/common/money-amount.ts:41](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/money-amount.ts#L41)
+
+___
+
+### currency
+
+ `Optional` **currency**: [`CreateCurrencyDTO`](CreateCurrencyDTO.md)
+
+An object of type [CurrencyDTO](CurrencyDTO.md) that holds the details of 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.
+
+#### Inherited from
+
+[CreateMoneyAmountDTO](CreateMoneyAmountDTO.md).[currency](CreateMoneyAmountDTO.md#currency)
+
+#### Defined in
+
+[packages/types/src/pricing/common/money-amount.ts:40](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/money-amount.ts#L40)
+
+___
+
+### currency\_code
+
+ **currency\_code**: `string`
+
+A string that indicates the currency code of this money amount.
+
+#### Inherited from
+
+[CreateMoneyAmountDTO](CreateMoneyAmountDTO.md).[currency_code](CreateMoneyAmountDTO.md#currency_code)
+
+#### Defined in
+
+[packages/types/src/pricing/common/money-amount.ts:39](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/money-amount.ts#L39)
+
+___
+
+### id
+
+ `Optional` **id**: `string`
+
+A string that indicates the ID of the money amount.
+
+#### Inherited from
+
+[CreateMoneyAmountDTO](CreateMoneyAmountDTO.md).[id](CreateMoneyAmountDTO.md#id)
+
+#### Defined in
+
+[packages/types/src/pricing/common/money-amount.ts:38](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/money-amount.ts#L38)
+
+___
+
+### max\_quantity
+
+ `Optional` **max\_quantity**: `number`
+
+A number that indicates the maximum quantity required to be purchased for this money amount to be applied.
+
+#### Inherited from
+
+[CreateMoneyAmountDTO](CreateMoneyAmountDTO.md).[max_quantity](CreateMoneyAmountDTO.md#max_quantity)
+
+#### Defined in
+
+[packages/types/src/pricing/common/money-amount.ts:43](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/money-amount.ts#L43)
+
+___
+
+### min\_quantity
+
+ `Optional` **min\_quantity**: `number`
+
+A number that indicates the minimum quantity required to be purchased for this money amount to be applied.
+
+#### Inherited from
+
+[CreateMoneyAmountDTO](CreateMoneyAmountDTO.md).[min_quantity](CreateMoneyAmountDTO.md#min_quantity)
+
+#### Defined in
+
+[packages/types/src/pricing/common/money-amount.ts:42](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/money-amount.ts#L42)
+
+___
+
+### rules
+
+ **rules**: [`Record`](../types/Record.md)<`string`, `string`\>
+
+An object whose keys are rule types' `rule_attribute` attribute, and values are the value of that rule associated with this price.
+
+#### Defined in
+
+[packages/types/src/pricing/common/price-set.ts:93](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-set.ts#L93)