chore(docs): Generated References (#8360)

Generated the following references: - `currency_models` - `medusa_config` - `region_models` - `types`
2024-07-31 07:31:20 +00:00
1 parent 69ddd1e081
commit aac906f058
@@ -0,0 +1,18 @@
+---
+slug: /references/helper-steps/createRemoteLinkStep
+sidebar_label: createRemoteLinkStep
+---
+
+import { TypeList } from "docs-ui"
+
+# createRemoteLinkStep - Helper Steps API Reference
+
+This documentation provides a reference to the `createRemoteLinkStep` step. It belongs to the `@medusajs/core-flows` package.
+
+## 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":[]}]}]}  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":[]}]}]}  sectionTitle="createRemoteLinkStep"/>
@@ -0,0 +1,18 @@
+---
+slug: /references/helper-steps/dismissRemoteLinkStep
+sidebar_label: dismissRemoteLinkStep
+---
+
+import { TypeList } from "docs-ui"
+
+# dismissRemoteLinkStep - Helper Steps API Reference
+
+This documentation provides a reference to the `dismissRemoteLinkStep` step. It belongs to the `@medusajs/core-flows` package.
+
+## Input
+
+<TypeList types={[{"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":[]}]}  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":[]}]}]}  sectionTitle="dismissRemoteLinkStep"/>
@@ -0,0 +1,18 @@
+---
+slug: /references/helper-steps/removeRemoteLinkStep
+sidebar_label: removeRemoteLinkStep
+---
+
+import { TypeList } from "docs-ui"
+
+# removeRemoteLinkStep - Helper Steps API Reference
+
+This documentation provides a reference to the `removeRemoteLinkStep` step. It belongs to the `@medusajs/core-flows` package.
+
+## Input
+
+<TypeList types={[{"name":"RemoveRemoteLinksStepInput","type":"`RemoveRemoteLinksStepInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}  sectionTitle="removeRemoteLinkStep"/>
+
+## Output
+
+<TypeList types={[{"name":"DeleteEntityInput","type":"`object`","description":"The details of a data model's record whose linked records should be deleted. Usually used after the\ndata model's record is deleted.\n\nThe key is the data model's name. Its value is an object that has the ID of the data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="removeRemoteLinkStep"/>
@@ -0,0 +1,18 @@
+---
+slug: /references/helper-steps/useRemoteQueryStep
+sidebar_label: useRemoteQueryStep
+---
+
+import { TypeList } from "docs-ui"
+
+# useRemoteQueryStep - Helper Steps API Reference
+
+This documentation provides a reference to the `useRemoteQueryStep` step. It belongs to the `@medusajs/core-flows` package.
+
+## Input
+
+<TypeList types={[{"name":"EntryStepInput \\| ServiceStepInput","type":"[EntryStepInput](../../interfaces/helper_steps.EntryStepInput/page.mdx) \\| [ServiceStepInput](../../interfaces/helper_steps.ServiceStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}  sectionTitle="useRemoteQueryStep"/>
+
+## Output
+
+<TypeList types={[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}  sectionTitle="useRemoteQueryStep"/>
@@ -0,0 +1,7 @@
+import { TypeList } from "docs-ui"
+
+# EntryStepInput
+
+The remote query's details.
+
+<TypeList types={[{"name":"fields","type":"`string`[]","description":"The fields to retrieve in the records.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entry_point","type":"`string`","description":"The name of the data model to retrieve its records.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variables","type":"`Record<string, any>`","description":"Filters, context variables, or pagination fields to apply when retrieving the records.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_key_not_found","type":"`boolean`","description":"Throw an error if a record isn't found matching an ID specified in the filters.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_relation_not_found","type":"`boolean` \\| `string`[]","description":"Throw an error if a specified relation isn't found.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"`boolean`","description":"Whether to retrieve the records as an array. If disabled, only one record is retrieved as an object.","optional":true,"defaultValue":"true","expandable":false,"children":[]}]}  sectionTitle="EntryStepInput"/>
@@ -0,0 +1,7 @@
+import { TypeList } from "docs-ui"
+
+# RemoteStepInput
+
+The remote query's details.
+
+<TypeList types={[{"name":"fields","type":"`string`[]","description":"The fields to retrieve in the records.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variables","type":"`Record<string, any>`","description":"Filters, context variables, or pagination fields to apply when retrieving the records.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_key_not_found","type":"`boolean`","description":"Throw an error if a record isn't found matching an ID specified in the filters.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_relation_not_found","type":"`boolean` \\| `string`[]","description":"Throw an error if a specified relation isn't found.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"`boolean`","description":"Whether to retrieve the records as an array. If disabled, only one record is retrieved as an object.","optional":true,"defaultValue":"true","expandable":false,"children":[]}]}  sectionTitle="RemoteStepInput"/>
@@ -0,0 +1,7 @@
+import { TypeList } from "docs-ui"
+
+# ServiceStepInput
+
+The remote query's details.
+
+<TypeList types={[{"name":"fields","type":"`string`[]","description":"The fields to retrieve in the records.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service","type":"`string`","description":"The name of the module's service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variables","type":"`Record<string, any>`","description":"Filters, context variables, or pagination fields to apply when retrieving the records.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_key_not_found","type":"`boolean`","description":"Throw an error if a record isn't found matching an ID specified in the filters.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_relation_not_found","type":"`boolean` \\| `string`[]","description":"Throw an error if a specified relation isn't found.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"`boolean`","description":"Whether to retrieve the records as an array. If disabled, only one record is retrieved as an object.","optional":true,"defaultValue":"true","expandable":false,"children":[]}]}  sectionTitle="ServiceStepInput"/>
@@ -0,0 +1,5 @@
+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)[]
@@ -0,0 +1,5 @@
+import { TypeList } from "docs-ui"
+
+# createLinksStepId
+
+ `Const` **createLinksStepId**: `"create-remote-links"`
@@ -0,0 +1,5 @@
+import { TypeList } from "docs-ui"
+
+# dismissRemoteLinkStepId
+
+ `Const` **dismissRemoteLinkStepId**: `"dismiss-remote-links"`
@@ -0,0 +1,5 @@
+import { TypeList } from "docs-ui"
+
+# emitEventStepId
+
+ `Const` **emitEventStepId**: `"emit-event-step"`
@@ -0,0 +1,5 @@
+import { TypeList } from "docs-ui"
+
+# removeRemoteLinkStepId
+
+ `Const` **removeRemoteLinkStepId**: `"remove-remote-links"`
@@ -0,0 +1,5 @@
+import { TypeList } from "docs-ui"
+
+# useRemoteQueryStepId
+
+ `Const` **useRemoteQueryStepId**: `"use-remote-query"`