docs: [19/n] generate core-flows reference (#8802)

* docs: [19/n] generate core-flows reference

* more
This commit is contained in:
Shahed Nasser
2024-08-27 12:24:54 +03:00
committed by GitHub
parent 9dc70a8195
commit c617dc873b
10 changed files with 3905 additions and 0 deletions

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,21 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# Workflows\_Defaults
## createDefaultsWorkflowID
`Const` **createDefaultsWorkflowID**: `"create-defaults"`
___
## createDefaultsWorkflow
This workflow creates default data for a Medusa application.
### Steps
<WorkflowDiagram workflow={{"name":"createDefaultsWorkflow","steps":[{"type":"step","name":"createDefaultSalesChannelStep","description":"This step creates a default sales channel.","link":"../core_flows.Steps_Sales_Channel/page.mdx#createdefaultsaleschannelstep","depth":1},{"type":"step","name":"createDefaultStoreStep","description":"This step creates a default store.","link":"../core_flows.Steps_Defaults/page.mdx#createdefaultstorestep","depth":2}]}} />
### Output
<TypeList types={[{"name":"undefined \\| StoreDTO","type":"`undefined` \\| [StoreDTO](../../store/interfaces/store.StoreDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"undefined \\| StoreDTO","type":"`undefined` \\| [StoreDTO](../../store/interfaces/store.StoreDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createDefaultsWorkflow"/>

View File

@@ -0,0 +1,49 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# Workflows\_File
<TypeList types={[{"name":"ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"files","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filename","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Workflows_File"/>
___
## deleteFilesWorkflowId
`Const` **deleteFilesWorkflowId**: `"delete-files"`
___
## uploadFilesWorkflowId
`Const` **uploadFilesWorkflowId**: `"upload-files"`
___
## deleteFilesWorkflow
This workflow deletes one or more files.
### Steps
<WorkflowDiagram workflow={{"name":"deleteFilesWorkflow","steps":[{"type":"step","name":"deleteFilesStep","description":"This step deletes one or more files.","link":"../core_flows.Steps_File/page.mdx#deletefilesstep","depth":1}]}} />
### Input
<TypeList types={[{"name":"DeleteFilesWorkflowInput","type":"[DeleteFilesWorkflowInput](../types/core_flows.DeleteFilesWorkflowInput/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="deleteFilesWorkflow"/>
___
## uploadFilesWorkflow
This workflow uploads one or more files.
### Steps
<WorkflowDiagram workflow={{"name":"uploadFilesWorkflow","steps":[{"type":"step","name":"uploadFilesStep","description":"This step uploads one or more files.","link":"../core_flows.Steps_File/page.mdx#uploadfilesstep","depth":1}]}} />
### Input
<TypeList types={[{"name":"UploadFilesWorkflowInput","type":"[UploadFilesWorkflowInput](../types/core_flows.UploadFilesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"files","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"filename","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mimeType","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"access","type":"`\"public\"` \\| `\"private\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="uploadFilesWorkflow"/>
### Output
<TypeList types={[{"name":"FileDTO[]","type":"[FileDTO](../../types/FileTypes/interfaces/types.FileTypes.FileDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"FileDTO","type":"[FileDTO](../../types/FileTypes/interfaces/types.FileTypes.FileDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the File.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"The URL of the File.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="uploadFilesWorkflow"/>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,93 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# Workflows\_Invite
## acceptInviteWorkflowId
`Const` **acceptInviteWorkflowId**: `"accept-invite-workflow"`
___
## createInvitesWorkflowId
`Const` **createInvitesWorkflowId**: `"create-invite-step"`
___
## deleteInvitesWorkflowId
`Const` **deleteInvitesWorkflowId**: `"delete-invites-workflow"`
___
## refreshInviteTokensWorkflowId
`Const` **refreshInviteTokensWorkflowId**: `"refresh-invite-tokens-workflow"`
___
## acceptInviteWorkflow
This workflow accepts an invite and creates a user.
### Steps
<WorkflowDiagram workflow={{"name":"acceptInviteWorkflow","steps":[{"type":"step","name":"validateTokenStep","description":"This step validates a specified token and returns its associated invite.","link":"../core_flows.Steps_Invite/page.mdx#validatetokenstep","depth":1},{"type":"step","name":"createUsersStep","description":"This step creates one or more users.","link":"../core_flows.Steps_User/page.mdx#createusersstep","depth":2},{"type":"step","name":"setAuthAppMetadataStep","description":"This step sets the `app_metadata` property of an auth identity.","link":"../core_flows.Steps_Auth/page.mdx#setauthappmetadatastep","depth":3},{"type":"step","name":"deleteInvitesStep","description":"This step deletes one or more invites.","link":"../core_flows.Steps_Invite/page.mdx#deleteinvitesstep","depth":4}]}} />
### Input
<TypeList types={[{"name":"AcceptInviteWorkflowInputDTO","type":"[AcceptInviteWorkflowInputDTO](../../types/WorkflowTypes/InviteWorkflow/interfaces/types.WorkflowTypes.InviteWorkflow.AcceptInviteWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"invite_token","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"email","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"avatar_url","type":"`null` \\| `string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="acceptInviteWorkflow"/>
### Output
<TypeList types={[{"name":"UserDTO[]","type":"[UserDTO](../../user/interfaces/user.UserDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UserDTO","type":"[UserDTO](../../user/interfaces/user.UserDTO/page.mdx)","optional":false,"defaultValue":"","description":"The user details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"avatar_url","type":"`null` \\| `string`","description":"The avatar URL of the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The updated date of the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the user.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="acceptInviteWorkflow"/>
___
## createInvitesWorkflow
This workflow creates one or more invites.
### Steps
<WorkflowDiagram workflow={{"name":"createInvitesWorkflow","steps":[{"type":"step","name":"createInviteStep","description":"This step creates one or more invites.","link":"../core_flows.Steps_Invite/page.mdx#createinvitestep","depth":1}]}} />
### Input
<TypeList types={[{"name":"CreateInvitesWorkflowInputDTO","type":"[CreateInvitesWorkflowInputDTO](../../types/WorkflowTypes/InviteWorkflow/interfaces/types.WorkflowTypes.InviteWorkflow.CreateInvitesWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"invites","type":"[CreateInviteDTO](../../user/interfaces/user.CreateInviteDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"email","type":"`string`","description":"The email of the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"accepted","type":"`boolean`","description":"Whether the invite is accepted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createInvitesWorkflow"/>
### Output
<TypeList types={[{"name":"InviteDTO[]","type":"[InviteDTO](../../user/interfaces/user.InviteDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InviteDTO","type":"[InviteDTO](../../user/interfaces/user.InviteDTO/page.mdx)","optional":false,"defaultValue":"","description":"The invite details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"accepted","type":"`boolean`","description":"Whether the invite is accepted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"expires_at","type":"`Date`","description":"The invite's expiry date.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The invite's creation date.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The invite's update date.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The invite's deletion date.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createInvitesWorkflow"/>
___
## deleteInvitesWorkflow
This workflow deletes one or more invites.
### Steps
<WorkflowDiagram workflow={{"name":"deleteInvitesWorkflow","steps":[{"type":"step","name":"deleteInvitesStep","description":"This step deletes one or more invites.","link":"../core_flows.Steps_Invite/page.mdx#deleteinvitesstep","depth":1}]}} />
### Input
<TypeList types={[{"name":"DeleteInvitesWorkflowInput","type":"[DeleteInvitesWorkflowInput](../../types/WorkflowTypes/InviteWorkflow/interfaces/types.WorkflowTypes.InviteWorkflow.DeleteInvitesWorkflowInput/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="deleteInvitesWorkflow"/>
___
## refreshInviteTokensWorkflow
This workflow refreshes the token of one or more invites.
### Steps
<WorkflowDiagram workflow={{"name":"refreshInviteTokensWorkflow","steps":[{"type":"step","name":"refreshInviteTokensStep","description":"This step refreshes the tokens of one or more invites.","link":"../core_flows.Steps_Invite/page.mdx#refreshinvitetokensstep","depth":1}]}} />
### Input
<TypeList types={[{"name":"ResendInvitesWorkflowInputDTO","type":"[ResendInvitesWorkflowInputDTO](../../types/WorkflowTypes/InviteWorkflow/interfaces/types.WorkflowTypes.InviteWorkflow.ResendInvitesWorkflowInputDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"invite_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="refreshInviteTokensWorkflow"/>
### Output
<TypeList types={[{"name":"InviteDTO[]","type":"[InviteDTO](../../user/interfaces/user.InviteDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InviteDTO","type":"[InviteDTO](../../user/interfaces/user.InviteDTO/page.mdx)","optional":false,"defaultValue":"","description":"The invite details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"accepted","type":"`boolean`","description":"Whether the invite is accepted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"token","type":"`string`","description":"The token of the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"expires_at","type":"`Date`","description":"The invite's expiry date.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The invite's creation date.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The invite's update date.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The invite's deletion date.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="refreshInviteTokensWorkflow"/>

View File

@@ -0,0 +1,25 @@
import { TypeList, WorkflowDiagram } from "docs-ui"
# Workflows\_Line Item
<TypeList types={[{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","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="Workflows_Line Item"/>
___
## deleteLineItemsWorkflowId
`Const` **deleteLineItemsWorkflowId**: `"delete-line-items"`
___
## deleteLineItemsWorkflow
This workflow deletes line items from a cart.
### Steps
<WorkflowDiagram workflow={{"name":"deleteLineItemsWorkflow","steps":[{"type":"step","name":"deleteLineItemsStep","description":"This step deletes line items.","link":"../core_flows.Steps_Line_Item/page.mdx#deletelineitemsstep","depth":1},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":2}]}} />
### Input
<TypeList types={[{"name":"DeleteLineItemsWorkflowInput","type":"[DeleteLineItemsWorkflowInput](../types/core_flows.DeleteLineItemsWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"cart_id","type":"`string`","description":"","optional":false,"defaultValue":"","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="deleteLineItemsWorkflow"/>

File diff suppressed because one or more lines are too long