docs: generate pricing module reference (#5349)

* docs: generate pricing module reference

* added notes about new configurations
This commit is contained in:
Shahed Nasser
2023-10-11 14:08:19 +03:00
committed by GitHub
parent 9c1c19f409
commit f0af8ecc89
110 changed files with 7170 additions and 146 deletions

View File

@@ -0,0 +1,69 @@
---
displayed_sidebar: pricingReference
---
# UpdateMoneyAmountDTO
*
An object that holds data to update a money amount.
## Properties
### amount
`Optional` **amount**: `number`
A number indicating the amount of this money amount.
#### Defined in
[packages/types/src/pricing/common/money-amount.ts:61](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/money-amount.ts#L61)
___
### currency\_code
`Optional` **currency\_code**: `string`
A string that indicates the currency code of the money amount.
#### Defined in
[packages/types/src/pricing/common/money-amount.ts:60](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/money-amount.ts#L60)
___
### id
**id**: `string`
A string that indicates the ID of the money amount to update.
#### Defined in
[packages/types/src/pricing/common/money-amount.ts:59](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/money-amount.ts#L59)
___
### max\_quantity
`Optional` **max\_quantity**: `number`
A number that indicates the maximum quantity required to be purchased for this money amount to be applied.
#### Defined in
[packages/types/src/pricing/common/money-amount.ts:63](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/money-amount.ts#L63)
___
### min\_quantity
`Optional` **min\_quantity**: `number`
A number that indicates the minimum quantity required to be purchased for this money amount to be applied.
#### Defined in
[packages/types/src/pricing/common/money-amount.ts:62](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/money-amount.ts#L62)