chore(docs): Generated References (#5743)

Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions

View File

@@ -0,0 +1,114 @@
---
displayed_sidebar: workflowsSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# getFlow
[LocalWorkflow](../../classes/LocalWorkflow.mdx).getFlow
## Returns
<ParameterTypes parameters={[
{
"name": "TransactionStepsDefinition",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "action",
"type": "`string`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "async",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "continueOnPermanentFailure",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maxRetries",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "next",
"type": "[TransactionStepsDefinition](../../types/TransactionStepsDefinition.mdx) \\| [TransactionStepsDefinition](../../types/TransactionStepsDefinition.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "noCompensation",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "noWait",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "retryInterval",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "saveResponse",
"type": "`boolean`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "timeout",
"type": "`number`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]} />

View File

@@ -13,6 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
- [assertHandler](../LocalWorkflow/methods/LocalWorkflow.assertHandler.mdx)
- [commit](../LocalWorkflow/methods/LocalWorkflow.commit.mdx)
- [deleteAction](../LocalWorkflow/methods/LocalWorkflow.deleteAction.mdx)
- [getFlow](../LocalWorkflow/methods/LocalWorkflow.getFlow.mdx)
- [insertActionAfter](../LocalWorkflow/methods/LocalWorkflow.insertActionAfter.mdx)
- [insertActionBefore](../LocalWorkflow/methods/LocalWorkflow.insertActionBefore.mdx)
- [mergeActions](../LocalWorkflow/methods/LocalWorkflow.mergeActions.mdx)

View File

@@ -6,7 +6,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# ReturnWorkflow
**ReturnWorkflow**: `<TDataOverride, TResultOverride>`(`container?`: [MedusaContainer](MedusaContainer.mdx) \| ``{ __definition: [ModuleDefinition](ModuleDefinition.mdx) ; __joinerConfig: [ModuleJoinerConfig](ModuleJoinerConfig.mdx) }``[]) => Omit&#60;[LocalWorkflow](../classes/LocalWorkflow.mdx), "run"&#62; & ``{ run: (args?: [FlowRunOptions](FlowRunOptions.mdx)&#60;TDataOverride extends undefined ? TData : TDataOverride&#62;) => Promise&#60;[WorkflowResult](WorkflowResult.mdx)&#60;TResultOverride extends undefined ? TResult : TResultOverride&#62;&#62; }`` & `THooks`
**ReturnWorkflow**: `<TDataOverride, TResultOverride>`(`container?`: [MedusaContainer](MedusaContainer.mdx) \| ``{ __definition: [ModuleDefinition](ModuleDefinition.mdx) ; __joinerConfig: [ModuleJoinerConfig](ModuleJoinerConfig.mdx) }``[]) => Omit&#60;[LocalWorkflow](../classes/LocalWorkflow.mdx), "run"&#62; & ``{ run: (args?: [FlowRunOptions](FlowRunOptions.mdx)&#60;TDataOverride extends undefined ? TData : TDataOverride&#62;) => Promise&#60;[WorkflowResult](WorkflowResult.mdx)&#60;TResultOverride extends undefined ? TResult : TResultOverride&#62;&#62; }`` & `THooks` & ``{ getName: () => string }``
An exported workflow, which is the type of a workflow constructed by the [createWorkflow](../functions/createWorkflow.mdx) function. The exported workflow can be invoked to create
an executable workflow, optionally within a specified container. So, to execute the workflow, you must invoke the exported workflow, then run the