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,81 @@
+---
+displayed_sidebar: pricingReference
+---
+
+# JoinerServiceConfig
+
+## Properties
+
+### alias
+
+ `Optional` **alias**: [`JoinerServiceConfigAlias`](JoinerServiceConfigAlias.md) \| [`JoinerServiceConfigAlias`](JoinerServiceConfigAlias.md)[]
+
+Property name to use as entrypoint to the service
+
+#### Defined in
+
+[packages/types/src/joiner/index.ts:38](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/joiner/index.ts#L38)
+
+___
+
+### args
+
+ `Optional` **args**: [`Record`](../types/Record.md)<`string`, `any`\>
+
+Extra arguments to pass to the remoteFetchData callback
+
+#### Defined in
+
+[packages/types/src/joiner/index.ts:59](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/joiner/index.ts#L59)
+
+___
+
+### extends
+
+ `Optional` **extends**: { `relationship`: [`JoinerRelationship`](../types/JoinerRelationship.md) ; `serviceName`: `string`  }[]
+
+#### Defined in
+
+[packages/types/src/joiner/index.ts:52](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/joiner/index.ts#L52)
+
+___
+
+### fieldAlias
+
+ `Optional` **fieldAlias**: [`Record`](../types/Record.md)<`string`, `string` \| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string`  }\>
+
+alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })
+
+#### Defined in
+
+[packages/types/src/joiner/index.ts:42](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/joiner/index.ts#L42)
+
+___
+
+### primaryKeys
+
+ **primaryKeys**: `string`[]
+
+#### Defined in
+
+[packages/types/src/joiner/index.ts:50](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/joiner/index.ts#L50)
+
+___
+
+### relationships
+
+ `Optional` **relationships**: [`JoinerRelationship`](../types/JoinerRelationship.md)[]
+
+#### Defined in
+
+[packages/types/src/joiner/index.ts:51](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/joiner/index.ts#L51)
+
+___
+
+### serviceName
+
+ **serviceName**: `string`
+
+#### Defined in
+
+[packages/types/src/joiner/index.ts:34](https://github.com/medusajs/medusa/blob/daea35fe73/packages/types/src/joiner/index.ts#L34)