chore(docs): Generated Pricing Module Reference (#5432)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-10-20 12:08:59 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 39de54e2e8
commit 0ffa48b07f
81 changed files with 9511 additions and 129 deletions
@@ -8,4 +8,61 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Properties
<ParameterTypes parameters={[{"name":"alias","type":"[`JoinerServiceConfigAlias`](JoinerServiceConfigAlias.mdx) \\| [`JoinerServiceConfigAlias`](JoinerServiceConfigAlias.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","children":[]},{"name":"args","type":"Record<`string`, `any`\\>","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","children":[]},{"name":"extends","type":"{ `relationship`: [`JoinerRelationship`](../types/JoinerRelationship.mdx) ; `serviceName`: `string` }[]","description":"","optional":true,"defaultValue":"","children":[]},{"name":"fieldAlias","type":"Record<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\>","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })","optional":true,"defaultValue":"","children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":false,"defaultValue":"","children":[]},{"name":"relationships","type":"[`JoinerRelationship`](../types/JoinerRelationship.mdx)[]","description":"","optional":true,"defaultValue":"","children":[]},{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","children":[]}]} />
<ParameterTypes parameters={[
{
"name": "alias",
"type": "[`JoinerServiceConfigAlias`](JoinerServiceConfigAlias.mdx) \\| [`JoinerServiceConfigAlias`](JoinerServiceConfigAlias.mdx)[]",
"description": "Property name to use as entrypoint to the service",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "args",
"type": "Record<`string`, `any`\\>",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "extends",
"type": "{ `relationship`: [`JoinerRelationship`](../types/JoinerRelationship.mdx) ; `serviceName`: `string` }[]",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "fieldAlias",
"type": "Record<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\>",
"description": "alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "primaryKeys",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "relationships",
"type": "[`JoinerRelationship`](../types/JoinerRelationship.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "serviceName",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"children": []
}
]} />