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,56 @@
+---
+displayed_sidebar: pricingReference
+---
+
+# CurrencyDTO
+
+An object representing a currency.
+
+## Properties
+
+### code
+
+ **code**: `string`
+
+a string indicating the code of the currency.
+
+#### Defined in
+
+[packages/types/src/pricing/common/currency.ts:16](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/currency.ts#L16)
+
+___
+
+### name
+
+ `Optional` **name**: `string`
+
+a string indicating the name of the currency.
+
+#### Defined in
+
+[packages/types/src/pricing/common/currency.ts:19](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/currency.ts#L19)
+
+___
+
+### symbol
+
+ `Optional` **symbol**: `string`
+
+a string indicating the symbol of the currency.
+
+#### Defined in
+
+[packages/types/src/pricing/common/currency.ts:17](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/currency.ts#L17)
+
+___
+
+### symbol\_native
+
+ `Optional` **symbol\_native**: `string`
+
+a string indicating the symbol of the currecy in its native form.
+This is typically the symbol used when displaying a price.
+
+#### Defined in
+
+[packages/types/src/pricing/common/currency.ts:18](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/pricing/common/currency.ts#L18)