docs: [3/n] generate core-flows reference (#8784)
This commit is contained in:
Shahed Nasser
GitHub
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteLineItemsStep
|
||||
sidebar_label: deleteLineItemsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteLineItemsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteLineItemsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes line items.
|
||||
|
||||
## 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="deleteLineItemsStep"/>
|
||||
+21
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteLineItemsStepId
|
||||
|
||||
`Const` **deleteLineItemsStepId**: `"delete-line-items"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# listLineItemsStepId
|
||||
|
||||
`Const` **listLineItemsStepId**: `"list-line-items"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateLineItemsStepWithSelectorId
|
||||
|
||||
`Const` **updateLineItemsStepWithSelectorId**: `"update-line-items-with-selector"`
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/deleteLineItemsWorkflow
|
||||
sidebar_label: deleteLineItemsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteLineItemsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteLineItemsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
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"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteLineItemsWorkflowId
|
||||
|
||||
`Const` **deleteLineItemsWorkflowId**: `"delete-line-items"`
|
||||
+40
File diff suppressed because one or more lines are too long
+15
@@ -0,0 +1,15 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Workflows\_Line Item
|
||||
|
||||
## 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"/>
|
||||
+3
@@ -0,0 +1,3 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Steps\_Notification
|
||||
+20
File diff suppressed because one or more lines are too long
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/cancelPaymentStep
|
||||
sidebar_label: cancelPaymentStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelPaymentStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelPaymentStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step cancels one or more payments.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CancelPaymentStepInput","type":"[CancelPaymentStepInput](../../../../types/core_flows.CancelPaymentStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"paymentIds","type":"`string` \\| `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="cancelPaymentStep"/>
|
||||
+20
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# authorizePaymentSessionStepId
|
||||
|
||||
`Const` **authorizePaymentSessionStepId**: `"authorize-payment-session-step"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelPaymentStepId
|
||||
|
||||
`Const` **cancelPaymentStepId**: `"cancel-payment-step"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# capturePaymentStepId
|
||||
|
||||
`Const` **capturePaymentStepId**: `"capture-payment-step"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# refundPaymentStepId
|
||||
|
||||
`Const` **refundPaymentStepId**: `"refund-payment-step"`
|
||||
+24
File diff suppressed because one or more lines are too long
+24
File diff suppressed because one or more lines are too long
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# capturePaymentWorkflowId
|
||||
|
||||
`Const` **capturePaymentWorkflowId**: `"capture-payment-workflow"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# refundPaymentWorkflowId
|
||||
|
||||
`Const` **refundPaymentWorkflowId**: `"refund-payment-workflow"`
|
||||
+53
File diff suppressed because one or more lines are too long
+37
File diff suppressed because one or more lines are too long
+20
File diff suppressed because one or more lines are too long
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createRefundReasonStep
|
||||
sidebar_label: createRefundReasonStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createRefundReasonStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createRefundReasonStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates one or more refund reasons.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateRefundReasonDTO[]","type":"[CreateRefundReasonDTO](../../../../../payment/interfaces/payment.CreateRefundReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateRefundReasonDTO","type":"[CreateRefundReasonDTO](../../../../../payment/interfaces/payment.CreateRefundReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRefundReasonStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"RefundReasonDTO[]","type":"[RefundReasonDTO](../../../../../payment/interfaces/payment.RefundReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"RefundReasonDTO","type":"[RefundReasonDTO](../../../../../payment/interfaces/payment.RefundReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the refund reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the refund reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRefundReasonStep"/>
|
||||
+23
@@ -0,0 +1,23 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deletePaymentSessionsStep
|
||||
sidebar_label: deletePaymentSessionsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deletePaymentSessionsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deletePaymentSessionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more payment sessions.
|
||||
|
||||
Note: This step should not be used alone as it doesn't consider a revert
|
||||
Use deletePaymentSessionsWorkflow instead that uses this step
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"DeletePaymentSessionStepInput","type":"[DeletePaymentSessionStepInput](../../../../interfaces/core_flows.DeletePaymentSessionStepInput/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="deletePaymentSessionsStep"/>
|
||||
|
||||
## 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="deletePaymentSessionsStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteRefundReasonsStep
|
||||
sidebar_label: deleteRefundReasonsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteRefundReasonsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteRefundReasonsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more refund reasons.
|
||||
|
||||
## 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="deleteRefundReasonsStep"/>
|
||||
+20
File diff suppressed because one or more lines are too long
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/updateRefundReasonsStep
|
||||
sidebar_label: updateRefundReasonsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateRefundReasonsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updateRefundReasonsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step updates one or more refund reasons.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateRefundReasonDTO[]","type":"[UpdateRefundReasonDTO](../../../../../payment/interfaces/payment.UpdateRefundReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateRefundReasonDTO","type":"[UpdateRefundReasonDTO](../../../../../payment/interfaces/payment.UpdateRefundReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The id of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRefundReasonsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"RefundReasonDTO[]","type":"[RefundReasonDTO](../../../../../payment/interfaces/payment.RefundReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"RefundReasonDTO","type":"[RefundReasonDTO](../../../../../payment/interfaces/payment.RefundReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the refund reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the refund reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRefundReasonsStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/validateDeletedPaymentSessionsStep
|
||||
sidebar_label: validateDeletedPaymentSessionsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# validateDeletedPaymentSessionsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `validateDeletedPaymentSessionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step validates that the specified payment session IDs were deleted.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"ValidateDeletedPaymentSessionsStepInput","type":"[ValidateDeletedPaymentSessionsStepInput](../../../../interfaces/core_flows.ValidateDeletedPaymentSessionsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"idsToDelete","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idsDeleted","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="validateDeletedPaymentSessionsStep"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPaymentSessionStepId
|
||||
|
||||
`Const` **createPaymentSessionStepId**: `"create-payment-session"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createRefundReasonStepId
|
||||
|
||||
`Const` **createRefundReasonStepId**: `"create-refund-reason"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deletePaymentSessionsStepId
|
||||
|
||||
`Const` **deletePaymentSessionsStepId**: `"delete-payment-sessions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteRefundReasonsStepId
|
||||
|
||||
`Const` **deleteRefundReasonsStepId**: `"delete-refund-reasons"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updatePaymentCollectionStepId
|
||||
|
||||
`Const` **updatePaymentCollectionStepId**: `"update-payment-collection"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateRefundReasonStepId
|
||||
|
||||
`Const` **updateRefundReasonStepId**: `"update-refund-reasons"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# validateDeletedPaymentSessionsStepId
|
||||
|
||||
`Const` **validateDeletedPaymentSessionsStepId**: `"validate-deleted-payment-sessions"`
|
||||
+24
File diff suppressed because one or more lines are too long
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/createRefundReasonsWorkflow
|
||||
sidebar_label: createRefundReasonsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createRefundReasonsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createRefundReasonsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow creates one or more refund reasons.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createRefundReasonsWorkflow","steps":[{"type":"step","name":"createRefundReasonStep","description":"This step creates one or more refund reasons.","link":"../../../../core_flows.Steps_Payment_Collection/page.mdx#createrefundreasonstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"data","type":"[CreateRefundReasonDTO](../../../../../payment/interfaces/payment.CreateRefundReasonDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"label","type":"`string`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRefundReasonsWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"RefundReasonDTO[]","type":"[RefundReasonDTO](../../../../../payment/interfaces/payment.RefundReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"RefundReasonDTO","type":"[RefundReasonDTO](../../../../../payment/interfaces/payment.RefundReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the refund reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the refund reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRefundReasonsWorkflow"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/deletePaymentSessionsWorkflow
|
||||
sidebar_label: deletePaymentSessionsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deletePaymentSessionsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deletePaymentSessionsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow deletes one or more payment sessions.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deletePaymentSessionsWorkflow","steps":[{"type":"step","name":"deletePaymentSessionsStep","description":"This step deletes one or more payment sessions.\n\nNote: This step should not be used alone as it doesn't consider a revert\nUse deletePaymentSessionsWorkflow instead that uses this step","link":"../../../../core_flows.Steps_Payment_Collection/page.mdx#deletepaymentsessionsstep","depth":1},{"type":"step","name":"validateDeletedPaymentSessionsStep","description":"This step validates that the specified payment session IDs were deleted.","link":"../../../../core_flows.Steps_Payment_Collection/page.mdx#validatedeletedpaymentsessionsstep","depth":2}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"DeletePaymentSessionsWorkflowInput","type":"[DeletePaymentSessionsWorkflowInput](../../../../interfaces/core_flows.DeletePaymentSessionsWorkflowInput/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="deletePaymentSessionsWorkflow"/>
|
||||
|
||||
## 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="deletePaymentSessionsWorkflow"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/updateRefundReasonsWorkflow
|
||||
sidebar_label: updateRefundReasonsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateRefundReasonsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updateRefundReasonsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow updates one or more refund reasons.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updateRefundReasonsWorkflow","steps":[{"type":"step","name":"updateRefundReasonsStep","description":"This step updates one or more refund reasons.","link":"../../../../core_flows.Steps_Payment_Collection/page.mdx#updaterefundreasonsstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateRefundReasonDTO[]","type":"[UpdateRefundReasonDTO](../../../../../payment/interfaces/payment.UpdateRefundReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"UpdateRefundReasonDTO","type":"[UpdateRefundReasonDTO](../../../../../payment/interfaces/payment.UpdateRefundReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The id of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRefundReasonsWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"RefundReasonDTO[]","type":"[RefundReasonDTO](../../../../../payment/interfaces/payment.RefundReasonDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"RefundReasonDTO","type":"[RefundReasonDTO](../../../../../payment/interfaces/payment.RefundReasonDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"The label of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"The metadata of the refund reason","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the refund reason was created","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the refund reason was updated","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the refund reason","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRefundReasonsWorkflow"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createPaymentSessionsWorkflowId
|
||||
|
||||
`Const` **createPaymentSessionsWorkflowId**: `"create-payment-sessions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createRefundReasonsWorkflowId
|
||||
|
||||
`Const` **createRefundReasonsWorkflowId**: `"create-refund-reasons-workflow"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deletePaymentSessionsWorkflowId
|
||||
|
||||
`Const` **deletePaymentSessionsWorkflowId**: `"delete-payment-sessions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateRefundReasonsWorkflowId
|
||||
|
||||
`Const` **updateRefundReasonsWorkflowId**: `"update-refund-reasons"`
|
||||
+94
File diff suppressed because one or more lines are too long
+73
File diff suppressed because one or more lines are too long
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/createRegionsStep
|
||||
sidebar_label: createRegionsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createRegionsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createRegionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step creates one or more regions.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateRegionDTO[]","type":"[CreateRegionDTO](../../../../../region/interfaces/region.CreateRegionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CreateRegionDTO","type":"[CreateRegionDTO](../../../../../region/interfaces/region.CreateRegionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The region to be created.","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`boolean`","description":"Setting to indicate whether taxes need to be applied automatically","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"`string`[]","description":"The region's countries.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"`string`[]","description":"The region's payment providers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../region/types/region.MetadataType/page.mdx)","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="createRegionsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"RegionDTO[]","type":"[RegionDTO](../../../../../region/interfaces/region.RegionDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"RegionDTO","type":"[RegionDTO](../../../../../region/interfaces/region.RegionDTO/page.mdx)","optional":false,"defaultValue":"","description":"The region details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`boolean`","description":"Setting to indicate whether taxes need to be applied automatically","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"[RegionCountryDTO](../../../../../region/interfaces/region.RegionCountryDTO/page.mdx)[]","description":"The countries of the region.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_2","type":"`string`","description":"The ISO 2 code of the country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`string`","description":"The ISO 3 code of the country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`string`","description":"The country's code number.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the country.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`string`","description":"The display name of the country.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_providers","type":"[PaymentProviderDTO](../../../../../region/interfaces/region.PaymentProviderDTO/page.mdx)[]","description":"Payment providers available in the region","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the payment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`string`","description":"Whether the payment provider is enabled.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string`","description":"The date the region was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The date the region was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, any>`","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="createRegionsStep"/>
|
||||
+16
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/steps/deleteRegionsStep
|
||||
sidebar_label: deleteRegionsStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteRegionsStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteRegionsStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step deletes one or more regions.
|
||||
|
||||
## 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="deleteRegionsStep"/>
|
||||
+20
File diff suppressed because one or more lines are too long
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createRegionsStepId
|
||||
|
||||
`Const` **createRegionsStepId**: `"create-regions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteRegionsStepId
|
||||
|
||||
`Const` **deleteRegionsStepId**: `"delete-regions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateRegionsStepId
|
||||
|
||||
`Const` **updateRegionsStepId**: `"update-region"`
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/createRegionsWorkflow
|
||||
sidebar_label: createRegionsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createRegionsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createRegionsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow creates one or more regions.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createRegionsWorkflow","steps":[{"type":"step","name":"createRegionsStep","description":"This step creates one or more regions.","link":"../../../../core_flows.Steps_Region/page.mdx#createregionsstep","depth":1},{"type":"workflow","name":"createPricePreferencesWorkflow","description":"This workflow creates one or more price preferences.","link":"../../../../core_flows.Workflows_Pricing/page.mdx#createpricepreferencesworkflow","depth":2}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateRegionsWorkflowInput","type":"`CreateRegionsWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRegionsWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"CreateRegionsWorkflowOutput","type":"`CreateRegionsWorkflowOutput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRegionsWorkflow"/>
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/deleteRegionsWorkflow
|
||||
sidebar_label: deleteRegionsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteRegionsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `deleteRegionsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow deletes one or more regions.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteRegionsWorkflow","steps":[{"type":"step","name":"deleteRegionsStep","description":"This step deletes one or more regions.","link":"../../../../core_flows.Steps_Region/page.mdx#deleteregionsstep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteRegionsWorkflowInput","type":"[DeleteRegionsWorkflowInput](../../../../types/core_flows.DeleteRegionsWorkflowInput/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="deleteRegionsWorkflow"/>
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/updateRegionsWorkflow
|
||||
sidebar_label: updateRegionsWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateRegionsWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `updateRegionsWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow updates regions matching the specified filters.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updateRegionsWorkflow","steps":[{"type":"step","name":"updateRegionsStep","description":"This step updates regions matching the specified filters.","link":"../../../../core_flows.Steps_Region/page.mdx#updateregionsstep","depth":1},{"type":"when","condition":"{\n return data.normalizedInput.is_tax_inclusive !== undefined\n }","depth":"2","steps":[{"type":"workflow","name":"updatePricePreferencesWorkflow","description":"This workflow updates one or more price preferences.","link":"../../../../core_flows.Workflows_Pricing/page.mdx#updatepricepreferencesworkflow","depth":2}]}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateRegionsWorkflowInput","type":"`UpdateRegionsWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRegionsWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"UpdateRegionsWorkflowOutput","type":"`UpdateRegionsWorkflowOutput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRegionsWorkflow"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createRegionsWorkflowId
|
||||
|
||||
`Const` **createRegionsWorkflowId**: `"create-regions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# deleteRegionsWorkflowId
|
||||
|
||||
`Const` **deleteRegionsWorkflowId**: `"delete-regions"`
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# updateRegionsWorkflowId
|
||||
|
||||
`Const` **updateRegionsWorkflowId**: `"update-regions"`
|
||||
+39
File diff suppressed because one or more lines are too long
+51
@@ -0,0 +1,51 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Workflows\_Region
|
||||
|
||||
## createRegionsWorkflow
|
||||
|
||||
This workflow creates one or more regions.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"createRegionsWorkflow","steps":[{"type":"step","name":"createRegionsStep","description":"This step creates one or more regions.","link":"../../core_flows.Steps_Region/page.mdx#createregionsstep","depth":1},{"type":"workflow","name":"createPricePreferencesWorkflow","description":"This workflow creates one or more price preferences.","link":"../../core_flows.Workflows_Pricing/page.mdx#createpricepreferencesworkflow","depth":2}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"CreateRegionsWorkflowInput","type":"`CreateRegionsWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRegionsWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"CreateRegionsWorkflowOutput","type":"`CreateRegionsWorkflowOutput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRegionsWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## deleteRegionsWorkflow
|
||||
|
||||
This workflow deletes one or more regions.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"deleteRegionsWorkflow","steps":[{"type":"step","name":"deleteRegionsStep","description":"This step deletes one or more regions.","link":"../../core_flows.Steps_Region/page.mdx#deleteregionsstep","depth":1}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"DeleteRegionsWorkflowInput","type":"[DeleteRegionsWorkflowInput](../../types/core_flows.DeleteRegionsWorkflowInput/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="deleteRegionsWorkflow"/>
|
||||
|
||||
___
|
||||
|
||||
## updateRegionsWorkflow
|
||||
|
||||
This workflow updates regions matching the specified filters.
|
||||
|
||||
### Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"updateRegionsWorkflow","steps":[{"type":"step","name":"updateRegionsStep","description":"This step updates regions matching the specified filters.","link":"../../core_flows.Steps_Region/page.mdx#updateregionsstep","depth":1},{"type":"when","condition":"{\n return data.normalizedInput.is_tax_inclusive !== undefined\n }","depth":"2","steps":[{"type":"workflow","name":"updatePricePreferencesWorkflow","description":"This workflow updates one or more price preferences.","link":"../../core_flows.Workflows_Pricing/page.mdx#updatepricepreferencesworkflow","depth":2}]}]}} />
|
||||
|
||||
### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateRegionsWorkflowInput","type":"`UpdateRegionsWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRegionsWorkflow"/>
|
||||
|
||||
### Output
|
||||
|
||||
<TypeList types={[{"name":"UpdateRegionsWorkflowOutput","type":"`UpdateRegionsWorkflowOutput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRegionsWorkflow"/>
|
||||
@@ -0,0 +1,8 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Line Item
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Steps\_Line Item](../core_flows.Steps_Line_Item/page.mdx)
|
||||
- [Workflows\_Line Item](../core_flows.Workflows_Line_Item/page.mdx)
|
||||
@@ -0,0 +1,7 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Notification
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Steps\_Notification](../core_flows.Steps_Notification/page.mdx)
|
||||
@@ -0,0 +1,8 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Payment
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Steps\_Payment](../core_flows.Steps_Payment/page.mdx)
|
||||
- [Workflows\_Payment](../core_flows.Workflows_Payment/page.mdx)
|
||||
@@ -0,0 +1,8 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Payment Collection
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Steps\_Payment Collection](../core_flows.Steps_Payment_Collection/page.mdx)
|
||||
- [Workflows\_Payment Collection](../core_flows.Workflows_Payment_Collection/page.mdx)
|
||||
@@ -0,0 +1,8 @@
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# Region
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Steps\_Region](../core_flows.Steps_Region/page.mdx)
|
||||
- [Workflows\_Region](../core_flows.Workflows_Region/page.mdx)
|
||||
Reference in New Issue
Block a user