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

docs: [21/n] generate core-flows reference (#8804)

Browse Source 
* docs: [21/n] generate core-flows reference

* more
This commit is contained in:
Shahed Nasser
2024-08-27 12:25:16 +03:00
committed by GitHub
parent 40330650e4
commit 4f280e7cd6
31 changed files with 11355 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
www/apps/resources/references/core_flows/Api_Key/Steps_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.createApiKeysStep/page.mdx Normal file
View File

@@ -0,0 +1,20 @@
---
slug: /references/medusa-workflows/steps/createApiKeysStep
sidebar_label: createApiKeysStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createApiKeysStep - Medusa Workflows API Reference
This documentation provides a reference to the `createApiKeysStep`. It belongs to the `@medusajs/core-flows` package.
This step creates one or more API keys.
## Input
<TypeList types={[{"name":"CreateApiKeysStepInput","type":"[CreateApiKeysStepInput](../../../../types/core_flows.CreateApiKeysStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"api_keys","type":"[CreateApiKeyDTO](../../../../../api_key/interfaces/api_key.CreateApiKeyDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createApiKeysStep"/>
## Output
<TypeList types={[{"name":"ApiKeyDTO[]","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createApiKeysStep"/>

16
www/apps/resources/references/core_flows/Api_Key/Steps_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.deleteApiKeysStep/page.mdx Normal file
View File

@@ -0,0 +1,16 @@
---
slug: /references/medusa-workflows/steps/deleteApiKeysStep
sidebar_label: deleteApiKeysStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteApiKeysStep - Medusa Workflows API Reference
This documentation provides a reference to the `deleteApiKeysStep`. It belongs to the `@medusajs/core-flows` package.
This step deletes one or more API keys.
## Input
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteApiKeysStep"/>

16
www/apps/resources/references/core_flows/Api_Key/Steps_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.linkSalesChannelsToApiKeyStep/page.mdx Normal file
View File

@@ -0,0 +1,16 @@
---
slug: /references/medusa-workflows/steps/linkSalesChannelsToApiKeyStep
sidebar_label: linkSalesChannelsToApiKeyStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# linkSalesChannelsToApiKeyStep - Medusa Workflows API Reference
This documentation provides a reference to the `linkSalesChannelsToApiKeyStep`. It belongs to the `@medusajs/core-flows` package.
This step links sales channels to API keys.
## Input
<TypeList types={[{"name":"LinkWorkflowInput","type":"[LinkWorkflowInput](../../../../../types/CommonTypes/types/types.CommonTypes.LinkWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"add","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remove","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="linkSalesChannelsToApiKeyStep"/>

20
www/apps/resources/references/core_flows/Api_Key/Steps_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.revokeApiKeysStep/page.mdx Normal file
View File

File diff suppressed because one or more lines are too long

20
www/apps/resources/references/core_flows/Api_Key/Steps_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.updateApiKeysStep/page.mdx Normal file
View File

File diff suppressed because one or more lines are too long

20
www/apps/resources/references/core_flows/Api_Key/Steps_Api_Key/functions/core_flows.Api_Key.Steps_Api_Key.validateSalesChannelsExistStep/page.mdx Normal file
View File

@@ -0,0 +1,20 @@
---
slug: /references/medusa-workflows/steps/validateSalesChannelsExistStep
sidebar_label: validateSalesChannelsExistStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# validateSalesChannelsExistStep - Medusa Workflows API Reference
This documentation provides a reference to the `validateSalesChannelsExistStep`. It belongs to the `@medusajs/core-flows` package.
This step validates that a sales channel exists before linking it to an API key.
## Input
<TypeList types={[{"name":"ValidateSalesChannelsExistStepInput","type":"[ValidateSalesChannelsExistStepInput](../../../../interfaces/core_flows.ValidateSalesChannelsExistStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"sales_channel_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateSalesChannelsExistStep"/>
## Output
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateSalesChannelsExistStep"/>

5
www/apps/resources/references/core_flows/Api_Key/Steps_Api_Key/variables/core_flows.Api_Key.Steps_Api_Key.createApiKeysStepId/page.mdx Normal file
View File

@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# createApiKeysStepId
`Const` **createApiKeysStepId**: `"create-api-keys"`

5
www/apps/resources/references/core_flows/Api_Key/Steps_Api_Key/variables/core_flows.Api_Key.Steps_Api_Key.deleteApiKeysStepId/page.mdx Normal file
View File

@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteApiKeysStepId
`Const` **deleteApiKeysStepId**: `"delete-api-keys"`

5
www/apps/resources/references/core_flows/Api_Key/Steps_Api_Key/variables/core_flows.Api_Key.Steps_Api_Key.linkSalesChannelsToApiKeyStepId/page.mdx Normal file
View File

@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# linkSalesChannelsToApiKeyStepId
`Const` **linkSalesChannelsToApiKeyStepId**: `"link-sales-channels-to-api-key"`

5
www/apps/resources/references/core_flows/Api_Key/Steps_Api_Key/variables/core_flows.Api_Key.Steps_Api_Key.revokeApiKeysStepId/page.mdx Normal file
View File

@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# revokeApiKeysStepId
`Const` **revokeApiKeysStepId**: `"revoke-api-keys"`

5
www/apps/resources/references/core_flows/Api_Key/Steps_Api_Key/variables/core_flows.Api_Key.Steps_Api_Key.updateApiKeysStepId/page.mdx Normal file
View File

@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateApiKeysStepId
`Const` **updateApiKeysStepId**: `"update-api-keys"`

5
www/apps/resources/references/core_flows/Api_Key/Steps_Api_Key/variables/core_flows.Api_Key.Steps_Api_Key.validateSalesChannelsExistStepId/page.mdx Normal file
View File

@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# validateSalesChannelsExistStepId
`Const` **validateSalesChannelsExistStepId**: `"validate-sales-channels-exist"`

24
www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.createApiKeysWorkflow/page.mdx Normal file
View File

@@ -0,0 +1,24 @@
---
slug: /references/medusa-workflows/createApiKeysWorkflow
sidebar_label: createApiKeysWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# createApiKeysWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createApiKeysWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow creates one or more API keys.
## Steps
<WorkflowDiagram workflow={{"name":"createApiKeysWorkflow","steps":[{"type":"step","name":"createApiKeysStep","description":"This step creates one or more API keys.","link":"../../../../core_flows.Steps_Api_Key/page.mdx#createapikeysstep","depth":1}]}} />
## Input
<TypeList types={[{"name":"CreateApiKeysWorkflowInput","type":"[CreateApiKeysWorkflowInput](../../../../types/core_flows.CreateApiKeysWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"api_keys","type":"[CreateApiKeyDTO](../../../../../api_key/interfaces/api_key.CreateApiKeyDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createApiKeysWorkflow"/>
## Output
<TypeList types={[{"name":"ApiKeyDTO[]","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ApiKeyDTO","type":"[ApiKeyDTO](../../../../../api_key/interfaces/api_key.ApiKeyDTO/page.mdx)","optional":false,"defaultValue":"","description":"The API key details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"redacted","type":"`string`","description":"The redacted form of the API key's token. This is useful\nwhen showing portion of the token. For example `sk_...123`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ApiKeyType](../../../../../api_key/types/api_key.ApiKeyType/page.mdx)","description":"The type of the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_used_at","type":"`null` \\| `Date`","description":"The date the API key was last used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"Who created the API key.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date the API key was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_by","type":"`null` \\| `string`","description":"Who revoked the API key. For example,\nthe ID of the user that revoked it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revoked_at","type":"`null` \\| `Date`","description":"The date the API key was revoked.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createApiKeysWorkflow"/>

20
www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.deleteApiKeysWorkflow/page.mdx Normal file
View File

@@ -0,0 +1,20 @@
---
slug: /references/medusa-workflows/deleteApiKeysWorkflow
sidebar_label: deleteApiKeysWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteApiKeysWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `deleteApiKeysWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow deletes one or more API keys.
## Steps
<WorkflowDiagram workflow={{"name":"deleteApiKeysWorkflow","steps":[{"type":"step","name":"deleteApiKeysStep","description":"This step deletes one or more API keys.","link":"../../../../core_flows.Steps_Api_Key/page.mdx#deleteapikeysstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../../../core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
## Input
<TypeList types={[{"name":"DeleteApiKeysWorkflowInput","type":"[DeleteApiKeysWorkflowInput](../../../../types/core_flows.DeleteApiKeysWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteApiKeysWorkflow"/>

20
www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.linkSalesChannelsToApiKeyWorkflow/page.mdx Normal file
View File

@@ -0,0 +1,20 @@
---
slug: /references/medusa-workflows/linkSalesChannelsToApiKeyWorkflow
sidebar_label: linkSalesChannelsToApiKeyWorkflow
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# linkSalesChannelsToApiKeyWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `linkSalesChannelsToApiKeyWorkflow`. It belongs to the `@medusajs/core-flows` package.
This workflow links sales channels to API keys.
## Steps
<WorkflowDiagram workflow={{"name":"linkSalesChannelsToApiKeyWorkflow","steps":[{"type":"step","name":"validateSalesChannelsExistStep","description":"This step validates that a sales channel exists before linking it to an API key.","link":"../../../../core_flows.Steps_Api_Key/page.mdx#validatesaleschannelsexiststep","depth":1},{"type":"step","name":"linkSalesChannelsToApiKeyStep","description":"This step links sales channels to API keys.","link":"../../../../core_flows.Steps_Api_Key/page.mdx#linksaleschannelstoapikeystep","depth":2}]}} />
## Input
<TypeList types={[{"name":"LinkWorkflowInput","type":"[LinkWorkflowInput](../../../../../types/CommonTypes/types/types.CommonTypes.LinkWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"add","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remove","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="linkSalesChannelsToApiKeyWorkflow"/>

24
www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.revokeApiKeysWorkflow/page.mdx Normal file
View File

File diff suppressed because one or more lines are too long

24
www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/functions/core_flows.Api_Key.Workflows_Api_Key.updateApiKeysWorkflow/page.mdx Normal file
View File

File diff suppressed because one or more lines are too long

5
www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/variables/core_flows.Api_Key.Workflows_Api_Key.createApiKeysWorkflowId/page.mdx Normal file
View File

@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# createApiKeysWorkflowId
`Const` **createApiKeysWorkflowId**: `"create-api-keys"`

5
www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/variables/core_flows.Api_Key.Workflows_Api_Key.deleteApiKeysWorkflowId/page.mdx Normal file
View File

@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteApiKeysWorkflowId
`Const` **deleteApiKeysWorkflowId**: `"delete-api-keys"`

5
www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/variables/core_flows.Api_Key.Workflows_Api_Key.linkSalesChannelsToApiKeyWorkflowId/page.mdx Normal file
View File

@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# linkSalesChannelsToApiKeyWorkflowId
`Const` **linkSalesChannelsToApiKeyWorkflowId**: `"link-sales-channels-to-api-key"`

5
www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/variables/core_flows.Api_Key.Workflows_Api_Key.revokeApiKeysWorkflowId/page.mdx Normal file
View File

@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# revokeApiKeysWorkflowId
`Const` **revokeApiKeysWorkflowId**: `"revoke-api-keys"`

5
www/apps/resources/references/core_flows/Api_Key/Workflows_Api_Key/variables/core_flows.Api_Key.Workflows_Api_Key.updateApiKeysWorkflowId/page.mdx Normal file
View File

@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# updateApiKeysWorkflowId
`Const` **updateApiKeysWorkflowId**: `"update-api-keys"`

77
www/apps/resources/references/core_flows/Api_Key/core_flows.Api_Key.Steps_Api_Key/page.mdx Normal file
View File

File diff suppressed because one or more lines are too long

83
www/apps/resources/references/core_flows/Api_Key/core_flows.Api_Key.Workflows_Api_Key/page.mdx Normal file
View File

File diff suppressed because one or more lines are too long

20
www/apps/resources/references/core_flows/Auth/Steps_Auth/functions/core_flows.Auth.Steps_Auth.setAuthAppMetadataStep/page.mdx Normal file
View File

@@ -0,0 +1,20 @@
---
slug: /references/medusa-workflows/steps/setAuthAppMetadataStep
sidebar_label: setAuthAppMetadataStep
---
import { TypeList, WorkflowDiagram } from "docs-ui"
# setAuthAppMetadataStep - Medusa Workflows API Reference
This documentation provides a reference to the `setAuthAppMetadataStep`. It belongs to the `@medusajs/core-flows` package.
This step sets the `app_metadata` property of an auth identity.
## Input
<TypeList types={[{"name":"SetAuthAppMetadataStepInput","type":"[SetAuthAppMetadataStepInput](../../../../types/core_flows.SetAuthAppMetadataStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"authIdentityId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actorType","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setAuthAppMetadataStep"/>
## Output
<TypeList types={[{"name":"AuthIdentityDTO","type":"[AuthIdentityDTO](../../../../../auth/interfaces/auth.AuthIdentityDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"[ProviderIdentityDTO](../../../../../auth/interfaces/auth.ProviderIdentityDTO/page.mdx)[]","description":"The list of provider identities linked to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"The user's identifier. For example, when using the `emailpass`\nprovider, the `entity_id` would be the user's email.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"[AuthIdentityDTO](../../../../../auth/interfaces/auth.AuthIdentityDTO/page.mdx)","description":"The auth identity linked to the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"[ProviderIdentityDTO](../../../../../auth/interfaces/auth.ProviderIdentityDTO/page.mdx)[]","description":"The list of provider identities linked to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"Holds information related to the actor IDs tied to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"Holds information related to the actor IDs tied to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setAuthAppMetadataStep"/>

5
www/apps/resources/references/core_flows/Auth/Steps_Auth/variables/core_flows.Auth.Steps_Auth.setAuthAppMetadataStepId/page.mdx Normal file
View File

@@ -0,0 +1,5 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# setAuthAppMetadataStepId
`Const` **setAuthAppMetadataStepId**: `"set-auth-app-metadata"`

15
www/apps/resources/references/core_flows/Auth/core_flows.Auth.Steps_Auth/page.mdx Normal file
View File

@@ -0,0 +1,15 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# Steps\_Auth
## setAuthAppMetadataStep
This step sets the `app_metadata` property of an auth identity.
### Input
<TypeList types={[{"name":"SetAuthAppMetadataStepInput","type":"[SetAuthAppMetadataStepInput](../../types/core_flows.SetAuthAppMetadataStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"authIdentityId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actorType","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setAuthAppMetadataStep"/>
### Output
<TypeList types={[{"name":"AuthIdentityDTO","type":"[AuthIdentityDTO](../../../auth/interfaces/auth.AuthIdentityDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"[ProviderIdentityDTO](../../../auth/interfaces/auth.ProviderIdentityDTO/page.mdx)[]","description":"The list of provider identities linked to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"The user's identifier. For example, when using the `emailpass`\nprovider, the `entity_id` would be the user's email.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"[AuthIdentityDTO](../../../auth/interfaces/auth.AuthIdentityDTO/page.mdx)","description":"The auth identity linked to the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"[ProviderIdentityDTO](../../../auth/interfaces/auth.ProviderIdentityDTO/page.mdx)[]","description":"The list of provider identities linked to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"Holds information related to the actor IDs tied to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"Holds information related to the actor IDs tied to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setAuthAppMetadataStep"/>

8
www/apps/resources/references/core_flows/core_flows.Api_Key/page.mdx Normal file
View File

@@ -0,0 +1,8 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# Api Key
## Namespaces
- [Steps\_Api Key](../core_flows.Steps_Api_Key/page.mdx)
- [Workflows\_Api Key](../core_flows.Workflows_Api_Key/page.mdx)

7
www/apps/resources/references/core_flows/core_flows.Auth/page.mdx Normal file
View File

@@ -0,0 +1,7 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# Auth
## Namespaces
- [Steps\_Auth](../core_flows.Steps_Auth/page.mdx)

10860
www/apps/resources/references/modules/core_flows/page.mdx Normal file
View File

File diff suppressed because one or more lines are too long

12
www/utils/packages/typedoc-generate-references/src/utils/get-namespaces.ts
View File

@@ -70,15 +70,5 @@ export function getCoreFlowNamespaces(): NamespaceGenerateDetails[] {
export function getNamespaceNames(
namespaces: NamespaceGenerateDetails[]
): string[] {
const names: string[] = []
namespaces.forEach((namespace) => {
names.push(namespace.name)
if (namespace.children) {
names.push(...getNamespaceNames(namespace.children))
}
})
return names
return namespaces.map((namespace) => namespace.name)
}