From 12db60aadf12a9db4303f2f07c89c3103103aedc Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Tue, 27 Aug 2024 12:00:58 +0300 Subject: [PATCH] docs: [2/n] generate core-flows reference (#8782) --- .../page.mdx | 43 +++ .../page.mdx | 50 ++++ .../page.mdx | 39 +++ .../page.mdx | 47 +++ .../page.mdx | 18 ++ .../page.mdx | 105 +++++++ .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 24 ++ .../page.mdx | 24 ++ .../page.mdx | 24 ++ .../page.mdx | 24 ++ .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../core_flows.Common.Steps_Common/page.mdx | 267 ++++++++++++++++++ .../page.mdx | 73 +++++ .../page.mdx | 20 ++ .../page.mdx | 20 ++ .../page.mdx | 16 ++ .../page.mdx | 16 ++ .../page.mdx | 16 ++ .../page.mdx | 16 ++ .../page.mdx | 20 ++ .../page.mdx | 20 ++ .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 24 ++ .../page.mdx | 46 +++ .../page.mdx | 46 +++ .../page.mdx | 42 +++ .../page.mdx | 42 +++ .../page.mdx | 46 +++ .../page.mdx | 46 +++ .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 97 +++++++ .../page.mdx | 251 ++++++++++++++++ .../page.mdx | 20 ++ .../page.mdx | 16 ++ .../page.mdx | 16 ++ .../page.mdx | 20 ++ .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 24 ++ .../page.mdx | 20 ++ .../page.mdx | 20 ++ .../page.mdx | 24 ++ .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 49 ++++ .../page.mdx | 65 +++++ .../page.mdx | 20 ++ .../page.mdx | 5 + .../page.mdx | 20 ++ .../page.mdx | 5 + .../page.mdx | 15 + .../page.mdx | 15 + .../page.mdx | 16 ++ .../page.mdx | 20 ++ .../page.mdx | 5 + .../page.mdx | 5 + .../page.mdx | 20 ++ .../page.mdx | 24 ++ .../page.mdx | 5 + .../page.mdx | 5 + .../File/core_flows.File.Steps_File/page.mdx | 25 ++ .../core_flows.File.Workflows_File/page.mdx | 33 +++ .../core_flows/core_flows.Common/page.mdx | 8 + .../core_flows/core_flows.Customer/page.mdx | 8 + .../core_flows.Customer_Group/page.mdx | 8 + .../core_flows/core_flows.Defaults/page.mdx | 8 + .../core_flows/core_flows.File/page.mdx | 8 + 93 files changed, 2239 insertions(+) create mode 100644 www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.createRemoteLinkStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.dismissRemoteLinkStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.removeRemoteLinkStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.updateRemoteLinksStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.createLinksStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.dismissRemoteLinkStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.emitEventStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.removeRemoteLinkStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.updateRemoteLinksStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.useRemoteQueryStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.batchLinksWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.createLinksWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.dismissLinksWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.updateLinksWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.batchLinksWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.createLinksWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.dismissLinksWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.updateLinksWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/core_flows.Common.Steps_Common/page.mdx create mode 100644 www/apps/resources/references/core_flows/Common/core_flows.Common.Workflows_Common/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.createCustomerAddressesStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.createCustomersStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.deleteCustomerAddressesStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.deleteCustomersStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.maybeUnsetDefaultBillingAddressesStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.maybeUnsetDefaultShippingAddressesStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.updateCustomerAddressesStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.updateCustomersStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.createCustomerAddressesStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.createCustomersStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.deleteCustomerAddressesStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.deleteCustomersStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.maybeUnsetDefaultBillingAddressesStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.maybeUnsetDefaultShippingAddressesStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.updateCustomerAddresseStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.updateCustomersStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.createCustomersWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.updateCustomersWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/core_flows.Customer.Steps_Customer/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer/core_flows.Customer.Workflows_Customer/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.deleteCustomerGroupStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.linkCustomersToCustomerGroupStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.updateCustomerGroupsStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.deleteCustomerGroupStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.linkCustomersToCustomerGroupStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.updateCustomerGroupStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.createCustomerGroupsWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.deleteCustomerGroupsWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomersToCustomerGroupWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.updateCustomerGroupsWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.createCustomerGroupsWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.deleteCustomerGroupsWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomersToCustomerGroupWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.updateCustomerGroupsWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/core_flows.Customer_Group.Steps_Customer_Group/page.mdx create mode 100644 www/apps/resources/references/core_flows/Customer_Group/core_flows.Customer_Group.Workflows_Customer_Group/page.mdx create mode 100644 www/apps/resources/references/core_flows/Defaults/Steps_Defaults/functions/core_flows.Defaults.Steps_Defaults.createDefaultStoreStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/Defaults/Steps_Defaults/variables/core_flows.Defaults.Steps_Defaults.createDefaultStoreStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/Defaults/Workflows_Defaults/functions/core_flows.Defaults.Workflows_Defaults.createDefaultsWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/Defaults/Workflows_Defaults/variables/core_flows.Defaults.Workflows_Defaults.createDefaultsWorkflowID/page.mdx create mode 100644 www/apps/resources/references/core_flows/Defaults/core_flows.Defaults.Steps_Defaults/page.mdx create mode 100644 www/apps/resources/references/core_flows/Defaults/core_flows.Defaults.Workflows_Defaults/page.mdx create mode 100644 www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.deleteFilesStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx create mode 100644 www/apps/resources/references/core_flows/File/Steps_File/variables/core_flows.File.Steps_File.deleteFilesStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/File/Steps_File/variables/core_flows.File.Steps_File.uploadFilesStepId/page.mdx create mode 100644 www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.deleteFilesWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx create mode 100644 www/apps/resources/references/core_flows/File/Workflows_File/variables/core_flows.File.Workflows_File.deleteFilesWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/File/Workflows_File/variables/core_flows.File.Workflows_File.uploadFilesWorkflowId/page.mdx create mode 100644 www/apps/resources/references/core_flows/File/core_flows.File.Steps_File/page.mdx create mode 100644 www/apps/resources/references/core_flows/File/core_flows.File.Workflows_File/page.mdx create mode 100644 www/apps/resources/references/core_flows/core_flows.Common/page.mdx create mode 100644 www/apps/resources/references/core_flows/core_flows.Customer/page.mdx create mode 100644 www/apps/resources/references/core_flows/core_flows.Customer_Group/page.mdx create mode 100644 www/apps/resources/references/core_flows/core_flows.Defaults/page.mdx create mode 100644 www/apps/resources/references/core_flows/core_flows.File/page.mdx diff --git a/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.createRemoteLinkStep/page.mdx b/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.createRemoteLinkStep/page.mdx new file mode 100644 index 0000000000..94c8736f4d --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.createRemoteLinkStep/page.mdx @@ -0,0 +1,43 @@ +--- +slug: /references/medusa-workflows/steps/createRemoteLinkStep +sidebar_label: createRemoteLinkStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createRemoteLinkStep - Medusa Workflows API Reference + +This documentation provides a reference to the `createRemoteLinkStep`. It belongs to the `@medusajs/core-flows` package. + +This step creates remote links between two records of linked data models. + +Learn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link). + +## Example + +```ts +import { createWorkflow } from "@medusajs/workflows-sdk" +import { createRemoteLinkStep } from "@medusajs/core-flows" +import { Modules } from "@medusajs/utils" + +const helloWorldWorkflow = createWorkflow("hello-world", () => { + createRemoteLinkStep([ + { + [Modules.PRODUCT]: { + product_id: "prod_123", + }, + helloModuleService: { + my_custom_id: "mc_123", + }, + }, + ]) +}) +``` + +## Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRemoteLinkStep"/> + +## Output + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRemoteLinkStep"/> diff --git a/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.dismissRemoteLinkStep/page.mdx b/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.dismissRemoteLinkStep/page.mdx new file mode 100644 index 0000000000..534ca39bd3 --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.dismissRemoteLinkStep/page.mdx @@ -0,0 +1,50 @@ +--- +slug: /references/medusa-workflows/steps/dismissRemoteLinkStep +sidebar_label: dismissRemoteLinkStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# dismissRemoteLinkStep - Medusa Workflows API Reference + +This documentation provides a reference to the `dismissRemoteLinkStep`. It belongs to the `@medusajs/core-flows` package. + +This step removes remote links between two records of linked data models. + +Learn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#dismiss-link). + +## Example + +```ts +import { + createWorkflow +} from "@medusajs/workflows-sdk" +import { + dismissRemoteLinkStep +} from "@medusajs/core-flows" +import { + Modules +} from "@medusajs/utils" + +const helloWorldWorkflow = createWorkflow( + "hello-world", + () => { + dismissRemoteLinkStep([{ + [Modules.PRODUCT]: { + product_id: "prod_123", + }, + "helloModuleService": { + my_custom_id: "mc_123", + }, + }]) + } +) +``` + +## Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="dismissRemoteLinkStep"/> + +## Output + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="dismissRemoteLinkStep"/> diff --git a/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx b/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx new file mode 100644 index 0000000000..174a95b0a2 --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.emitEventStep/page.mdx @@ -0,0 +1,39 @@ +--- +slug: /references/medusa-workflows/steps/emitEventStep +sidebar_label: emitEventStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# emitEventStep - Medusa Workflows API Reference + +This documentation provides a reference to the `emitEventStep`. It belongs to the `@medusajs/core-flows` package. + +Emit an event. + +## Example + +```ts +import { + createWorkflow +} from "@medusajs/workflows-sdk" +import { + emitEventStep +} from "@medusajs/core-flows" + +const helloWorldWorkflow = createWorkflow( + "hello-world", + () => { + emitEventStep({ + eventName: "custom.created", + data: { + id: "123" + } + }) + } +) +``` + +## Input + + diff --git a/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.removeRemoteLinkStep/page.mdx b/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.removeRemoteLinkStep/page.mdx new file mode 100644 index 0000000000..11e41d2cfa --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.removeRemoteLinkStep/page.mdx @@ -0,0 +1,47 @@ +--- +slug: /references/medusa-workflows/steps/removeRemoteLinkStep +sidebar_label: removeRemoteLinkStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# removeRemoteLinkStep - Medusa Workflows API Reference + +This documentation provides a reference to the `removeRemoteLinkStep`. It belongs to the `@medusajs/core-flows` package. + +This step deletes linked records of a record. + +Learn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records) + +## Example + +```ts +import { + createWorkflow +} from "@medusajs/workflows-sdk" +import { + removeRemoteLinkStep +} from "@medusajs/core-flows" +import { + Modules +} from "@medusajs/utils" + +const helloWorldWorkflow = createWorkflow( + "hello-world", + () => { + removeRemoteLinkStep([{ + [Modules.PRODUCT]: { + product_id: "prod_123", + }, + }]) + } +) +``` + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.updateRemoteLinksStep/page.mdx b/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.updateRemoteLinksStep/page.mdx new file mode 100644 index 0000000000..b3a800d866 --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.updateRemoteLinksStep/page.mdx @@ -0,0 +1,18 @@ +--- +slug: /references/medusa-workflows/steps/updateRemoteLinksStep +sidebar_label: updateRemoteLinksStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateRemoteLinksStep - Medusa Workflows API Reference + +This documentation provides a reference to the `updateRemoteLinksStep`. It belongs to the `@medusajs/core-flows` package. + +## Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRemoteLinksStep"/> + +## Output + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRemoteLinksStep"/> diff --git a/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx b/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx new file mode 100644 index 0000000000..f4dfbb84d0 --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Steps_Common/functions/core_flows.Common.Steps_Common.useRemoteQueryStep/page.mdx @@ -0,0 +1,105 @@ +--- +slug: /references/medusa-workflows/steps/useRemoteQueryStep +sidebar_label: useRemoteQueryStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# useRemoteQueryStep - Medusa Workflows API Reference + +This documentation provides a reference to the `useRemoteQueryStep`. It belongs to the `@medusajs/core-flows` package. + +This step fetches data across modules using the remote query. + +Learn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query). + +## Example + +To retrieve a list of records of a data model: + +```ts +import { + createWorkflow +} from "@medusajs/workflows-sdk" +import { + useRemoteQueryStep +} from "@medusajs/core-flows" + +const helloWorldWorkflow = createWorkflow( + "hello-world", + () => { + const products = useRemoteQueryStep({ + entry_point: "product", + fields: [ + "*", + "variants.*" + ] + }) + } +) +``` + +To retrieve a single item instead of a an array: + +```ts +import { + createWorkflow +} from "@medusajs/workflows-sdk" +import { + useRemoteQueryStep +} from "@medusajs/core-flows" + +const helloWorldWorkflow = createWorkflow( + "hello-world", + () => { + const product = useRemoteQueryStep({ + entry_point: "product", + fields: [ + "*", + "variants.*" + ], + variables: { + filters: { + id: "123" + } + }, + list: false + }) + } +) +``` + +To throw an error if a record isn't found matching the specified ID: + +```ts +import { + createWorkflow +} from "@medusajs/workflows-sdk" +import { + useRemoteQueryStep +} from "@medusajs/core-flows" + +const helloWorldWorkflow = createWorkflow( + "hello-world", + () => { + const product = useRemoteQueryStep({ + entry_point: "product", + fields: [ + "*", + "variants.*" + ], + variables: { + filters: { + id: "123" + } + }, + list: false, + throw_if_key_not_found: true + }) + } +) +``` + +## Input + + diff --git a/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.createLinksStepId/page.mdx b/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.createLinksStepId/page.mdx new file mode 100644 index 0000000000..9db1a0f104 --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.createLinksStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createLinksStepId + + `Const` **createLinksStepId**: `"create-remote-links"` diff --git a/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.dismissRemoteLinkStepId/page.mdx b/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.dismissRemoteLinkStepId/page.mdx new file mode 100644 index 0000000000..405d7bf88e --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.dismissRemoteLinkStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# dismissRemoteLinkStepId + + `Const` **dismissRemoteLinkStepId**: `"dismiss-remote-links"` diff --git a/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.emitEventStepId/page.mdx b/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.emitEventStepId/page.mdx new file mode 100644 index 0000000000..a2f936f668 --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.emitEventStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# emitEventStepId + + `Const` **emitEventStepId**: `"emit-event-step"` diff --git a/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.removeRemoteLinkStepId/page.mdx b/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.removeRemoteLinkStepId/page.mdx new file mode 100644 index 0000000000..f87974a2ea --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.removeRemoteLinkStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# removeRemoteLinkStepId + + `Const` **removeRemoteLinkStepId**: `"remove-remote-links"` diff --git a/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.updateRemoteLinksStepId/page.mdx b/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.updateRemoteLinksStepId/page.mdx new file mode 100644 index 0000000000..f1572b867b --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.updateRemoteLinksStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateRemoteLinksStepId + + `Const` **updateRemoteLinksStepId**: `"update-remote-links-step"` diff --git a/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.useRemoteQueryStepId/page.mdx b/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.useRemoteQueryStepId/page.mdx new file mode 100644 index 0000000000..16be9971ae --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Steps_Common/variables/core_flows.Common.Steps_Common.useRemoteQueryStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# useRemoteQueryStepId + + `Const` **useRemoteQueryStepId**: `"use-remote-query"` diff --git a/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.batchLinksWorkflow/page.mdx b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.batchLinksWorkflow/page.mdx new file mode 100644 index 0000000000..3e56e72f23 --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.batchLinksWorkflow/page.mdx @@ -0,0 +1,24 @@ +--- +slug: /references/medusa-workflows/batchLinksWorkflow +sidebar_label: batchLinksWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# batchLinksWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `batchLinksWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow manages one or more links to create, update, or dismiss them. + +## Steps + + + +## Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"LinkDefinition","type":"[LinkDefinition](../../../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)","optional":false,"defaultValue":"","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","expandable":false,"children":[{"name":"data","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"LinkDefinition","type":"[LinkDefinition](../../../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)","optional":false,"defaultValue":"","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","expandable":false,"children":[{"name":"data","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchLinksWorkflow"/> + +## Output + + diff --git a/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.createLinksWorkflow/page.mdx b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.createLinksWorkflow/page.mdx new file mode 100644 index 0000000000..8eb87ada65 --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.createLinksWorkflow/page.mdx @@ -0,0 +1,24 @@ +--- +slug: /references/medusa-workflows/createLinksWorkflow +sidebar_label: createLinksWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createLinksWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `createLinksWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow creates one or more links between records. + +## Steps + + + +## Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createLinksWorkflow"/> + +## Output + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createLinksWorkflow"/> diff --git a/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.dismissLinksWorkflow/page.mdx b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.dismissLinksWorkflow/page.mdx new file mode 100644 index 0000000000..17b1962e42 --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.dismissLinksWorkflow/page.mdx @@ -0,0 +1,24 @@ +--- +slug: /references/medusa-workflows/dismissLinksWorkflow +sidebar_label: dismissLinksWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# dismissLinksWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `dismissLinksWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow dismisses one or more links between records. + +## Steps + + + +## Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="dismissLinksWorkflow"/> + +## Output + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="dismissLinksWorkflow"/> diff --git a/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.updateLinksWorkflow/page.mdx b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.updateLinksWorkflow/page.mdx new file mode 100644 index 0000000000..baff673055 --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Workflows_Common/functions/core_flows.Common.Workflows_Common.updateLinksWorkflow/page.mdx @@ -0,0 +1,24 @@ +--- +slug: /references/medusa-workflows/updateLinksWorkflow +sidebar_label: updateLinksWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateLinksWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `updateLinksWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow updates one or more links between records. + +## Steps + + + +## Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateLinksWorkflow"/> + +## Output + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateLinksWorkflow"/> diff --git a/www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.batchLinksWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.batchLinksWorkflowId/page.mdx new file mode 100644 index 0000000000..f3613cdf77 --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.batchLinksWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# batchLinksWorkflowId + + `Const` **batchLinksWorkflowId**: `"batch-links"` diff --git a/www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.createLinksWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.createLinksWorkflowId/page.mdx new file mode 100644 index 0000000000..ec29ff6aef --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.createLinksWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createLinksWorkflowId + + `Const` **createLinksWorkflowId**: `"create-link"` diff --git a/www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.dismissLinksWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.dismissLinksWorkflowId/page.mdx new file mode 100644 index 0000000000..b188a5e1df --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.dismissLinksWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# dismissLinksWorkflowId + + `Const` **dismissLinksWorkflowId**: `"dismiss-link"` diff --git a/www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.updateLinksWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.updateLinksWorkflowId/page.mdx new file mode 100644 index 0000000000..e228bba9ad --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/Workflows_Common/variables/core_flows.Common.Workflows_Common.updateLinksWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateLinksWorkflowId + + `Const` **updateLinksWorkflowId**: `"update-link"` diff --git a/www/apps/resources/references/core_flows/Common/core_flows.Common.Steps_Common/page.mdx b/www/apps/resources/references/core_flows/Common/core_flows.Common.Steps_Common/page.mdx new file mode 100644 index 0000000000..acd4507c7b --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/core_flows.Common.Steps_Common/page.mdx @@ -0,0 +1,267 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Steps\_Common + +## createRemoteLinkStep + +This step creates remote links between two records of linked data models. + +Learn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link). + +### Example + +```ts +import { createWorkflow } from "@medusajs/workflows-sdk" +import { createRemoteLinkStep } from "@medusajs/core-flows" +import { Modules } from "@medusajs/utils" + +const helloWorldWorkflow = createWorkflow("hello-world", () => { + createRemoteLinkStep([ + { + [Modules.PRODUCT]: { + product_id: "prod_123", + }, + helloModuleService: { + my_custom_id: "mc_123", + }, + }, + ]) +}) +``` + +### Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRemoteLinkStep"/> + +### Output + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createRemoteLinkStep"/> + +___ + +## dismissRemoteLinkStep + +This step removes remote links between two records of linked data models. + +Learn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#dismiss-link). + +### Example + +```ts +import { + createWorkflow +} from "@medusajs/workflows-sdk" +import { + dismissRemoteLinkStep +} from "@medusajs/core-flows" +import { + Modules +} from "@medusajs/utils" + +const helloWorldWorkflow = createWorkflow( + "hello-world", + () => { + dismissRemoteLinkStep([{ + [Modules.PRODUCT]: { + product_id: "prod_123", + }, + "helloModuleService": { + my_custom_id: "mc_123", + }, + }]) + } +) +``` + +### Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="dismissRemoteLinkStep"/> + +### Output + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="dismissRemoteLinkStep"/> + +___ + +## emitEventStep + +Emit an event. + +### Example + +```ts +import { + createWorkflow +} from "@medusajs/workflows-sdk" +import { + emitEventStep +} from "@medusajs/core-flows" + +const helloWorldWorkflow = createWorkflow( + "hello-world", + () => { + emitEventStep({ + eventName: "custom.created", + data: { + id: "123" + } + }) + } +) +``` + +### Input + + + +___ + +## removeRemoteLinkStep + +This step deletes linked records of a record. + +Learn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records) + +### Example + +```ts +import { + createWorkflow +} from "@medusajs/workflows-sdk" +import { + removeRemoteLinkStep +} from "@medusajs/core-flows" +import { + Modules +} from "@medusajs/utils" + +const helloWorldWorkflow = createWorkflow( + "hello-world", + () => { + removeRemoteLinkStep([{ + [Modules.PRODUCT]: { + product_id: "prod_123", + }, + }]) + } +) +``` + +### Input + + + +### Output + + + +___ + +## updateRemoteLinksStep + +### Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRemoteLinksStep"/> + +### Output + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateRemoteLinksStep"/> + +___ + +## useRemoteQueryStep + +This step fetches data across modules using the remote query. + +Learn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query). + +### Example + +To retrieve a list of records of a data model: + +```ts +import { + createWorkflow +} from "@medusajs/workflows-sdk" +import { + useRemoteQueryStep +} from "@medusajs/core-flows" + +const helloWorldWorkflow = createWorkflow( + "hello-world", + () => { + const products = useRemoteQueryStep({ + entry_point: "product", + fields: [ + "*", + "variants.*" + ] + }) + } +) +``` + +To retrieve a single item instead of a an array: + +```ts +import { + createWorkflow +} from "@medusajs/workflows-sdk" +import { + useRemoteQueryStep +} from "@medusajs/core-flows" + +const helloWorldWorkflow = createWorkflow( + "hello-world", + () => { + const product = useRemoteQueryStep({ + entry_point: "product", + fields: [ + "*", + "variants.*" + ], + variables: { + filters: { + id: "123" + } + }, + list: false + }) + } +) +``` + +To throw an error if a record isn't found matching the specified ID: + +```ts +import { + createWorkflow +} from "@medusajs/workflows-sdk" +import { + useRemoteQueryStep +} from "@medusajs/core-flows" + +const helloWorldWorkflow = createWorkflow( + "hello-world", + () => { + const product = useRemoteQueryStep({ + entry_point: "product", + fields: [ + "*", + "variants.*" + ], + variables: { + filters: { + id: "123" + } + }, + list: false, + throw_if_key_not_found: true + }) + } +) +``` + +### Input + + diff --git a/www/apps/resources/references/core_flows/Common/core_flows.Common.Workflows_Common/page.mdx b/www/apps/resources/references/core_flows/Common/core_flows.Common.Workflows_Common/page.mdx new file mode 100644 index 0000000000..fe906dc938 --- /dev/null +++ b/www/apps/resources/references/core_flows/Common/core_flows.Common.Workflows_Common/page.mdx @@ -0,0 +1,73 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Workflows\_Common + +## batchLinksWorkflow + +This workflow manages one or more links to create, update, or dismiss them. + +### Steps + + + +### Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"LinkDefinition","type":"[LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)","optional":false,"defaultValue":"","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","expandable":false,"children":[{"name":"data","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"LinkDefinition","type":"[LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)","optional":false,"defaultValue":"","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","expandable":false,"children":[{"name":"data","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="batchLinksWorkflow"/> + +### Output + + + +___ + +## createLinksWorkflow + +This workflow creates one or more links between records. + +### Steps + + + +### Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createLinksWorkflow"/> + +### Output + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createLinksWorkflow"/> + +___ + +## dismissLinksWorkflow + +This workflow dismisses one or more links between records. + +### Steps + + + +### Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="dismissLinksWorkflow"/> + +### Output + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="dismissLinksWorkflow"/> + +___ + +## updateLinksWorkflow + +This workflow updates one or more links between records. + +### Steps + + + +### Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateLinksWorkflow"/> + +### Output + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateLinksWorkflow"/> diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.createCustomerAddressesStep/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.createCustomerAddressesStep/page.mdx new file mode 100644 index 0000000000..b51ec47088 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.createCustomerAddressesStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/createCustomerAddressesStep +sidebar_label: createCustomerAddressesStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createCustomerAddressesStep - Medusa Workflows API Reference + +This documentation provides a reference to the `createCustomerAddressesStep`. It belongs to the `@medusajs/core-flows` package. + +This step creates one or more customer addresses. + +## Input + + + +## Output + +`","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="createCustomerAddressesStep"/> diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.createCustomersStep/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.createCustomersStep/page.mdx new file mode 100644 index 0000000000..66363edd85 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.createCustomersStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/createCustomersStep +sidebar_label: createCustomersStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createCustomersStep - Medusa Workflows API Reference + +This documentation provides a reference to the `createCustomersStep`. It belongs to the `@medusajs/core-flows` package. + +This step creates one or more customers. + +## Input + + + +## Output + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCustomersStep"/> diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.deleteCustomerAddressesStep/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.deleteCustomerAddressesStep/page.mdx new file mode 100644 index 0000000000..203b723af9 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.deleteCustomerAddressesStep/page.mdx @@ -0,0 +1,16 @@ +--- +slug: /references/medusa-workflows/steps/deleteCustomerAddressesStep +sidebar_label: deleteCustomerAddressesStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteCustomerAddressesStep - Medusa Workflows API Reference + +This documentation provides a reference to the `deleteCustomerAddressesStep`. It belongs to the `@medusajs/core-flows` package. + +This step deletes one or more customer addresses. + +## Input + + diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.deleteCustomersStep/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.deleteCustomersStep/page.mdx new file mode 100644 index 0000000000..eeb64fb3f1 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.deleteCustomersStep/page.mdx @@ -0,0 +1,16 @@ +--- +slug: /references/medusa-workflows/steps/deleteCustomersStep +sidebar_label: deleteCustomersStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteCustomersStep - Medusa Workflows API Reference + +This documentation provides a reference to the `deleteCustomersStep`. It belongs to the `@medusajs/core-flows` package. + +This step deletes one or more customers. + +## Input + + diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.maybeUnsetDefaultBillingAddressesStep/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.maybeUnsetDefaultBillingAddressesStep/page.mdx new file mode 100644 index 0000000000..47a30d1e2d --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.maybeUnsetDefaultBillingAddressesStep/page.mdx @@ -0,0 +1,16 @@ +--- +slug: /references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep +sidebar_label: maybeUnsetDefaultBillingAddressesStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# maybeUnsetDefaultBillingAddressesStep - Medusa Workflows API Reference + +This documentation provides a reference to the `maybeUnsetDefaultBillingAddressesStep`. It belongs to the `@medusajs/core-flows` package. + +This step unsets the `is_default_billing` property of one or more addresses. + +## Input + +` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"update","type":"[UpdateCustomerAddressDTO](../../../../../customer/interfaces/customer.UpdateCustomerAddressDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`null` \\| `string`","description":"The address's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the address is the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the address is the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"The company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The address 1.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The address 2.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../customer/types/customer.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="maybeUnsetDefaultBillingAddressesStep"/> diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.maybeUnsetDefaultShippingAddressesStep/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.maybeUnsetDefaultShippingAddressesStep/page.mdx new file mode 100644 index 0000000000..dc21366576 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.maybeUnsetDefaultShippingAddressesStep/page.mdx @@ -0,0 +1,16 @@ +--- +slug: /references/medusa-workflows/steps/maybeUnsetDefaultShippingAddressesStep +sidebar_label: maybeUnsetDefaultShippingAddressesStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# maybeUnsetDefaultShippingAddressesStep - Medusa Workflows API Reference + +This documentation provides a reference to the `maybeUnsetDefaultShippingAddressesStep`. It belongs to the `@medusajs/core-flows` package. + +This step unsets the `is_default_shipping` property of one or more addresses. + +## Input + +` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"update","type":"[UpdateCustomerAddressDTO](../../../../../customer/interfaces/customer.UpdateCustomerAddressDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`null` \\| `string`","description":"The address's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the address is the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the address is the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"The company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The address 1.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The address 2.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../customer/types/customer.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="maybeUnsetDefaultShippingAddressesStep"/> diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.updateCustomerAddressesStep/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.updateCustomerAddressesStep/page.mdx new file mode 100644 index 0000000000..6d4801644c --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.updateCustomerAddressesStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/updateCustomerAddressesStep +sidebar_label: updateCustomerAddressesStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateCustomerAddressesStep - Medusa Workflows API Reference + +This documentation provides a reference to the `updateCustomerAddressesStep`. It belongs to the `@medusajs/core-flows` package. + +This step updates one or more customer addresses. + +## Input + +` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for addreses by properties such as name and street using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[]","description":"Filter addresses by the associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`string` \\| `string`[] \\| [FilterableCustomerProps](../../../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"Filter addresses by the associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by second address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by phone number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for addreses by properties such as name and street using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[]","description":"Filter addresses by the associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`string` \\| `string`[] \\| [FilterableCustomerProps](../../../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"Filter addresses by the associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by second address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by phone number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"update","type":"[UpdateCustomerAddressDTO](../../../../../customer/interfaces/customer.UpdateCustomerAddressDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`null` \\| `string`","description":"The address's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the address is the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the address is the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"The company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The address 1.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The address 2.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../customer/types/customer.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="updateCustomerAddressesStep"/> + +## Output + +`","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="updateCustomerAddressesStep"/> diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.updateCustomersStep/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.updateCustomersStep/page.mdx new file mode 100644 index 0000000000..4d9fd05136 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/functions/core_flows.Customer.Steps_Customer.updateCustomersStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/updateCustomersStep +sidebar_label: updateCustomersStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateCustomersStep - Medusa Workflows API Reference + +This documentation provides a reference to the `updateCustomersStep`. It belongs to the `@medusajs/core-flows` package. + +This step updates one or more customers. + +## Input + + + +## Output + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCustomersStep"/> diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.createCustomerAddressesStepId/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.createCustomerAddressesStepId/page.mdx new file mode 100644 index 0000000000..e05b363bed --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.createCustomerAddressesStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createCustomerAddressesStepId + + `Const` **createCustomerAddressesStepId**: `"create-customer-addresses"` diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.createCustomersStepId/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.createCustomersStepId/page.mdx new file mode 100644 index 0000000000..5844a21869 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.createCustomersStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createCustomersStepId + + `Const` **createCustomersStepId**: `"create-customers"` diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.deleteCustomerAddressesStepId/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.deleteCustomerAddressesStepId/page.mdx new file mode 100644 index 0000000000..fae4b726c5 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.deleteCustomerAddressesStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteCustomerAddressesStepId + + `Const` **deleteCustomerAddressesStepId**: `"delete-customer-addresses"` diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.deleteCustomersStepId/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.deleteCustomersStepId/page.mdx new file mode 100644 index 0000000000..1d13b92dd8 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.deleteCustomersStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteCustomersStepId + + `Const` **deleteCustomersStepId**: `"delete-customers"` diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.maybeUnsetDefaultBillingAddressesStepId/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.maybeUnsetDefaultBillingAddressesStepId/page.mdx new file mode 100644 index 0000000000..25b6541fae --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.maybeUnsetDefaultBillingAddressesStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# maybeUnsetDefaultBillingAddressesStepId + + `Const` **maybeUnsetDefaultBillingAddressesStepId**: `"maybe-unset-default-billing-customer-addresses"` diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.maybeUnsetDefaultShippingAddressesStepId/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.maybeUnsetDefaultShippingAddressesStepId/page.mdx new file mode 100644 index 0000000000..be8ef09e4a --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.maybeUnsetDefaultShippingAddressesStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# maybeUnsetDefaultShippingAddressesStepId + + `Const` **maybeUnsetDefaultShippingAddressesStepId**: `"maybe-unset-default-shipping-customer-addresses"` diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.updateCustomerAddresseStepId/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.updateCustomerAddresseStepId/page.mdx new file mode 100644 index 0000000000..8ed99a23b4 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.updateCustomerAddresseStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateCustomerAddresseStepId + + `Const` **updateCustomerAddresseStepId**: `"update-customer-addresses"` diff --git a/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.updateCustomersStepId/page.mdx b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.updateCustomersStepId/page.mdx new file mode 100644 index 0000000000..93384069a8 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Steps_Customer/variables/core_flows.Customer.Steps_Customer.updateCustomersStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateCustomersStepId + + `Const` **updateCustomersStepId**: `"update-customer"` diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflow/page.mdx new file mode 100644 index 0000000000..e7e38a9bf4 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflow/page.mdx @@ -0,0 +1,24 @@ +--- +slug: /references/medusa-workflows/createCustomerAccountWorkflow +sidebar_label: createCustomerAccountWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createCustomerAccountWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `createCustomerAccountWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow creates an authentication account for a customer. + +## Steps + + + +## Input + + + +## Output + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCustomerAccountWorkflow"/> diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflow/page.mdx new file mode 100644 index 0000000000..b15492fa8e --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflow/page.mdx @@ -0,0 +1,46 @@ +--- +slug: /references/medusa-workflows/createCustomerAddressesWorkflow +sidebar_label: createCustomerAddressesWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createCustomerAddressesWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `createCustomerAddressesWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow creates one or more customer address. + +## Steps + + + +## Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCustomerAddressesWorkflow"/> + +## Output + +`","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="createCustomerAddressesWorkflow"/> + +## Hooks + +### addressesCreated + +#### Example + +```ts +import { createCustomerAddressesWorkflow } from "@medusajs/core-flows" + +createCustomerAddressesWorkflow.hooks.addressesCreated( + async (({ addresses, additional_data }, { container }) => { + //TODO + }) +) +``` + +#### Input + +Handlers consuming this hook accept the following input. + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesCreated"/> diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx new file mode 100644 index 0000000000..63dd19b672 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.createCustomersWorkflow/page.mdx @@ -0,0 +1,46 @@ +--- +slug: /references/medusa-workflows/createCustomersWorkflow +sidebar_label: createCustomersWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createCustomersWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `createCustomersWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow creates one or more customers. + +## Steps + + + +## Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCustomersWorkflow"/> + +## Output + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCustomersWorkflow"/> + +## Hooks + +### customersCreated + +#### Example + +```ts +import { createCustomersWorkflow } from "@medusajs/core-flows" + +createCustomersWorkflow.hooks.customersCreated( + async (({ customers, additional_data }, { container }) => { + //TODO + }) +) +``` + +#### Input + +Handlers consuming this hook accept the following input. + +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersCreated"/> diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflow/page.mdx new file mode 100644 index 0000000000..8e1376c78f --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflow/page.mdx @@ -0,0 +1,42 @@ +--- +slug: /references/medusa-workflows/deleteCustomerAddressesWorkflow +sidebar_label: deleteCustomerAddressesWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteCustomerAddressesWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `deleteCustomerAddressesWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow deletes one or more customer addresses. + +## Steps + + + +## Input + + + +## Hooks + +### addressesDeleted + +#### Example + +```ts +import { deleteCustomerAddressesWorkflow } from "@medusajs/core-flows" + +deleteCustomerAddressesWorkflow.hooks.addressesDeleted( + async (({ ids }, { container }) => { + //TODO + }) +) +``` + +#### Input + +Handlers consuming this hook accept the following input. + + diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx new file mode 100644 index 0000000000..dc2575d7f4 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflow/page.mdx @@ -0,0 +1,42 @@ +--- +slug: /references/medusa-workflows/deleteCustomersWorkflow +sidebar_label: deleteCustomersWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteCustomersWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `deleteCustomersWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow deletes one or more customers. + +## Steps + + + +## Input + + + +## Hooks + +### customersDeleted + +#### Example + +```ts +import { deleteCustomersWorkflow } from "@medusajs/core-flows" + +deleteCustomersWorkflow.hooks.customersDeleted( + async (({ ids }, { container }) => { + //TODO + }) +) +``` + +#### Input + +Handlers consuming this hook accept the following input. + + diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflow/page.mdx new file mode 100644 index 0000000000..ebc1524bd8 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflow/page.mdx @@ -0,0 +1,46 @@ +--- +slug: /references/medusa-workflows/updateCustomerAddressesWorkflow +sidebar_label: updateCustomerAddressesWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateCustomerAddressesWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `updateCustomerAddressesWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow updates one or more customer addresses. + +## Steps + + + +## Input + +` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../../../customer/types/customer.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for addreses by properties such as name and street using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[]","description":"Filter addresses by the associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`string` \\| `string`[] \\| [FilterableCustomerProps](../../../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"Filter addresses by the associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by second address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by phone number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for addreses by properties such as name and street using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[]","description":"Filter addresses by the associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`string` \\| `string`[] \\| [FilterableCustomerProps](../../../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"Filter addresses by the associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by second address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by phone number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record` \\| [OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"update","type":"[UpdateCustomerAddressDTO](../../../../../customer/interfaces/customer.UpdateCustomerAddressDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`null` \\| `string`","description":"The address's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the address is the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the address is the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"The company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The address 1.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The address 2.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../../../customer/types/customer.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCustomerAddressesWorkflow"/> + +## Output + +`","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="updateCustomerAddressesWorkflow"/> + +## Hooks + +### addressesUpdated + +#### Example + +```ts +import { updateCustomerAddressesWorkflow } from "@medusajs/core-flows" + +updateCustomerAddressesWorkflow.hooks.addressesUpdated( + async (({ addresses, additional_data }, { container }) => { + //TODO + }) +) +``` + +#### Input + +Handlers consuming this hook accept the following input. + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesUpdated"/> diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx new file mode 100644 index 0000000000..f425a44a22 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/functions/core_flows.Customer.Workflows_Customer.updateCustomersWorkflow/page.mdx @@ -0,0 +1,46 @@ +--- +slug: /references/medusa-workflows/updateCustomersWorkflow +sidebar_label: updateCustomersWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateCustomersWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `updateCustomersWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow updates one or more customers. + +## Steps + + + +## Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCustomersWorkflow"/> + +## Output + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCustomersWorkflow"/> + +## Hooks + +### customersUpdated + +#### Example + +```ts +import { updateCustomersWorkflow } from "@medusajs/core-flows" + +updateCustomersWorkflow.hooks.customersUpdated( + async (({ customers, additional_data }, { container }) => { + //TODO + }) +) +``` + +#### Input + +Handlers consuming this hook accept the following input. + +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersUpdated"/> diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflowId/page.mdx new file mode 100644 index 0000000000..9a2fbb4ea3 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.createCustomerAccountWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createCustomerAccountWorkflowId + + `Const` **createCustomerAccountWorkflowId**: `"create-customer-account"` diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflowId/page.mdx new file mode 100644 index 0000000000..d0280ccf82 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.createCustomerAddressesWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createCustomerAddressesWorkflowId + + `Const` **createCustomerAddressesWorkflowId**: `"create-customer-addresses"` diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.createCustomersWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.createCustomersWorkflowId/page.mdx new file mode 100644 index 0000000000..95833d0b01 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.createCustomersWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createCustomersWorkflowId + + `Const` **createCustomersWorkflowId**: `"create-customers"` diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflowId/page.mdx new file mode 100644 index 0000000000..0e59becc0a --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.deleteCustomerAddressesWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteCustomerAddressesWorkflowId + + `Const` **deleteCustomerAddressesWorkflowId**: `"delete-customer-addresses"` diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflowId/page.mdx new file mode 100644 index 0000000000..d82bd0828d --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.deleteCustomersWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteCustomersWorkflowId + + `Const` **deleteCustomersWorkflowId**: `"delete-customers"` diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflowId/page.mdx new file mode 100644 index 0000000000..b5ba47e27e --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.updateCustomerAddressesWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateCustomerAddressesWorkflowId + + `Const` **updateCustomerAddressesWorkflowId**: `"update-customer-addresses"` diff --git a/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.updateCustomersWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.updateCustomersWorkflowId/page.mdx new file mode 100644 index 0000000000..1b11524064 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/Workflows_Customer/variables/core_flows.Customer.Workflows_Customer.updateCustomersWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateCustomersWorkflowId + + `Const` **updateCustomersWorkflowId**: `"update-customers"` diff --git a/www/apps/resources/references/core_flows/Customer/core_flows.Customer.Steps_Customer/page.mdx b/www/apps/resources/references/core_flows/Customer/core_flows.Customer.Steps_Customer/page.mdx new file mode 100644 index 0000000000..dee26ccb63 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/core_flows.Customer.Steps_Customer/page.mdx @@ -0,0 +1,97 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Steps\_Customer + +## createCustomerAddressesStep + +This step creates one or more customer addresses. + +### Input + + + +### Output + +`","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="createCustomerAddressesStep"/> + +___ + +## createCustomersStep + +This step creates one or more customers. + +### Input + + + +### Output + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCustomersStep"/> + +___ + +## deleteCustomerAddressesStep + +This step deletes one or more customer addresses. + +### Input + + + +___ + +## deleteCustomersStep + +This step deletes one or more customers. + +### Input + + + +___ + +## maybeUnsetDefaultBillingAddressesStep + +This step unsets the `is_default_billing` property of one or more addresses. + +### Input + +` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"update","type":"[UpdateCustomerAddressDTO](../../../customer/interfaces/customer.UpdateCustomerAddressDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`null` \\| `string`","description":"The address's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the address is the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the address is the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"The company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The address 1.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The address 2.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../customer/types/customer.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="maybeUnsetDefaultBillingAddressesStep"/> + +___ + +## maybeUnsetDefaultShippingAddressesStep + +This step unsets the `is_default_shipping` property of one or more addresses. + +### Input + +` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"update","type":"[UpdateCustomerAddressDTO](../../../customer/interfaces/customer.UpdateCustomerAddressDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`null` \\| `string`","description":"The address's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the address is the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the address is the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"The company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The address 1.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The address 2.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../customer/types/customer.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="maybeUnsetDefaultShippingAddressesStep"/> + +___ + +## updateCustomerAddressesStep + +This step updates one or more customer addresses. + +### Input + +` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for addreses by properties such as name and street using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[]","description":"Filter addresses by the associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`string` \\| `string`[] \\| [FilterableCustomerProps](../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"Filter addresses by the associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by second address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by phone number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for addreses by properties such as name and street using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[]","description":"Filter addresses by the associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`string` \\| `string`[] \\| [FilterableCustomerProps](../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"Filter addresses by the associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by second address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by phone number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"update","type":"[UpdateCustomerAddressDTO](../../../customer/interfaces/customer.UpdateCustomerAddressDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`null` \\| `string`","description":"The address's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the address is the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the address is the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"The company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The address 1.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The address 2.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../customer/types/customer.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="updateCustomerAddressesStep"/> + +### Output + +`","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="updateCustomerAddressesStep"/> + +___ + +## updateCustomersStep + +This step updates one or more customers. + +### Input + + + +### Output + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCustomersStep"/> diff --git a/www/apps/resources/references/core_flows/Customer/core_flows.Customer.Workflows_Customer/page.mdx b/www/apps/resources/references/core_flows/Customer/core_flows.Customer.Workflows_Customer/page.mdx new file mode 100644 index 0000000000..e62a8b6206 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer/core_flows.Customer.Workflows_Customer/page.mdx @@ -0,0 +1,251 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Workflows\_Customer + +## createCustomerAddressesWorkflow + +This workflow creates one or more customer address. + +### Steps + + + +### Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCustomerAddressesWorkflow"/> + +### Output + +`","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="createCustomerAddressesWorkflow"/> + +### Hooks + +#### addressesCreated + +##### Example + +```ts +import { createCustomerAddressesWorkflow } from "@medusajs/core-flows" + +createCustomerAddressesWorkflow.hooks.addressesCreated( + async (({ addresses, additional_data }, { container }) => { + //TODO + }) +) +``` + +##### Input + +Handlers consuming this hook accept the following input. + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesCreated"/> + +___ + +## createCustomerAccountWorkflow + +This workflow creates an authentication account for a customer. + +### Steps + + + +### Input + + + +### Output + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCustomerAccountWorkflow"/> + +___ + +## createCustomersWorkflow + +This workflow creates one or more customers. + +### Steps + + + +### Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCustomersWorkflow"/> + +### Output + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCustomersWorkflow"/> + +### Hooks + +#### customersCreated + +##### Example + +```ts +import { createCustomersWorkflow } from "@medusajs/core-flows" + +createCustomersWorkflow.hooks.customersCreated( + async (({ customers, additional_data }, { container }) => { + //TODO + }) +) +``` + +##### Input + +Handlers consuming this hook accept the following input. + +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersCreated"/> + +___ + +## deleteCustomerAddressesWorkflow + +This workflow deletes one or more customer addresses. + +### Steps + + + +### Input + + + +### Hooks + +#### addressesDeleted + +##### Example + +```ts +import { deleteCustomerAddressesWorkflow } from "@medusajs/core-flows" + +deleteCustomerAddressesWorkflow.hooks.addressesDeleted( + async (({ ids }, { container }) => { + //TODO + }) +) +``` + +##### Input + +Handlers consuming this hook accept the following input. + + + +___ + +## deleteCustomersWorkflow + +This workflow deletes one or more customers. + +### Steps + + + +### Input + + + +### Hooks + +#### customersDeleted + +##### Example + +```ts +import { deleteCustomersWorkflow } from "@medusajs/core-flows" + +deleteCustomersWorkflow.hooks.customersDeleted( + async (({ ids }, { container }) => { + //TODO + }) +) +``` + +##### Input + +Handlers consuming this hook accept the following input. + + + +___ + +## updateCustomerAddressesWorkflow + +This workflow updates one or more customer addresses. + +### Steps + + + +### Input + +` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T> \\| [ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"[Query](../../../customer/types/customer.Query/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"[ExpandScalar](../../../customer/types/customer.ExpandScalar/page.mdx)<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for addreses by properties such as name and street using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[]","description":"Filter addresses by the associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`string` \\| `string`[] \\| [FilterableCustomerProps](../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"Filter addresses by the associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by second address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by phone number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Searches for addreses by properties such as name and street using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the customer address by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<boolean>","description":"Filter addresses by whether they're the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string` \\| `string`[]","description":"Filter addresses by the associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`string` \\| `string`[] \\| [FilterableCustomerProps](../../../customer/interfaces/customer.FilterableCustomerProps/page.mdx)","description":"Filter addresses by the associated customer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by first address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by second address line.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by phone number.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record` \\| [OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<Record<string, unknown>>","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by created date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../../customer/types/customer.OperatorMap/page.mdx)<string>","description":"Filter addresses by updated date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx) \\| [BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<[FilterableCustomerAddressProps](../../../customer/interfaces/customer.FilterableCustomerAddressProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../customer/interfaces/customer.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"update","type":"[UpdateCustomerAddressDTO](../../../customer/interfaces/customer.UpdateCustomerAddressDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_name","type":"`null` \\| `string`","description":"The address's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_shipping","type":"`boolean`","description":"Whether the address is the default for shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default_billing","type":"`boolean`","description":"Whether the address is the default for billing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The associated customer's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"The company.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The address 1.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The address 2.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../../customer/types/customer.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCustomerAddressesWorkflow"/> + +### Output + +`","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="updateCustomerAddressesWorkflow"/> + +### Hooks + +#### addressesUpdated + +##### Example + +```ts +import { updateCustomerAddressesWorkflow } from "@medusajs/core-flows" + +updateCustomerAddressesWorkflow.hooks.addressesUpdated( + async (({ addresses, additional_data }, { container }) => { + //TODO + }) +) +``` + +##### Input + +Handlers consuming this hook accept the following input. + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="addressesUpdated"/> + +___ + +## updateCustomersWorkflow + +This workflow updates one or more customers. + +### Steps + + + +### Input + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCustomersWorkflow"/> + +### Output + +`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`object`[]","description":"The groups of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the group.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCustomersWorkflow"/> + +### Hooks + +#### customersUpdated + +##### Example + +```ts +import { updateCustomersWorkflow } from "@medusajs/core-flows" + +updateCustomersWorkflow.hooks.customersUpdated( + async (({ customers, additional_data }, { container }) => { + //TODO + }) +) +``` + +##### Input + +Handlers consuming this hook accept the following input. + +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="customersUpdated"/> diff --git a/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStep/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStep/page.mdx new file mode 100644 index 0000000000..e5f6de7b9f --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/createCustomerGroupsStep +sidebar_label: createCustomerGroupsStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createCustomerGroupsStep - Medusa Workflows API Reference + +This documentation provides a reference to the `createCustomerGroupsStep`. It belongs to the `@medusajs/core-flows` package. + +This step creates one or more customer groups. + +## Input + + + +## Output + +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCustomerGroupsStep"/> diff --git a/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.deleteCustomerGroupStep/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.deleteCustomerGroupStep/page.mdx new file mode 100644 index 0000000000..0fcd5af517 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.deleteCustomerGroupStep/page.mdx @@ -0,0 +1,16 @@ +--- +slug: /references/medusa-workflows/steps/deleteCustomerGroupStep +sidebar_label: deleteCustomerGroupStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteCustomerGroupStep - Medusa Workflows API Reference + +This documentation provides a reference to the `deleteCustomerGroupStep`. It belongs to the `@medusajs/core-flows` package. + +This step deletes one or more customer groups. + +## Input + + diff --git a/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.linkCustomersToCustomerGroupStep/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.linkCustomersToCustomerGroupStep/page.mdx new file mode 100644 index 0000000000..b29155ac48 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.linkCustomersToCustomerGroupStep/page.mdx @@ -0,0 +1,16 @@ +--- +slug: /references/medusa-workflows/steps/linkCustomersToCustomerGroupStep +sidebar_label: linkCustomersToCustomerGroupStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# linkCustomersToCustomerGroupStep - Medusa Workflows API Reference + +This documentation provides a reference to the `linkCustomersToCustomerGroupStep`. It belongs to the `@medusajs/core-flows` package. + +This step creates one or more links between customer and customer group records. + +## Input + + diff --git a/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.updateCustomerGroupsStep/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.updateCustomerGroupsStep/page.mdx new file mode 100644 index 0000000000..aa9c9829c5 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/functions/core_flows.Customer_Group.Steps_Customer_Group.updateCustomerGroupsStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/updateCustomerGroupsStep +sidebar_label: updateCustomerGroupsStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateCustomerGroupsStep - Medusa Workflows API Reference + +This documentation provides a reference to the `updateCustomerGroupsStep`. It belongs to the `@medusajs/core-flows` package. + +This step updates one or more customer groups. + +## Input + + + +## Output + +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCustomerGroupsStep"/> diff --git a/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStepId/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStepId/page.mdx new file mode 100644 index 0000000000..a82f0b684b --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.createCustomerGroupsStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createCustomerGroupsStepId + + `Const` **createCustomerGroupsStepId**: `"create-customer-groups"` diff --git a/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.deleteCustomerGroupStepId/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.deleteCustomerGroupStepId/page.mdx new file mode 100644 index 0000000000..3689e317c7 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.deleteCustomerGroupStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteCustomerGroupStepId + + `Const` **deleteCustomerGroupStepId**: `"delete-customer-groups"` diff --git a/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.linkCustomersToCustomerGroupStepId/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.linkCustomersToCustomerGroupStepId/page.mdx new file mode 100644 index 0000000000..be2e40749e --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.linkCustomersToCustomerGroupStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# linkCustomersToCustomerGroupStepId + + `Const` **linkCustomersToCustomerGroupStepId**: `"link-customers-to-customer-group"` diff --git a/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.updateCustomerGroupStepId/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.updateCustomerGroupStepId/page.mdx new file mode 100644 index 0000000000..144ee5eb31 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Steps_Customer_Group/variables/core_flows.Customer_Group.Steps_Customer_Group.updateCustomerGroupStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateCustomerGroupStepId + + `Const` **updateCustomerGroupStepId**: `"update-customer-groups"` diff --git a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.createCustomerGroupsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.createCustomerGroupsWorkflow/page.mdx new file mode 100644 index 0000000000..25d9dd2308 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.createCustomerGroupsWorkflow/page.mdx @@ -0,0 +1,24 @@ +--- +slug: /references/medusa-workflows/createCustomerGroupsWorkflow +sidebar_label: createCustomerGroupsWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createCustomerGroupsWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `createCustomerGroupsWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow creates one or more customer groups. + +## Steps + + + +## Input + + + +## Output + +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCustomerGroupsWorkflow"/> diff --git a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.deleteCustomerGroupsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.deleteCustomerGroupsWorkflow/page.mdx new file mode 100644 index 0000000000..6eadd066a4 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.deleteCustomerGroupsWorkflow/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/deleteCustomerGroupsWorkflow +sidebar_label: deleteCustomerGroupsWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteCustomerGroupsWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `deleteCustomerGroupsWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow deletes one or more customer groups. + +## Steps + + + +## Input + + diff --git a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomersToCustomerGroupWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomersToCustomerGroupWorkflow/page.mdx new file mode 100644 index 0000000000..a194c139fb --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomersToCustomerGroupWorkflow/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/linkCustomersToCustomerGroupWorkflow +sidebar_label: linkCustomersToCustomerGroupWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# linkCustomersToCustomerGroupWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `linkCustomersToCustomerGroupWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow creates one or more links between customer and customer group records. + +## Steps + + + +## Input + + diff --git a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.updateCustomerGroupsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.updateCustomerGroupsWorkflow/page.mdx new file mode 100644 index 0000000000..efc45a279a --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/functions/core_flows.Customer_Group.Workflows_Customer_Group.updateCustomerGroupsWorkflow/page.mdx @@ -0,0 +1,24 @@ +--- +slug: /references/medusa-workflows/updateCustomerGroupsWorkflow +sidebar_label: updateCustomerGroupsWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateCustomerGroupsWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `updateCustomerGroupsWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow updates one or more customer groups. + +## Steps + + + +## Input + + + +## Output + +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCustomerGroupsWorkflow"/> diff --git a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.createCustomerGroupsWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.createCustomerGroupsWorkflowId/page.mdx new file mode 100644 index 0000000000..76f60c5fa6 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.createCustomerGroupsWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createCustomerGroupsWorkflowId + + `Const` **createCustomerGroupsWorkflowId**: `"create-customer-groups"` diff --git a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.deleteCustomerGroupsWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.deleteCustomerGroupsWorkflowId/page.mdx new file mode 100644 index 0000000000..a4e76115a0 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.deleteCustomerGroupsWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteCustomerGroupsWorkflowId + + `Const` **deleteCustomerGroupsWorkflowId**: `"delete-customer-groups"` diff --git a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomersToCustomerGroupWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomersToCustomerGroupWorkflowId/page.mdx new file mode 100644 index 0000000000..ae68e39fa0 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.linkCustomersToCustomerGroupWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# linkCustomersToCustomerGroupWorkflowId + + `Const` **linkCustomersToCustomerGroupWorkflowId**: `"link-customers-to-customer-group"` diff --git a/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.updateCustomerGroupsWorkflowId/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.updateCustomerGroupsWorkflowId/page.mdx new file mode 100644 index 0000000000..9625bbfd8c --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/Workflows_Customer_Group/variables/core_flows.Customer_Group.Workflows_Customer_Group.updateCustomerGroupsWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# updateCustomerGroupsWorkflowId + + `Const` **updateCustomerGroupsWorkflowId**: `"update-customer-groups"` diff --git a/www/apps/resources/references/core_flows/Customer_Group/core_flows.Customer_Group.Steps_Customer_Group/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/core_flows.Customer_Group.Steps_Customer_Group/page.mdx new file mode 100644 index 0000000000..9c0888b740 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/core_flows.Customer_Group.Steps_Customer_Group/page.mdx @@ -0,0 +1,49 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Steps\_Customer Group + +## createCustomerGroupsStep + +This step creates one or more customer groups. + +### Input + + + +### Output + +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCustomerGroupsStep"/> + +___ + +## deleteCustomerGroupStep + +This step deletes one or more customer groups. + +### Input + + + +___ + +## linkCustomersToCustomerGroupStep + +This step creates one or more links between customer and customer group records. + +### Input + + + +___ + +## updateCustomerGroupsStep + +This step updates one or more customer groups. + +### Input + + + +### Output + +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCustomerGroupsStep"/> diff --git a/www/apps/resources/references/core_flows/Customer_Group/core_flows.Customer_Group.Workflows_Customer_Group/page.mdx b/www/apps/resources/references/core_flows/Customer_Group/core_flows.Customer_Group.Workflows_Customer_Group/page.mdx new file mode 100644 index 0000000000..5a064ff8e3 --- /dev/null +++ b/www/apps/resources/references/core_flows/Customer_Group/core_flows.Customer_Group.Workflows_Customer_Group/page.mdx @@ -0,0 +1,65 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Workflows\_Customer Group + +## createCustomerGroupsWorkflow + +This workflow creates one or more customer groups. + +### Steps + + + +### Input + + + +### Output + +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCustomerGroupsWorkflow"/> + +___ + +## deleteCustomerGroupsWorkflow + +This workflow deletes one or more customer groups. + +### Steps + + + +### Input + + + +___ + +## linkCustomersToCustomerGroupWorkflow + +This workflow creates one or more links between customer and customer group records. + +### Steps + + + +### Input + + + +___ + +## updateCustomerGroupsWorkflow + +This workflow updates one or more customer groups. + +### Steps + + + +### Input + + + +### Output + +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string` \\| `Date`","description":"The deletion date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateCustomerGroupsWorkflow"/> diff --git a/www/apps/resources/references/core_flows/Defaults/Steps_Defaults/functions/core_flows.Defaults.Steps_Defaults.createDefaultStoreStep/page.mdx b/www/apps/resources/references/core_flows/Defaults/Steps_Defaults/functions/core_flows.Defaults.Steps_Defaults.createDefaultStoreStep/page.mdx new file mode 100644 index 0000000000..07999a6f8d --- /dev/null +++ b/www/apps/resources/references/core_flows/Defaults/Steps_Defaults/functions/core_flows.Defaults.Steps_Defaults.createDefaultStoreStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/createDefaultStoreStep +sidebar_label: createDefaultStoreStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createDefaultStoreStep - Medusa Workflows API Reference + +This documentation provides a reference to the `createDefaultStoreStep`. It belongs to the `@medusajs/core-flows` package. + +This step creates a default store. + +## Input + + + +## Output + +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"[StoreCurrencyDTO](../../../../../store/interfaces/store.StoreCurrencyDTO/page.mdx)[]","description":"The supported currency codes of the store.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the currency is the default one for the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store_id","type":"`string`","description":"The store ID associated with the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The deleted date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`string`","description":"The associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`string`","description":"The associated default region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`string`","description":"The associated default location's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createDefaultStoreStep"/> diff --git a/www/apps/resources/references/core_flows/Defaults/Steps_Defaults/variables/core_flows.Defaults.Steps_Defaults.createDefaultStoreStepId/page.mdx b/www/apps/resources/references/core_flows/Defaults/Steps_Defaults/variables/core_flows.Defaults.Steps_Defaults.createDefaultStoreStepId/page.mdx new file mode 100644 index 0000000000..7c4ad4b456 --- /dev/null +++ b/www/apps/resources/references/core_flows/Defaults/Steps_Defaults/variables/core_flows.Defaults.Steps_Defaults.createDefaultStoreStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createDefaultStoreStepId + + `Const` **createDefaultStoreStepId**: `"create-default-store"` diff --git a/www/apps/resources/references/core_flows/Defaults/Workflows_Defaults/functions/core_flows.Defaults.Workflows_Defaults.createDefaultsWorkflow/page.mdx b/www/apps/resources/references/core_flows/Defaults/Workflows_Defaults/functions/core_flows.Defaults.Workflows_Defaults.createDefaultsWorkflow/page.mdx new file mode 100644 index 0000000000..3f09f11eb4 --- /dev/null +++ b/www/apps/resources/references/core_flows/Defaults/Workflows_Defaults/functions/core_flows.Defaults.Workflows_Defaults.createDefaultsWorkflow/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/createDefaultsWorkflow +sidebar_label: createDefaultsWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createDefaultsWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `createDefaultsWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow creates default data for a Medusa application. + +## Steps + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/Defaults/Workflows_Defaults/variables/core_flows.Defaults.Workflows_Defaults.createDefaultsWorkflowID/page.mdx b/www/apps/resources/references/core_flows/Defaults/Workflows_Defaults/variables/core_flows.Defaults.Workflows_Defaults.createDefaultsWorkflowID/page.mdx new file mode 100644 index 0000000000..8f76af6148 --- /dev/null +++ b/www/apps/resources/references/core_flows/Defaults/Workflows_Defaults/variables/core_flows.Defaults.Workflows_Defaults.createDefaultsWorkflowID/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# createDefaultsWorkflowID + + `Const` **createDefaultsWorkflowID**: `"create-defaults"` diff --git a/www/apps/resources/references/core_flows/Defaults/core_flows.Defaults.Steps_Defaults/page.mdx b/www/apps/resources/references/core_flows/Defaults/core_flows.Defaults.Steps_Defaults/page.mdx new file mode 100644 index 0000000000..4819356208 --- /dev/null +++ b/www/apps/resources/references/core_flows/Defaults/core_flows.Defaults.Steps_Defaults/page.mdx @@ -0,0 +1,15 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Steps\_Defaults + +## createDefaultStoreStep + +This step creates a default store. + +### Input + + + +### Output + +`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated at of the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"supported_currencies","type":"[StoreCurrencyDTO](../../../store/interfaces/store.StoreCurrencyDTO/page.mdx)[]","description":"The supported currency codes of the store.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency code of the store currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the currency is the default one for the store.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"store_id","type":"`string`","description":"The store ID associated with the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"The created date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"The updated date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"The deleted date of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"default_sales_channel_id","type":"`string`","description":"The associated default sales channel's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_region_id","type":"`string`","description":"The associated default region's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"default_location_id","type":"`string`","description":"The associated default location's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createDefaultStoreStep"/> diff --git a/www/apps/resources/references/core_flows/Defaults/core_flows.Defaults.Workflows_Defaults/page.mdx b/www/apps/resources/references/core_flows/Defaults/core_flows.Defaults.Workflows_Defaults/page.mdx new file mode 100644 index 0000000000..675bcd3d33 --- /dev/null +++ b/www/apps/resources/references/core_flows/Defaults/core_flows.Defaults.Workflows_Defaults/page.mdx @@ -0,0 +1,15 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Workflows\_Defaults + +## createDefaultsWorkflow + +This workflow creates default data for a Medusa application. + +### Steps + + + +### Output + + diff --git a/www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.deleteFilesStep/page.mdx b/www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.deleteFilesStep/page.mdx new file mode 100644 index 0000000000..219e656fcd --- /dev/null +++ b/www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.deleteFilesStep/page.mdx @@ -0,0 +1,16 @@ +--- +slug: /references/medusa-workflows/steps/deleteFilesStep +sidebar_label: deleteFilesStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteFilesStep - Medusa Workflows API Reference + +This documentation provides a reference to the `deleteFilesStep`. It belongs to the `@medusajs/core-flows` package. + +This step deletes one or more files. + +## Input + + diff --git a/www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx b/www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx new file mode 100644 index 0000000000..d3b32cc2d2 --- /dev/null +++ b/www/apps/resources/references/core_flows/File/Steps_File/functions/core_flows.File.Steps_File.uploadFilesStep/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/steps/uploadFilesStep +sidebar_label: uploadFilesStep +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# uploadFilesStep - Medusa Workflows API Reference + +This documentation provides a reference to the `uploadFilesStep`. It belongs to the `@medusajs/core-flows` package. + +This step uploads one or more files. + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/File/Steps_File/variables/core_flows.File.Steps_File.deleteFilesStepId/page.mdx b/www/apps/resources/references/core_flows/File/Steps_File/variables/core_flows.File.Steps_File.deleteFilesStepId/page.mdx new file mode 100644 index 0000000000..5dc19c5ebc --- /dev/null +++ b/www/apps/resources/references/core_flows/File/Steps_File/variables/core_flows.File.Steps_File.deleteFilesStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteFilesStepId + + `Const` **deleteFilesStepId**: `"delete-files"` diff --git a/www/apps/resources/references/core_flows/File/Steps_File/variables/core_flows.File.Steps_File.uploadFilesStepId/page.mdx b/www/apps/resources/references/core_flows/File/Steps_File/variables/core_flows.File.Steps_File.uploadFilesStepId/page.mdx new file mode 100644 index 0000000000..2bbd6cc017 --- /dev/null +++ b/www/apps/resources/references/core_flows/File/Steps_File/variables/core_flows.File.Steps_File.uploadFilesStepId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# uploadFilesStepId + + `Const` **uploadFilesStepId**: `"upload-files"` diff --git a/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.deleteFilesWorkflow/page.mdx b/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.deleteFilesWorkflow/page.mdx new file mode 100644 index 0000000000..f0c4f3bcff --- /dev/null +++ b/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.deleteFilesWorkflow/page.mdx @@ -0,0 +1,20 @@ +--- +slug: /references/medusa-workflows/deleteFilesWorkflow +sidebar_label: deleteFilesWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteFilesWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `deleteFilesWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow deletes one or more files. + +## Steps + + + +## Input + + diff --git a/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx b/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx new file mode 100644 index 0000000000..ded9c7400e --- /dev/null +++ b/www/apps/resources/references/core_flows/File/Workflows_File/functions/core_flows.File.Workflows_File.uploadFilesWorkflow/page.mdx @@ -0,0 +1,24 @@ +--- +slug: /references/medusa-workflows/uploadFilesWorkflow +sidebar_label: uploadFilesWorkflow +--- + +import { TypeList, WorkflowDiagram } from "docs-ui" + +# uploadFilesWorkflow - Medusa Workflows API Reference + +This documentation provides a reference to the `uploadFilesWorkflow`. It belongs to the `@medusajs/core-flows` package. + +This workflow uploads one or more files. + +## Steps + + + +## Input + + + +## Output + + diff --git a/www/apps/resources/references/core_flows/File/Workflows_File/variables/core_flows.File.Workflows_File.deleteFilesWorkflowId/page.mdx b/www/apps/resources/references/core_flows/File/Workflows_File/variables/core_flows.File.Workflows_File.deleteFilesWorkflowId/page.mdx new file mode 100644 index 0000000000..9e5de428d9 --- /dev/null +++ b/www/apps/resources/references/core_flows/File/Workflows_File/variables/core_flows.File.Workflows_File.deleteFilesWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# deleteFilesWorkflowId + + `Const` **deleteFilesWorkflowId**: `"delete-files"` diff --git a/www/apps/resources/references/core_flows/File/Workflows_File/variables/core_flows.File.Workflows_File.uploadFilesWorkflowId/page.mdx b/www/apps/resources/references/core_flows/File/Workflows_File/variables/core_flows.File.Workflows_File.uploadFilesWorkflowId/page.mdx new file mode 100644 index 0000000000..1fe70a5991 --- /dev/null +++ b/www/apps/resources/references/core_flows/File/Workflows_File/variables/core_flows.File.Workflows_File.uploadFilesWorkflowId/page.mdx @@ -0,0 +1,5 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# uploadFilesWorkflowId + + `Const` **uploadFilesWorkflowId**: `"upload-files"` diff --git a/www/apps/resources/references/core_flows/File/core_flows.File.Steps_File/page.mdx b/www/apps/resources/references/core_flows/File/core_flows.File.Steps_File/page.mdx new file mode 100644 index 0000000000..7c23560b1c --- /dev/null +++ b/www/apps/resources/references/core_flows/File/core_flows.File.Steps_File/page.mdx @@ -0,0 +1,25 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Steps\_File + +## deleteFilesStep + +This step deletes one or more files. + +### Input + + + +___ + +## uploadFilesStep + +This step uploads one or more files. + +### Input + + + +### Output + + diff --git a/www/apps/resources/references/core_flows/File/core_flows.File.Workflows_File/page.mdx b/www/apps/resources/references/core_flows/File/core_flows.File.Workflows_File/page.mdx new file mode 100644 index 0000000000..cc8a3871a4 --- /dev/null +++ b/www/apps/resources/references/core_flows/File/core_flows.File.Workflows_File/page.mdx @@ -0,0 +1,33 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Workflows\_File + +## deleteFilesWorkflow + +This workflow deletes one or more files. + +### Steps + + + +### Input + + + +___ + +## uploadFilesWorkflow + +This workflow uploads one or more files. + +### Steps + + + +### Input + + + +### Output + + diff --git a/www/apps/resources/references/core_flows/core_flows.Common/page.mdx b/www/apps/resources/references/core_flows/core_flows.Common/page.mdx new file mode 100644 index 0000000000..9517cec1bc --- /dev/null +++ b/www/apps/resources/references/core_flows/core_flows.Common/page.mdx @@ -0,0 +1,8 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Common + +## Namespaces + +- [Steps\_Common](../core_flows.Steps_Common/page.mdx) +- [Workflows\_Common](../core_flows.Workflows_Common/page.mdx) diff --git a/www/apps/resources/references/core_flows/core_flows.Customer/page.mdx b/www/apps/resources/references/core_flows/core_flows.Customer/page.mdx new file mode 100644 index 0000000000..f900f1875f --- /dev/null +++ b/www/apps/resources/references/core_flows/core_flows.Customer/page.mdx @@ -0,0 +1,8 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Customer + +## Namespaces + +- [Steps\_Customer](../core_flows.Steps_Customer/page.mdx) +- [Workflows\_Customer](../core_flows.Workflows_Customer/page.mdx) diff --git a/www/apps/resources/references/core_flows/core_flows.Customer_Group/page.mdx b/www/apps/resources/references/core_flows/core_flows.Customer_Group/page.mdx new file mode 100644 index 0000000000..3cc678a35f --- /dev/null +++ b/www/apps/resources/references/core_flows/core_flows.Customer_Group/page.mdx @@ -0,0 +1,8 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Customer Group + +## Namespaces + +- [Steps\_Customer Group](../core_flows.Steps_Customer_Group/page.mdx) +- [Workflows\_Customer Group](../core_flows.Workflows_Customer_Group/page.mdx) diff --git a/www/apps/resources/references/core_flows/core_flows.Defaults/page.mdx b/www/apps/resources/references/core_flows/core_flows.Defaults/page.mdx new file mode 100644 index 0000000000..5f1d9353c9 --- /dev/null +++ b/www/apps/resources/references/core_flows/core_flows.Defaults/page.mdx @@ -0,0 +1,8 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# Defaults + +## Namespaces + +- [Steps\_Defaults](../core_flows.Steps_Defaults/page.mdx) +- [Workflows\_Defaults](../core_flows.Workflows_Defaults/page.mdx) diff --git a/www/apps/resources/references/core_flows/core_flows.File/page.mdx b/www/apps/resources/references/core_flows/core_flows.File/page.mdx new file mode 100644 index 0000000000..022b0ab754 --- /dev/null +++ b/www/apps/resources/references/core_flows/core_flows.File/page.mdx @@ -0,0 +1,8 @@ +import { TypeList, WorkflowDiagram } from "docs-ui" + +# File + +## Namespaces + +- [Steps\_File](../core_flows.Steps_File/page.mdx) +- [Workflows\_File](../core_flows.Workflows_File/page.mdx)