asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#8828)

Browse Source 
Generated the following references:
- `auth`
- `core_flows`
- `fulfillment`
- `fulfillment_models`
- `helper_steps`
- `medusa_config`
- `modules`
- `modules_sdk`
- `order`
- `order_models`
- `payment`
- `stock_location_next`
- `types`
This commit is contained in:
github-actions[bot] authored and GitHub committed 2024-08-28 06:53:38 +00:00
1 parent e0a3b8fc2e
commit 841cb69ba9
368 files changed
+2054775 -101249
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/helper_steps/functions/helper_steps.createRemoteLinkStep/page.mdx
+2 -2
View File
@@ -32,8 +32,8 @@ const helloWorldWorkflow = createWorkflow("hello-world", () => {
## Input
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"`object` & `object`","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRemoteLinkStep"/>
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"`object` & `object`","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRemoteLinkStep"/>
## Output
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"`object` & `object`","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRemoteLinkStep"/>
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"`object` & `object`","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRemoteLinkStep"/>
www/apps/resources/references/helper_steps/functions/helper_steps.dismissRemoteLinkStep/page.mdx
+3 -3
View File
@@ -12,7 +12,7 @@ This documentation provides a reference to the `dismissRemoteLinkStep` step. It
## Example
```ts
import {
import {
createWorkflow
} from "@medusajs/workflows-sdk"
import {
@@ -39,8 +39,8 @@ const helloWorldWorkflow = createWorkflow(
## Input
<TypeList types={[{"name":"DismissRemoteLinksStepInput","type":"[DismissRemoteLinksStepInput](../../types/helper_steps.DismissRemoteLinksStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"DismissRemoteLinksStepInput","type":"[LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx) \\| [LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="dismissRemoteLinkStep"/>
<TypeList types={[{"name":"DismissRemoteLinksStepInput","type":"[DismissRemoteLinksStepInput](../../types/helper_steps.DismissRemoteLinksStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"DismissRemoteLinksStepInput","type":"[LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx) \\| [LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="dismissRemoteLinkStep"/>
## Output
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"`object` & `object`","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="dismissRemoteLinkStep"/>
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"`object` & `object`","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="dismissRemoteLinkStep"/>
www/apps/resources/references/helper_steps/functions/helper_steps.emitEventStep/page.mdx
+1 -1
View File
@@ -12,7 +12,7 @@ This documentation provides a reference to the `emitEventStep` step. It belongs
## Example
```ts
import {
import {
createWorkflow
} from "@medusajs/workflows-sdk"
import {
www/apps/resources/references/helper_steps/functions/helper_steps.updateRemoteLinksStep/page.mdx
+2 -2
View File
@@ -11,8 +11,8 @@ This documentation provides a reference to the `updateRemoteLinksStep` step. It
## Input
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"`object` & `object`","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRemoteLinksStep"/>
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"`object` & `object`","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRemoteLinksStep"/>
## Output
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"`object` & `object`","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRemoteLinksStep"/>
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"`object` & `object`","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRemoteLinksStep"/>
www/apps/resources/references/helper_steps/types/helper_steps.DismissRemoteLinksStepInput/page.mdx
+1 -1
View File
@@ -2,4 +2,4 @@ import { TypeList } from "docs-ui"
# DismissRemoteLinksStepInput
**DismissRemoteLinksStepInput**: [LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx) \| [LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)[]
**DismissRemoteLinksStepInput**: [LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx) \| [LinkDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]