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,32 @@
---
displayed_sidebar: pricingReference
---
# CreatePriceSetDTO
An object of expected properties when creating a price set.
## Properties
### prices
`Optional` **prices**: [`CreatePricesDTO`](CreatePricesDTO.md)[]
An array of objects of type [CreatePricesDTO](CreatePricesDTO.md), each being a price to associate with the price set.
#### Defined in
[packages/types/src/pricing/common/price-set.ts:134](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-set.ts#L134)
___
### rules
`Optional` **rules**: { `rule_attribute`: `string` }[]
An array of objects, each object accepts a property `rule_attribute`, whose value is a string indicating the `rule_attribute` value of a rule type.
This property is used to specify the rule types associated with the price set.
#### Defined in
[packages/types/src/pricing/common/price-set.ts:133](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-set.ts#L133)