chore(docs): Generated References (#8360)
Generated the following references: - `currency_models` - `medusa_config` - `region_models` - `types`
This commit is contained in:
github-actions[bot]
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Currency . This belongs to the Currency Module.
|
||||
|
||||
<TypeList types={[{"name":"code","type":"PrimaryKeyModifier<TextProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"decimal_digits","type":"`NumberProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rounding","type":"`BigNumberProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Currency"/>
|
||||
<TypeList types={[{"name":"code","type":"PrimaryKeyModifier<TextProperty>","description":"The ISO 3-character currency code. For example, `USD`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`TextProperty`","description":"The symbol of the currency. For example, `$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`TextProperty`","description":"The native symbol of the currency, if it has a different local symbol.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"decimal_digits","type":"`NumberProperty`","description":"How many digits are after the decimal separator for prices in this currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rounding","type":"`BigNumberProperty`","description":"The rounding percision of prices in this currency.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Currency"/>
|
||||
|
||||
+18
@@ -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"/>
|
||||
+18
@@ -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"/>
|
||||
+18
@@ -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"/>
|
||||
+18
@@ -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"/>
|
||||
+7
@@ -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"/>
|
||||
+7
@@ -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"/>
|
||||
+7
@@ -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"/>
|
||||
+5
@@ -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)[]
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# createLinksStepId
|
||||
|
||||
`Const` **createLinksStepId**: `"create-remote-links"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# dismissRemoteLinkStepId
|
||||
|
||||
`Const` **dismissRemoteLinkStepId**: `"dismiss-remote-links"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# emitEventStepId
|
||||
|
||||
`Const` **emitEventStepId**: `"emit-event-step"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# removeRemoteLinkStepId
|
||||
|
||||
`Const` **removeRemoteLinkStepId**: `"remove-remote-links"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# useRemoteQueryStepId
|
||||
|
||||
`Const` **useRemoteQueryStepId**: `"use-remote-query"`
|
||||
+1
-1
File diff suppressed because one or more lines are too long
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/helper-steps
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Helper Steps API Reference
|
||||
|
||||
This section of the documentation provides a reference to utility steps that you can use in your workflows. These steps are imported from the `@medusajs/core-flows` package.
|
||||
|
||||
## Steps
|
||||
|
||||
- [createRemoteLinkStep](../../helper_steps/functions/helper_steps.createRemoteLinkStep/page.mdx)
|
||||
- [dismissRemoteLinkStep](../../helper_steps/functions/helper_steps.dismissRemoteLinkStep/page.mdx)
|
||||
- [removeRemoteLinkStep](../../helper_steps/functions/helper_steps.removeRemoteLinkStep/page.mdx)
|
||||
- [useRemoteQueryStep](../../helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx)
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,89 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# RemoteLink
|
||||
|
||||
## constructor
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"modulesLoaded","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/modules_sdk.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"[JoinerServiceConfigAlias](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\\_price\\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/modules_sdk.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"__definition","type":"[ModuleDefinition](../../types/modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPackage","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","type":"[InternalModuleDeclaration](../../types/modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/modules_sdk.ExternalModuleDeclaration/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isRequired","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isQueryable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="new RemoteLink"/>
|
||||
|
||||
___
|
||||
|
||||
## Methods
|
||||
|
||||
### addModule
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"mod","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/modules_sdk.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"[JoinerServiceConfigAlias](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\\_price\\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/modules_sdk.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"__definition","type":"[ModuleDefinition](../../types/modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPackage","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","type":"[InternalModuleDeclaration](../../types/modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/modules_sdk.ExternalModuleDeclaration/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isRequired","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isQueryable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="addModule"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="addModule"/>
|
||||
|
||||
### getLinkModule
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"moduleA","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleAKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleB","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleBKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="getLinkModule"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"undefined \\| LoadedLinkModule","type":"`undefined` \\| `LoadedLinkModule`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="getLinkModule"/>
|
||||
|
||||
### getRelationships
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Map","type":"Map<string, Map<string, RemoteRelationship[]>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Map","type":"Map<string, RemoteRelationship[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"RemoteRelationship[]","type":"`RemoteRelationship`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="getRelationships"/>
|
||||
|
||||
### create
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"link","type":"[LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx) \\| [LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="create"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<unknown[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"unknown[]","type":"`unknown`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"unknown","type":"`unknown`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="create"/>
|
||||
|
||||
### dismiss
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"link","type":"[LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx) \\| [LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="dismiss"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<unknown[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"unknown[]","type":"`unknown`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"unknown","type":"`unknown`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="dismiss"/>
|
||||
|
||||
### delete
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"removedServices","type":"[DeleteEntityInput](../../types/modules_sdk.DeleteEntityInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="delete"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[null \\| CascadeError[], RemovedIds]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"null \\| CascadeError[]","type":"`null` \\| `CascadeError`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"RemovedIds","type":"`RemovedIds`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="delete"/>
|
||||
|
||||
### restore
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"removedServices","type":"[DeleteEntityInput](../../types/modules_sdk.DeleteEntityInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="restore"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[null \\| CascadeError[], RemovedIds]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"null \\| CascadeError[]","type":"`null` \\| `CascadeError`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"RemovedIds","type":"`RemovedIds`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="restore"/>
|
||||
|
||||
### list
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"link","type":"[LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx) \\| [LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"asLinkDefinition","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="list"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<(object \\| [LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx))[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"(object \\| LinkDefinition)[]","type":"(`object` \\| [LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx))[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"object \\| LinkDefinition","type":"`object` \\| [LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="list"/>
|
||||
File diff suppressed because one or more lines are too long
+13
@@ -0,0 +1,13 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# MODULE\_RESOURCE\_TYPE
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### SHARED
|
||||
|
||||
**SHARED** = `"shared"`
|
||||
|
||||
### ISOLATED
|
||||
|
||||
**ISOLATED** = `"isolated"`
|
||||
@@ -0,0 +1,13 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# MODULE\_SCOPE
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### INTERNAL
|
||||
|
||||
**INTERNAL** = `"internal"`
|
||||
|
||||
### EXTERNAL
|
||||
|
||||
**EXTERNAL** = `"external"`
|
||||
+229
File diff suppressed because one or more lines are too long
+3
@@ -0,0 +1,3 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# IModuleService
|
||||
+6
@@ -0,0 +1,6 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ModuleImplementations
|
||||
|
||||
The following interface acts as a bucket that other modules or the
|
||||
utils package can fill using declaration merging
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ModuleServiceInitializeOptions
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"database","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"connection","type":"`any`","description":"Forces to use a shared knex connection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"clientUrl","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"host","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"port","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"password","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"database","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"driverOptions","type":"`Record<string, unknown>` & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"connection","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pool","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="ModuleServiceInitializeOptions"/>
|
||||
@@ -0,0 +1,15 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Constructor
|
||||
|
||||
**Constructor**: (...`args`: `any`[]) => T \| () => T
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Constructor"/>
|
||||
|
||||
## Type declaration
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ContainerLike
|
||||
|
||||
**ContainerLike**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"resolve","type":"`<T>`(`key`: `string`) => T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ContainerLike"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# CustomModuleDefinition
|
||||
|
||||
**CustomModuleDefinition**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isQueryable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="CustomModuleDefinition"/>
|
||||
+10
@@ -0,0 +1,10 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# DeleteEntityInput
|
||||
|
||||
**DeleteEntityInput**: `object`
|
||||
|
||||
The details of a data model's record whose linked records should be deleted. Usually used after the
|
||||
data model's record is deleted.
|
||||
|
||||
The key is the data model's name. Its value is an object that has the ID of the data model's record.
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ExternalModuleDeclaration
|
||||
|
||||
**ExternalModuleDeclaration**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"scope","type":"`\"external\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isQueryable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"server","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"`\"http\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"keepAlive","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"If multiple modules are registered with the same key, the alias can be used to differentiate them","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"main","type":"`boolean`","description":"If the module is the main module for the key when multiple ones are registered","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ExternalModuleDeclaration"/>
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# GenerateMigrations
|
||||
|
||||
**GenerateMigrations**: (`moduleNames`: `string`[]) => Promise<void>
|
||||
|
||||
## Type declaration
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"moduleNames","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# GetLinkExecutionPlanner
|
||||
|
||||
**GetLinkExecutionPlanner**: () => [ILinkMigrationsPlanner](../../../types/interfaces/types.ILinkMigrationsPlanner/page.mdx)
|
||||
|
||||
## Type declaration
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"createPlan","type":"() => Promise<[LinkMigrationsPlannerAction](../../../types/types/types.LinkMigrationsPlannerAction/page.mdx)[]>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"executePlan","type":"(`actions`: [LinkMigrationsPlannerAction](../../../types/types/types.LinkMigrationsPlannerAction/page.mdx)[]) => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# InternalModuleDeclaration
|
||||
|
||||
**InternalModuleDeclaration**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"scope","type":"`\"internal\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resources","type":"`\"shared\"` \\| `\"isolated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isQueryable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"resolve","type":"`string` \\| [ModuleExports](../modules_sdk.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"service","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"loaders","type":"[ModuleLoaderFunction](../modules_sdk.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"If multiple modules are registered with the same key, the alias can be used to differentiate them","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"main","type":"`boolean`","description":"If the module is the main module for the key when multiple ones are registered","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"worker_mode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="InternalModuleDeclaration"/>
|
||||
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# LinkDefinition
|
||||
|
||||
**LinkDefinition**: `object` & `object`
|
||||
|
||||
A link for two records of linked data models.
|
||||
|
||||
The keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.
|
||||
+9
File diff suppressed because one or more lines are too long
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# LinkModuleDefinition
|
||||
|
||||
**LinkModuleDefinition**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","type":"[InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"scope","type":"`\"internal\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resources","type":"`\"shared\"` \\| `\"isolated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isQueryable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"resolve","type":"`string` \\| [ModuleExports](../modules_sdk.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"service","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"loaders","type":"[ModuleLoaderFunction](../modules_sdk.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"If multiple modules are registered with the same key, the alias can be used to differentiate them","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"main","type":"`boolean`","description":"If the module is the main module for the key when multiple ones are registered","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"worker_mode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="LinkModuleDefinition"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# LinkModulesExtraFields
|
||||
|
||||
**LinkModulesExtraFields**: `Record<string, object>`
|
||||
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# LoadedModule
|
||||
|
||||
**LoadedModule**: `unknown` & `object`
|
||||
@@ -0,0 +1,13 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# LoaderOptions
|
||||
|
||||
**LoaderOptions**: `Object`
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"TOptions","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="LoaderOptions"/>
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"container","type":"[MedusaContainer](../modules_sdk.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"TOptions","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"logger","type":"[Logger](../../../types/LoggerTypes/interfaces/types.LoggerTypes.Logger/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"panic","type":"(`data`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shouldLog","type":"(`level`: `string`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"setLogLevel","type":"(`level`: `string`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unsetLogLevel","type":"() => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"activity","type":"(`message`: `string`, `config?`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"error","type":"(`messageOrError`: `any`, `error?`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"failure","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"success","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"log","type":"(...`args`: `any`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"dataLoaderOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="LoaderOptions"/>
|
||||
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# LogLevel
|
||||
|
||||
**LogLevel**: `"query"` \| `"schema"` \| `"error"` \| `"warn"` \| `"info"` \| `"log"` \| `"migration"`
|
||||
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# LoggerOptions
|
||||
|
||||
**LoggerOptions**: `boolean` \| `"all"` \| [LogLevel](../modules_sdk.LogLevel/page.mdx)[]
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# MedusaAppOutput
|
||||
|
||||
**MedusaAppOutput**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"modules","type":"`Record<string, [LoadedModule](../modules_sdk.LoadedModule/page.mdx) \\| [LoadedModule](../modules_sdk.LoadedModule/page.mdx)[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"link","type":"[RemoteLink](../../classes/modules_sdk.RemoteLink/page.mdx) \\| `undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[RemoteQueryFunction](../modules_sdk.RemoteQueryFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"runMigrations","type":"[RunMigrationFn](../modules_sdk.RunMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revertMigrations","type":"[RevertMigrationFn](../modules_sdk.RevertMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"generateMigrations","type":"[GenerateMigrations](../modules_sdk.GenerateMigrations/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"linkMigrationExecutionPlanner","type":"[GetLinkExecutionPlanner](../modules_sdk.GetLinkExecutionPlanner/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStart","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entitiesMap","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"notFound","type":"`Record<string, Record<string, string>>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../modules_sdk.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="MedusaAppOutput"/>
|
||||
@@ -0,0 +1,12 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# MedusaContainer
|
||||
|
||||
**MedusaContainer**: Omit<AwilixContainer, "resolve"> & `object`
|
||||
|
||||
The Medusa Container extends [Awilix](https://github.com/jeffijoe/awilix) to
|
||||
provide dependency injection functionalities.
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"Cradle","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="MedusaContainer"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# MedusaModuleConfig
|
||||
|
||||
**MedusaModuleConfig**: `object`
|
||||
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# MigrationOptions
|
||||
|
||||
**MigrationOptions**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"moduleKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"modulePath","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../modules_sdk.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleExports","type":"[ModuleExports](../modules_sdk.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"service","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"loaders","type":"[ModuleLoaderFunction](../modules_sdk.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="MigrationOptions"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ModuleBootstrapDeclaration
|
||||
|
||||
**ModuleBootstrapDeclaration**: [InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx) \| [ExternalModuleDeclaration](../modules_sdk.ExternalModuleDeclaration/page.mdx)
|
||||
+9
File diff suppressed because one or more lines are too long
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ModuleConfig
|
||||
|
||||
**ModuleConfig**: [ModuleDeclaration](../../../types/types/types.ModuleDeclaration/page.mdx) & `object`
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,13 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ModuleExports
|
||||
|
||||
**ModuleExports**: `Object`
|
||||
|
||||
## Type Parameters
|
||||
|
||||
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ModuleExports"/>
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"service","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"loaders","type":"[ModuleLoaderFunction](../modules_sdk.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runMigrations","type":"(`options`: [LoaderOptions](../modules_sdk.LoaderOptions/page.mdx)<any>, `moduleDeclaration?`: [InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx)) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revertMigration","type":"(`options`: [LoaderOptions](../modules_sdk.LoaderOptions/page.mdx)<any>, `moduleDeclaration?`: [InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx)) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"generateMigration","type":"(`options`: [LoaderOptions](../modules_sdk.LoaderOptions/page.mdx)<any>, `moduleDeclaration?`: [InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx)) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ModuleExports"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ModuleJoinerConfig
|
||||
|
||||
**ModuleJoinerConfig**: Omit<[JoinerServiceConfig](../../../types/interfaces/types.JoinerServiceConfig/page.mdx), "serviceName" \| "primaryKeys" \| "relationships" \| "extends"> & `object`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ModuleJoinerRelationship
|
||||
|
||||
**ModuleJoinerRelationship**: [JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx) & `object`
|
||||
+15
File diff suppressed because one or more lines are too long
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ModuleProvider
|
||||
|
||||
**ModuleProvider**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../modules_sdk.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"services","type":"[Constructor](../modules_sdk.Constructor/page.mdx)<any>[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ModuleProvider"/>
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ModuleProviderExports
|
||||
|
||||
**ModuleProviderExports**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"services","type":"[Constructor](../modules_sdk.Constructor/page.mdx)<any>[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ModuleProviderExports"/>
|
||||
File diff suppressed because one or more lines are too long
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ModuleServiceInitializeCustomDataLayerOptions
|
||||
|
||||
**ModuleServiceInitializeCustomDataLayerOptions**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"manager","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"repositories","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ModuleServiceInitializeCustomDataLayerOptions"/>
|
||||
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# ModulesResponse
|
||||
|
||||
**ModulesResponse**: `object`[]
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# RegisterModuleJoinerConfig
|
||||
|
||||
**RegisterModuleJoinerConfig**: [ModuleJoinerConfig](../modules_sdk.ModuleJoinerConfig/page.mdx) \| (`modules`: [ModuleJoinerConfig](../modules_sdk.ModuleJoinerConfig/page.mdx)[]) => [ModuleJoinerConfig](../modules_sdk.ModuleJoinerConfig/page.mdx)
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# RemoteQueryFunction
|
||||
|
||||
**RemoteQueryFunction**: (`query`: `string` \| [RemoteJoinerQuery](../../../types/interfaces/types.RemoteJoinerQuery/page.mdx) \| `object`, `variables?`: `Record<string, unknown>`, `options?`: [RemoteJoinerOptions](../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)) => Promise<any> \| `null`
|
||||
|
||||
## Type declaration
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"query","type":"`string` \\| [RemoteJoinerQuery](../../../types/interfaces/types.RemoteJoinerQuery/page.mdx) \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expands","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"property","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"directives","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"directives","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variables","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[RemoteJoinerOptions](../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"throwIfKeyNotFound","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throwIfRelationNotFound","type":"`boolean` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise<any> \\| null","type":"Promise<any> \\| `null`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# RestoreEntityInput
|
||||
|
||||
**RestoreEntityInput**: [DeleteEntityInput](../modules_sdk.DeleteEntityInput/page.mdx)
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# RevertMigrationFn
|
||||
|
||||
**RevertMigrationFn**: (`moduleNames`: `string`[]) => Promise<void>
|
||||
|
||||
## Type declaration
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"moduleNames","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
@@ -0,0 +1,11 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# RunMigrationFn
|
||||
|
||||
**RunMigrationFn**: () => Promise<void>
|
||||
|
||||
## Type declaration
|
||||
|
||||
### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# SharedResources
|
||||
|
||||
**SharedResources**: `Object`
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"database","type":"[ModuleServiceInitializeOptions](../../interfaces/modules_sdk.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"pool","type":"`Record<string, unknown>`","description":"{\n name?: string\n afterCreate?: Function\n min?: number\n max?: number\n refreshIdle?: boolean\n idleTimeoutMillis?: number\n reapIntervalMillis?: number\n returnToHead?: boolean\n priorityRange?: number\n log?: (message: string, logLevel: string) => void\n}","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="SharedResources"/>
|
||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Country . This belongs to the Region Module.
|
||||
|
||||
<TypeList types={[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo<[Region](../region_models.Region/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany<[Country](page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo<[Region](../region_models.Region/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Country"/>
|
||||
<TypeList types={[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo<[Region](../region_models.Region/page.mdx)>","description":"The region it belongs to.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3-character currency code of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"Whether taxes are calculated automatically during checkout in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany<[Country](page.mdx)>","description":"The countries that belong to the region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo<[Region](../region_models.Region/page.mdx)>","description":"The region it belongs to.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Country"/>
|
||||
|
||||
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the Region . This belongs to the Region Module.
|
||||
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany<[Country](../region_models.Country/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo<[Region](page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany<[Country](../region_models.Country/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Region"/>
|
||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3-character currency code of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"Whether taxes are calculated automatically during checkout in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany<[Country](../region_models.Country/page.mdx)>","description":"The countries that belong to the region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo<[Region](page.mdx)>","description":"The region it belongs to.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3-character currency code of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"Whether taxes are calculated automatically during checkout in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany<[Country](../region_models.Country/page.mdx)>","description":"The countries that belong to the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Region"/>
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+7
@@ -0,0 +1,7 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# AdminBatchLink
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"add","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remove","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminBatchLink"/>
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminFulfillmentProviderListParams"/>
|
||||
<TypeList types={[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stock_location_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminFulfillmentProviderListParams"/>
|
||||
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[AdminStockLocationAddress](../types.HttpTypes.AdminStockLocationAddress/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`AdminSalesChannel`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[AdminFulfillmentSet](../types.HttpTypes.AdminFulfillmentSet/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[AdminServiceZone](../types.HttpTypes.AdminServiceZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[AdminGeoZone](../types.HttpTypes.AdminGeoZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[AdminShippingOption](../types.HttpTypes.AdminShippingOption/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminStockLocation"/>
|
||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[AdminStockLocationAddress](../types.HttpTypes.AdminStockLocationAddress/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`AdminSalesChannel`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[AdminFulfillmentProvider](../types.HttpTypes.AdminFulfillmentProvider/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fulfillment_sets","type":"[AdminFulfillmentSet](../types.HttpTypes.AdminFulfillmentSet/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[AdminServiceZone](../types.HttpTypes.AdminServiceZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[AdminGeoZone](../types.HttpTypes.AdminGeoZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[AdminShippingOption](../types.HttpTypes.AdminShippingOption/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminStockLocation"/>
|
||||
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"limit","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stock_locations","type":"[AdminStockLocation](../types.HttpTypes.AdminStockLocation/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[AdminStockLocationAddress](../types.HttpTypes.AdminStockLocationAddress/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`AdminSalesChannel`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[AdminFulfillmentSet](../types.HttpTypes.AdminFulfillmentSet/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[AdminServiceZone](../types.HttpTypes.AdminServiceZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="AdminStockLocationListResponse"/>
|
||||
<TypeList types={[{"name":"limit","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stock_locations","type":"[AdminStockLocation](../types.HttpTypes.AdminStockLocation/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[AdminStockLocationAddress](../types.HttpTypes.AdminStockLocationAddress/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`AdminSalesChannel`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[AdminFulfillmentProvider](../types.HttpTypes.AdminFulfillmentProvider/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fulfillment_sets","type":"[AdminFulfillmentSet](../types.HttpTypes.AdminFulfillmentSet/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[AdminServiceZone](../types.HttpTypes.AdminServiceZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="AdminStockLocationListResponse"/>
|
||||
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"stock_location","type":"[AdminStockLocation](../types.HttpTypes.AdminStockLocation/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[AdminStockLocationAddress](../types.HttpTypes.AdminStockLocationAddress/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`AdminSalesChannel`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[AdminFulfillmentSet](../types.HttpTypes.AdminFulfillmentSet/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[AdminServiceZone](../types.HttpTypes.AdminServiceZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="AdminStockLocationResponse"/>
|
||||
<TypeList types={[{"name":"stock_location","type":"[AdminStockLocation](../types.HttpTypes.AdminStockLocation/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[AdminStockLocationAddress](../types.HttpTypes.AdminStockLocationAddress/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`AdminSalesChannel`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[AdminFulfillmentProvider](../types.HttpTypes.AdminFulfillmentProvider/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fulfillment_sets","type":"[AdminFulfillmentSet](../types.HttpTypes.AdminFulfillmentSet/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[AdminServiceZone](../types.HttpTypes.AdminServiceZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="AdminStockLocationResponse"/>
|
||||
|
||||
@@ -21,6 +21,7 @@ import { TypeList } from "docs-ui"
|
||||
- [StoreCollectionFilters](../HttpTypes/interfaces/types.HttpTypes.StoreCollectionFilters/page.mdx)
|
||||
- [SelectParams](../HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)
|
||||
- [FindParams](../HttpTypes/interfaces/types.HttpTypes.FindParams/page.mdx)
|
||||
- [AdminBatchLink](../HttpTypes/interfaces/types.HttpTypes.AdminBatchLink/page.mdx)
|
||||
- [AdminFile](../HttpTypes/interfaces/types.HttpTypes.AdminFile/page.mdx)
|
||||
- [StoreFile](../HttpTypes/interfaces/types.HttpTypes.StoreFile/page.mdx)
|
||||
- [AdminFulfillmentProvider](../HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentProvider/page.mdx)
|
||||
|
||||
Reference in New Issue
Block a user