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,103 @@
+---
+displayed_sidebar: pricingReference
+---
+
+# CreatePriceRuleDTO
+
+An object used to specify the necessary data to create a price rule.
+
+## Properties
+
+### id
+
+ **id**: `string`
+
+A string indicating the ID of the price rule.
+
+#### Defined in
+
+[packages/types/src/pricing/common/price-rule.ts:50](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L50)
+
+___
+
+### is\_dynamic
+
+ `Optional` **is\_dynamic**: `boolean`
+
+A boolean indicating whether the price rule is dynamic.
+
+#### Defined in
+
+[packages/types/src/pricing/common/price-rule.ts:53](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L53)
+
+___
+
+### price\_list\_id
+
+ **price\_list\_id**: `string`
+
+A string indicating the ID of the associated price list.
+
+#### Defined in
+
+[packages/types/src/pricing/common/price-rule.ts:57](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L57)
+
+___
+
+### price\_set\_id
+
+ **price\_set\_id**: `string`
+
+A string indicating the ID of the associated price set.
+
+#### Defined in
+
+[packages/types/src/pricing/common/price-rule.ts:51](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L51)
+
+___
+
+### price\_set\_money\_amount\_id
+
+ **price\_set\_money\_amount\_id**: `string`
+
+A string indicating the ID of the associated price set money amount.
+
+#### Defined in
+
+[packages/types/src/pricing/common/price-rule.ts:56](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L56)
+
+___
+
+### priority
+
+ `Optional` **priority**: `number`
+
+A number indicating the priority of the price rule in comparison to other applicable price rules.
+
+#### Defined in
+
+[packages/types/src/pricing/common/price-rule.ts:55](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L55)
+
+___
+
+### rule\_type\_id
+
+ **rule\_type\_id**: `string`
+
+A string indicating the ID of the associated rule type.
+
+#### Defined in
+
+[packages/types/src/pricing/common/price-rule.ts:52](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L52)
+
+___
+
+### value
+
+ **value**: `string`
+
+A string indicating the value of the price rule.
+
+#### Defined in
+
+[packages/types/src/pricing/common/price-rule.ts:54](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/price-rule.ts#L54)