chore(docs): Generated References (automated) (#9419)

Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andkodiakhq authored and GitHub committed 2024-10-02 17:13:09 +02:00
1 parent e73e95f5e9
commit 34eebb61eb
585 files changed
+1248 -984

No files matched your search

File diff suppressed because it is too large. Load diff
@@ -47,8 +47,8 @@ In the constructor, you must pass to the parent constructor two parameters:
#### Example #### Example
```ts ```ts
import { AbstractAuthModuleProvider } from "@medusajs/framework/utils" import { AbstractAuthModuleProvider } from "@medusajs/utils"
import { Logger } from "@medusajs/framework/types" import { Logger } from "@medusajs/types"
type InjectedDependencies = { type InjectedDependencies = {
logger: Logger logger: Logger
@@ -119,7 +119,7 @@ import {
AuthIdentityProviderService, AuthIdentityProviderService,
AuthenticationInput, AuthenticationInput,
AuthenticationResponse AuthenticationResponse
} from "@medusajs/framework/types" } from "@medusajs/types"
// ... // ...
class MyAuthProviderService extends AbstractAuthModuleProvider { class MyAuthProviderService extends AbstractAuthModuleProvider {
@@ -162,7 +162,7 @@ import {
AuthIdentityProviderService, AuthIdentityProviderService,
AuthenticationInput, AuthenticationInput,
AuthenticationResponse AuthenticationResponse
} from "@medusajs/framework/types" } from "@medusajs/types"
// ... // ...
class MyAuthProviderService extends AbstractAuthModuleProvider { class MyAuthProviderService extends AbstractAuthModuleProvider {
@@ -220,8 +220,8 @@ import {
AuthIdentityProviderService, AuthIdentityProviderService,
AuthenticationInput, AuthenticationInput,
AuthenticationResponse AuthenticationResponse
} from "@medusajs/framework/types" } from "@medusajs/types"
import { MedusaError } from "@medusajs/framework/utils" import { MedusaError } from "@medusajs/utils"
// ... // ...
class MyAuthProviderService extends AbstractAuthModuleProvider { class MyAuthProviderService extends AbstractAuthModuleProvider {
@@ -282,8 +282,8 @@ import {
AuthIdentityProviderService, AuthIdentityProviderService,
AuthenticationInput, AuthenticationInput,
AuthenticationResponse AuthenticationResponse
} from "@medusajs/framework/types" } from "@medusajs/types"
import { MedusaError } from "@medusajs/framework/utils" import { MedusaError } from "@medusajs/utils"
// ... // ...
class MyAuthProviderService extends AbstractAuthModuleProvider { class MyAuthProviderService extends AbstractAuthModuleProvider {
@@ -344,7 +344,7 @@ import {
AuthIdentityProviderService, AuthIdentityProviderService,
AuthenticationInput, AuthenticationInput,
AuthenticationResponse AuthenticationResponse
} from "@medusajs/framework/types" } from "@medusajs/types"
// ... // ...
class MyAuthProviderService extends AbstractAuthModuleProvider { class MyAuthProviderService extends AbstractAuthModuleProvider {
@@ -436,7 +436,7 @@ module.exports = defineConfig({
// ... // ...
modules: { modules: {
[Modules.AUTH]: { [Modules.AUTH]: {
resolve: "@medusajs/auth", resolve: "@medusajs/framework/auth",
options: { options: {
providers: [ providers: [
{ {
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createApiKeysStep - Medusa Workflows API Reference # createApiKeysStep - Medusa Workflows API Reference
This documentation provides a reference to the `createApiKeysStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createApiKeysStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step creates one or more API keys. This step creates one or more API keys.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteApiKeysStep - Medusa Workflows API Reference # deleteApiKeysStep - Medusa Workflows API Reference
This documentation provides a reference to the `deleteApiKeysStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `deleteApiKeysStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step deletes one or more API keys. This step deletes one or more API keys.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# linkSalesChannelsToApiKeyStep - Medusa Workflows API Reference # linkSalesChannelsToApiKeyStep - Medusa Workflows API Reference
This documentation provides a reference to the `linkSalesChannelsToApiKeyStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `linkSalesChannelsToApiKeyStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step links sales channels to API keys. This step links sales channels to API keys.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# revokeApiKeysStep - Medusa Workflows API Reference # revokeApiKeysStep - Medusa Workflows API Reference
This documentation provides a reference to the `revokeApiKeysStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `revokeApiKeysStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step revokes one or more API keys. This step revokes one or more API keys.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateApiKeysStep - Medusa Workflows API Reference # updateApiKeysStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateApiKeysStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateApiKeysStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step updates one or more API keys. This step updates one or more API keys.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# validateSalesChannelsExistStep - Medusa Workflows API Reference # validateSalesChannelsExistStep - Medusa Workflows API Reference
This documentation provides a reference to the `validateSalesChannelsExistStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `validateSalesChannelsExistStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step validates that a sales channel exists before linking it to an API key. This step validates that a sales channel exists before linking it to an API key.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createApiKeysWorkflow - Medusa Workflows API Reference # createApiKeysWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createApiKeysWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createApiKeysWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow creates one or more API keys. This workflow creates one or more API keys.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteApiKeysWorkflow - Medusa Workflows API Reference # deleteApiKeysWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `deleteApiKeysWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `deleteApiKeysWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow deletes one or more API keys. This workflow deletes one or more API keys.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# linkSalesChannelsToApiKeyWorkflow - Medusa Workflows API Reference # linkSalesChannelsToApiKeyWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `linkSalesChannelsToApiKeyWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `linkSalesChannelsToApiKeyWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow links sales channels to API keys. This workflow links sales channels to API keys.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# revokeApiKeysWorkflow - Medusa Workflows API Reference # revokeApiKeysWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `revokeApiKeysWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `revokeApiKeysWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow revokes one or more API keys. This workflow revokes one or more API keys.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateApiKeysWorkflow - Medusa Workflows API Reference # updateApiKeysWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateApiKeysWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateApiKeysWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow creates one or more API keys. This workflow creates one or more API keys.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# setAuthAppMetadataStep - Medusa Workflows API Reference # setAuthAppMetadataStep - Medusa Workflows API Reference
This documentation provides a reference to the `setAuthAppMetadataStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `setAuthAppMetadataStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step sets the `app_metadata` property of an auth identity. This step sets the `app_metadata` property of an auth identity.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# generateResetPasswordTokenWorkflow - Medusa Workflows API Reference # generateResetPasswordTokenWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `generateResetPasswordTokenWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `generateResetPasswordTokenWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
## Steps ## Steps
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# addShippingMethodToCartStep - Medusa Workflows API Reference # addShippingMethodToCartStep - Medusa Workflows API Reference
This documentation provides a reference to the `addShippingMethodToCartStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `addShippingMethodToCartStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step adds shipping methods to a cart. This step adds shipping methods to a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# confirmInventoryStep - Medusa Workflows API Reference # confirmInventoryStep - Medusa Workflows API Reference
This documentation provides a reference to the `confirmInventoryStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `confirmInventoryStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step confirms for one or more variants that their inventory has a required quantity. This step confirms for one or more variants that their inventory has a required quantity.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createCartsStep - Medusa Workflows API Reference # createCartsStep - Medusa Workflows API Reference
This documentation provides a reference to the `createCartsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createCartsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step creates a cart. This step creates a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createLineItemAdjustmentsStep - Medusa Workflows API Reference # createLineItemAdjustmentsStep - Medusa Workflows API Reference
This documentation provides a reference to the `createLineItemAdjustmentsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createLineItemAdjustmentsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step creates line item adjustments in a cart. This step creates line item adjustments in a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createLineItemsStep - Medusa Workflows API Reference # createLineItemsStep - Medusa Workflows API Reference
This documentation provides a reference to the `createLineItemsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createLineItemsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step creates line item in a cart. This step creates line item in a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createPaymentCollectionsStep - Medusa Workflows API Reference # createPaymentCollectionsStep - Medusa Workflows API Reference
This documentation provides a reference to the `createPaymentCollectionsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createPaymentCollectionsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step creates payment collections in a cart. This step creates payment collections in a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createShippingMethodAdjustmentsStep - Medusa Workflows API Reference # createShippingMethodAdjustmentsStep - Medusa Workflows API Reference
This documentation provides a reference to the `createShippingMethodAdjustmentsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createShippingMethodAdjustmentsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step creates shipping method adjustments for a cart. This step creates shipping method adjustments for a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# findOneOrAnyRegionStep - Medusa Workflows API Reference # findOneOrAnyRegionStep - Medusa Workflows API Reference
This documentation provides a reference to the `findOneOrAnyRegionStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `findOneOrAnyRegionStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step retrieves a region either by the provided ID or the first region in the first store. This step retrieves a region either by the provided ID or the first region in the first store.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# findOrCreateCustomerStep - Medusa Workflows API Reference # findOrCreateCustomerStep - Medusa Workflows API Reference
This documentation provides a reference to the `findOrCreateCustomerStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `findOrCreateCustomerStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step either finds a customer matching the specified ID, or finds / create a customer This step either finds a customer matching the specified ID, or finds / create a customer
matching the specified email. If both ID and email are provided, ID takes precedence. matching the specified email. If both ID and email are provided, ID takes precedence.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# findSalesChannelStep - Medusa Workflows API Reference # findSalesChannelStep - Medusa Workflows API Reference
This documentation provides a reference to the `findSalesChannelStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `findSalesChannelStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step either retrieves a sales channel either using the ID provided as an input, or, if no ID This step either retrieves a sales channel either using the ID provided as an input, or, if no ID
is provided, the default sales channel of the first store. is provided, the default sales channel of the first store.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# getActionsToComputeFromPromotionsStep - Medusa Workflows API Reference # getActionsToComputeFromPromotionsStep - Medusa Workflows API Reference
This documentation provides a reference to the `getActionsToComputeFromPromotionsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `getActionsToComputeFromPromotionsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step retrieves the actions to compute based on the promotions This step retrieves the actions to compute based on the promotions
applied on a cart. applied on a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# getItemTaxLinesStep - Medusa Workflows API Reference # getItemTaxLinesStep - Medusa Workflows API Reference
This documentation provides a reference to the `getItemTaxLinesStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `getItemTaxLinesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step retrieves the tax lines of the specified line items in a cart. This step retrieves the tax lines of the specified line items in a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# getLineItemActionsStep - Medusa Workflows API Reference # getLineItemActionsStep - Medusa Workflows API Reference
This documentation provides a reference to the `getLineItemActionsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `getLineItemActionsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step returns lists of cart line items to create or update based on the This step returns lists of cart line items to create or update based on the
provided input. provided input.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# getPromotionCodesToApply - Medusa Workflows API Reference # getPromotionCodesToApply - Medusa Workflows API Reference
This documentation provides a reference to the `getPromotionCodesToApply`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `getPromotionCodesToApply`. It belongs to the `@medusajs/medusa/core-flows` package.
This step retrieves the promotion codes to apply on a cart. This step retrieves the promotion codes to apply on a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# getVariantPriceSetsStep - Medusa Workflows API Reference # getVariantPriceSetsStep - Medusa Workflows API Reference
This documentation provides a reference to the `getVariantPriceSetsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `getVariantPriceSetsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step retrieves the calculated price sets of the specified variants. This step retrieves the calculated price sets of the specified variants.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# getVariantsStep - Medusa Workflows API Reference # getVariantsStep - Medusa Workflows API Reference
This documentation provides a reference to the `getVariantsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `getVariantsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step retrieves variants matching the specified filters. This step retrieves variants matching the specified filters.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# prepareAdjustmentsFromPromotionActionsStep - Medusa Workflows API Reference # prepareAdjustmentsFromPromotionActionsStep - Medusa Workflows API Reference
This documentation provides a reference to the `prepareAdjustmentsFromPromotionActionsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `prepareAdjustmentsFromPromotionActionsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step prepares the line item or shipping method adjustments using This step prepares the line item or shipping method adjustments using
actions computed by the Promotion Module. actions computed by the Promotion Module.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# refreshCartShippingMethodsStep - Medusa Workflows API Reference # refreshCartShippingMethodsStep - Medusa Workflows API Reference
This documentation provides a reference to the `refreshCartShippingMethodsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `refreshCartShippingMethodsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step refreshes the shipping methods of a cart. This step refreshes the shipping methods of a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# removeLineItemAdjustmentsStep - Medusa Workflows API Reference # removeLineItemAdjustmentsStep - Medusa Workflows API Reference
This documentation provides a reference to the `removeLineItemAdjustmentsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `removeLineItemAdjustmentsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step removes line item adjustments from a cart. This step removes line item adjustments from a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# removeShippingMethodAdjustmentsStep - Medusa Workflows API Reference # removeShippingMethodAdjustmentsStep - Medusa Workflows API Reference
This documentation provides a reference to the `removeShippingMethodAdjustmentsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `removeShippingMethodAdjustmentsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step removes shipping method adjustments from a cart. This step removes shipping method adjustments from a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# removeShippingMethodFromCartStep - Medusa Workflows API Reference # removeShippingMethodFromCartStep - Medusa Workflows API Reference
This documentation provides a reference to the `removeShippingMethodFromCartStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `removeShippingMethodFromCartStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step removes shipping methods from a cart. This step removes shipping methods from a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# reserveInventoryStep - Medusa Workflows API Reference # reserveInventoryStep - Medusa Workflows API Reference
This documentation provides a reference to the `reserveInventoryStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `reserveInventoryStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step reserves the quantity of line items from the associated This step reserves the quantity of line items from the associated
variant's inventory. variant's inventory.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# retrieveCartStep - Medusa Workflows API Reference # retrieveCartStep - Medusa Workflows API Reference
This documentation provides a reference to the `retrieveCartStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `retrieveCartStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step retrieves a cart's details. This step retrieves a cart's details.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# retrieveCartWithLinksStep - Medusa Workflows API Reference # retrieveCartWithLinksStep - Medusa Workflows API Reference
This documentation provides a reference to the `retrieveCartWithLinksStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `retrieveCartWithLinksStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step retrieves a cart's details with its linked records. This step retrieves a cart's details with its linked records.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# setTaxLinesForItemsStep - Medusa Workflows API Reference # setTaxLinesForItemsStep - Medusa Workflows API Reference
This documentation provides a reference to the `setTaxLinesForItemsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `setTaxLinesForItemsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step sets the tax lines of shipping methods and line items in a cart. This step sets the tax lines of shipping methods and line items in a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCartPromotionsStep - Medusa Workflows API Reference # updateCartPromotionsStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateCartPromotionsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateCartPromotionsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step updates the promotions applied on a cart. This step updates the promotions applied on a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCartsStep - Medusa Workflows API Reference # updateCartsStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateCartsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateCartsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step updates a cart. This step updates a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateLineItemsStep - Medusa Workflows API Reference # updateLineItemsStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateLineItemsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateLineItemsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step updates a cart's line items. This step updates a cart's line items.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# validateCartPaymentsStep - Medusa Workflows API Reference # validateCartPaymentsStep - Medusa Workflows API Reference
This documentation provides a reference to the `validateCartPaymentsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `validateCartPaymentsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step validates a cart's payment sessions. Their status must This step validates a cart's payment sessions. Their status must
be `pending` or `requires_more`. be `pending` or `requires_more`.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# validateCartShippingOptionsStep - Medusa Workflows API Reference # validateCartShippingOptionsStep - Medusa Workflows API Reference
This documentation provides a reference to the `validateCartShippingOptionsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `validateCartShippingOptionsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step validates shipping options to ensure they can be applied on a cart. This step validates shipping options to ensure they can be applied on a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# validateVariantPricesStep - Medusa Workflows API Reference # validateVariantPricesStep - Medusa Workflows API Reference
This documentation provides a reference to the `validateVariantPricesStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `validateVariantPricesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step validates the specified variant objects to ensure they have prices. This step validates the specified variant objects to ensure they have prices.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# addShippingMethodToWorkflow - Medusa Workflows API Reference # addShippingMethodToWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `addShippingMethodToWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `addShippingMethodToWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow adds shipping methods to a cart. This workflow adds shipping methods to a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# addToCartWorkflow - Medusa Workflows API Reference # addToCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `addToCartWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `addToCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow adds items to a cart. This workflow adds items to a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# completeCartWorkflow - Medusa Workflows API Reference # completeCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `completeCartWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `completeCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow completes a cart. This workflow completes a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# confirmVariantInventoryWorkflow - Medusa Workflows API Reference # confirmVariantInventoryWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `confirmVariantInventoryWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `confirmVariantInventoryWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow confirms for one or more variants that their inventory has a required quantity. This workflow confirms for one or more variants that their inventory has a required quantity.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createCartWorkflow - Medusa Workflows API Reference # createCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createCartWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow creates a cart. This workflow creates a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createPaymentCollectionForCartWorkflow - Medusa Workflows API Reference # createPaymentCollectionForCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createPaymentCollectionForCartWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createPaymentCollectionForCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow creates a payment collection for a cart. This workflow creates a payment collection for a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# listShippingOptionsForCartWorkflow - Medusa Workflows API Reference # listShippingOptionsForCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `listShippingOptionsForCartWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `listShippingOptionsForCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow lists the shipping options of a cart. This workflow lists the shipping options of a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# refreshPaymentCollectionForCartWorkflow - Medusa Workflows API Reference # refreshPaymentCollectionForCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `refreshPaymentCollectionForCartWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `refreshPaymentCollectionForCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow refreshes the payment collections of a cart. This workflow refreshes the payment collections of a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCartPromotionsWorkflow - Medusa Workflows API Reference # updateCartPromotionsWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateCartPromotionsWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateCartPromotionsWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow updates a cart's promotions. This workflow updates a cart's promotions.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCartWorkflow - Medusa Workflows API Reference # updateCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateCartWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow updates a cart. This workflow updates a cart.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateLineItemInCartWorkflow - Medusa Workflows API Reference # updateLineItemInCartWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateLineItemInCartWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateLineItemInCartWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow updates a cart's line item. This workflow updates a cart's line item.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateTaxLinesWorkflow - Medusa Workflows API Reference # updateTaxLinesWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateTaxLinesWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateTaxLinesWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow updates a cart's tax lines. This workflow updates a cart's tax lines.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# validateExistingPaymentCollectionStep - Medusa Workflows API Reference # validateExistingPaymentCollectionStep - Medusa Workflows API Reference
This documentation provides a reference to the `validateExistingPaymentCollectionStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `validateExistingPaymentCollectionStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step validates that a cart doesn't have a payment collection. This step validates that a cart doesn't have a payment collection.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createRemoteLinkStep - Medusa Workflows API Reference # createRemoteLinkStep - Medusa Workflows API Reference
This documentation provides a reference to the `createRemoteLinkStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createRemoteLinkStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step creates remote links between two records of linked data models. This step creates remote links between two records of linked data models.
@@ -16,9 +16,9 @@ Learn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/adva
## Example ## Example
```ts ```ts
import { createWorkflow } from "@medusajs/framework/workflows-sdk" import { createWorkflow } from "@medusajs/workflows-sdk"
import { createRemoteLinkStep } from "@medusajs/core-flows" import { createRemoteLinkStep } from "@medusajs/core-flows"
import { Modules } from "@medusajs/framework/utils" import { Modules } from "@medusajs/utils"
const helloWorldWorkflow = createWorkflow("hello-world", () => { const helloWorldWorkflow = createWorkflow("hello-world", () => {
createRemoteLinkStep([ createRemoteLinkStep([
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# dismissRemoteLinkStep - Medusa Workflows API Reference # dismissRemoteLinkStep - Medusa Workflows API Reference
This documentation provides a reference to the `dismissRemoteLinkStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `dismissRemoteLinkStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step removes remote links between two records of linked data models. This step removes remote links between two records of linked data models.
@@ -18,13 +18,13 @@ Learn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/adva
```ts ```ts
import { import {
createWorkflow createWorkflow
} from "@medusajs/framework/workflows-sdk" } from "@medusajs/workflows-sdk"
import { import {
dismissRemoteLinkStep dismissRemoteLinkStep
} from "@medusajs/core-flows" } from "@medusajs/core-flows"
import { import {
Modules Modules
} from "@medusajs/framework/utils" } from "@medusajs/utils"
const helloWorldWorkflow = createWorkflow( const helloWorldWorkflow = createWorkflow(
"hello-world", "hello-world",
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# emitEventStep - Medusa Workflows API Reference # emitEventStep - Medusa Workflows API Reference
This documentation provides a reference to the `emitEventStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `emitEventStep`. It belongs to the `@medusajs/medusa/core-flows` package.
Emit an event. Emit an event.
@@ -16,7 +16,7 @@ Emit an event.
```ts ```ts
import { import {
createWorkflow createWorkflow
} from "@medusajs/framework/workflows-sdk" } from "@medusajs/workflows-sdk"
import { import {
emitEventStep emitEventStep
} from "@medusajs/core-flows" } from "@medusajs/core-flows"
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# removeRemoteLinkStep - Medusa Workflows API Reference # removeRemoteLinkStep - Medusa Workflows API Reference
This documentation provides a reference to the `removeRemoteLinkStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `removeRemoteLinkStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step deletes linked records of a record. This step deletes linked records of a record.
@@ -18,13 +18,13 @@ Learn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advan
```ts ```ts
import { import {
createWorkflow createWorkflow
} from "@medusajs/framework/workflows-sdk" } from "@medusajs/workflows-sdk"
import { import {
removeRemoteLinkStep removeRemoteLinkStep
} from "@medusajs/core-flows" } from "@medusajs/core-flows"
import { import {
Modules Modules
} from "@medusajs/framework/utils" } from "@medusajs/utils"
const helloWorldWorkflow = createWorkflow( const helloWorldWorkflow = createWorkflow(
"hello-world", "hello-world",
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateRemoteLinksStep - Medusa Workflows API Reference # updateRemoteLinksStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateRemoteLinksStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateRemoteLinksStep`. It belongs to the `@medusajs/medusa/core-flows` package.
## Input ## Input
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# useRemoteQueryStep - Medusa Workflows API Reference # useRemoteQueryStep - Medusa Workflows API Reference
This documentation provides a reference to the `useRemoteQueryStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `useRemoteQueryStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step fetches data across modules using the remote query. This step fetches data across modules using the remote query.
@@ -20,7 +20,7 @@ To retrieve a list of records of a data model:
```ts ```ts
import { import {
createWorkflow createWorkflow
} from "@medusajs/framework/workflows-sdk" } from "@medusajs/workflows-sdk"
import { import {
useRemoteQueryStep useRemoteQueryStep
} from "@medusajs/core-flows" } from "@medusajs/core-flows"
@@ -44,7 +44,7 @@ To retrieve a single item instead of a an array:
```ts ```ts
import { import {
createWorkflow createWorkflow
} from "@medusajs/framework/workflows-sdk" } from "@medusajs/workflows-sdk"
import { import {
useRemoteQueryStep useRemoteQueryStep
} from "@medusajs/core-flows" } from "@medusajs/core-flows"
@@ -74,7 +74,7 @@ To throw an error if a record isn't found matching the specified ID:
```ts ```ts
import { import {
createWorkflow createWorkflow
} from "@medusajs/framework/workflows-sdk" } from "@medusajs/workflows-sdk"
import { import {
useRemoteQueryStep useRemoteQueryStep
} from "@medusajs/core-flows" } from "@medusajs/core-flows"
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# batchLinksWorkflow - Medusa Workflows API Reference # batchLinksWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `batchLinksWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `batchLinksWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow manages one or more links to create, update, or dismiss them. This workflow manages one or more links to create, update, or dismiss them.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createLinksWorkflow - Medusa Workflows API Reference # createLinksWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createLinksWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createLinksWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow creates one or more links between records. This workflow creates one or more links between records.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# dismissLinksWorkflow - Medusa Workflows API Reference # dismissLinksWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `dismissLinksWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `dismissLinksWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow dismisses one or more links between records. This workflow dismisses one or more links between records.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateLinksWorkflow - Medusa Workflows API Reference # updateLinksWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateLinksWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateLinksWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow updates one or more links between records. This workflow updates one or more links between records.
@@ -11,9 +11,9 @@ Learn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/adva
### Example ### Example
```ts ```ts
import { createWorkflow } from "@medusajs/framework/workflows-sdk" import { createWorkflow } from "@medusajs/workflows-sdk"
import { createRemoteLinkStep } from "@medusajs/core-flows" import { createRemoteLinkStep } from "@medusajs/core-flows"
import { Modules } from "@medusajs/framework/utils" import { Modules } from "@medusajs/utils"
const helloWorldWorkflow = createWorkflow("hello-world", () => { const helloWorldWorkflow = createWorkflow("hello-world", () => {
createRemoteLinkStep([ createRemoteLinkStep([
@@ -50,13 +50,13 @@ Learn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/adva
```ts ```ts
import { import {
createWorkflow createWorkflow
} from "@medusajs/framework/workflows-sdk" } from "@medusajs/workflows-sdk"
import { import {
dismissRemoteLinkStep dismissRemoteLinkStep
} from "@medusajs/core-flows" } from "@medusajs/core-flows"
import { import {
Modules Modules
} from "@medusajs/framework/utils" } from "@medusajs/utils"
const helloWorldWorkflow = createWorkflow( const helloWorldWorkflow = createWorkflow(
"hello-world", "hello-world",
@@ -92,7 +92,7 @@ Emit an event.
```ts ```ts
import { import {
createWorkflow createWorkflow
} from "@medusajs/framework/workflows-sdk" } from "@medusajs/workflows-sdk"
import { import {
emitEventStep emitEventStep
} from "@medusajs/core-flows" } from "@medusajs/core-flows"
@@ -127,13 +127,13 @@ Learn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advan
```ts ```ts
import { import {
createWorkflow createWorkflow
} from "@medusajs/framework/workflows-sdk" } from "@medusajs/workflows-sdk"
import { import {
removeRemoteLinkStep removeRemoteLinkStep
} from "@medusajs/core-flows" } from "@medusajs/core-flows"
import { import {
Modules Modules
} from "@medusajs/framework/utils" } from "@medusajs/utils"
const helloWorldWorkflow = createWorkflow( const helloWorldWorkflow = createWorkflow(
"hello-world", "hello-world",
@@ -182,7 +182,7 @@ To retrieve a list of records of a data model:
```ts ```ts
import { import {
createWorkflow createWorkflow
} from "@medusajs/framework/workflows-sdk" } from "@medusajs/workflows-sdk"
import { import {
useRemoteQueryStep useRemoteQueryStep
} from "@medusajs/core-flows" } from "@medusajs/core-flows"
@@ -206,7 +206,7 @@ To retrieve a single item instead of a an array:
```ts ```ts
import { import {
createWorkflow createWorkflow
} from "@medusajs/framework/workflows-sdk" } from "@medusajs/workflows-sdk"
import { import {
useRemoteQueryStep useRemoteQueryStep
} from "@medusajs/core-flows" } from "@medusajs/core-flows"
@@ -236,7 +236,7 @@ To throw an error if a record isn't found matching the specified ID:
```ts ```ts
import { import {
createWorkflow createWorkflow
} from "@medusajs/framework/workflows-sdk" } from "@medusajs/workflows-sdk"
import { import {
useRemoteQueryStep useRemoteQueryStep
} from "@medusajs/core-flows" } from "@medusajs/core-flows"
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomerAddressesStep - Medusa Workflows API Reference # createCustomerAddressesStep - Medusa Workflows API Reference
This documentation provides a reference to the `createCustomerAddressesStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createCustomerAddressesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step creates one or more customer addresses. This step creates one or more customer addresses.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomersStep - Medusa Workflows API Reference # createCustomersStep - Medusa Workflows API Reference
This documentation provides a reference to the `createCustomersStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createCustomersStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step creates one or more customers. This step creates one or more customers.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteCustomerAddressesStep - Medusa Workflows API Reference # deleteCustomerAddressesStep - Medusa Workflows API Reference
This documentation provides a reference to the `deleteCustomerAddressesStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `deleteCustomerAddressesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step deletes one or more customer addresses. This step deletes one or more customer addresses.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteCustomersStep - Medusa Workflows API Reference # deleteCustomersStep - Medusa Workflows API Reference
This documentation provides a reference to the `deleteCustomersStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `deleteCustomersStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step deletes one or more customers. This step deletes one or more customers.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# maybeUnsetDefaultBillingAddressesStep - Medusa Workflows API Reference # maybeUnsetDefaultBillingAddressesStep - Medusa Workflows API Reference
This documentation provides a reference to the `maybeUnsetDefaultBillingAddressesStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `maybeUnsetDefaultBillingAddressesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step unsets the `is_default_billing` property of one or more addresses. This step unsets the `is_default_billing` property of one or more addresses.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# maybeUnsetDefaultShippingAddressesStep - Medusa Workflows API Reference # maybeUnsetDefaultShippingAddressesStep - Medusa Workflows API Reference
This documentation provides a reference to the `maybeUnsetDefaultShippingAddressesStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `maybeUnsetDefaultShippingAddressesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step unsets the `is_default_shipping` property of one or more addresses. This step unsets the `is_default_shipping` property of one or more addresses.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCustomerAddressesStep - Medusa Workflows API Reference # updateCustomerAddressesStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateCustomerAddressesStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateCustomerAddressesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step updates one or more customer addresses. This step updates one or more customer addresses.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCustomersStep - Medusa Workflows API Reference # updateCustomersStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateCustomersStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateCustomersStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step updates one or more customers. This step updates one or more customers.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomerAccountWorkflow - Medusa Workflows API Reference # createCustomerAccountWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createCustomerAccountWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createCustomerAccountWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow creates an authentication account for a customer. This workflow creates an authentication account for a customer.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomerAddressesWorkflow - Medusa Workflows API Reference # createCustomerAddressesWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createCustomerAddressesWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createCustomerAddressesWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow creates one or more customer address. This workflow creates one or more customer address.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomersWorkflow - Medusa Workflows API Reference # createCustomersWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createCustomersWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createCustomersWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow creates one or more customers. This workflow creates one or more customers.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteCustomerAddressesWorkflow - Medusa Workflows API Reference # deleteCustomerAddressesWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `deleteCustomerAddressesWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `deleteCustomerAddressesWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow deletes one or more customer addresses. This workflow deletes one or more customer addresses.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteCustomersWorkflow - Medusa Workflows API Reference # deleteCustomersWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `deleteCustomersWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `deleteCustomersWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow deletes one or more customers. This workflow deletes one or more customers.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# removeCustomerAccountWorkflow - Medusa Workflows API Reference # removeCustomerAccountWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `removeCustomerAccountWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `removeCustomerAccountWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow deletes a user and remove the association in the auth identity. This workflow deletes a user and remove the association in the auth identity.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCustomerAddressesWorkflow - Medusa Workflows API Reference # updateCustomerAddressesWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateCustomerAddressesWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateCustomerAddressesWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow updates one or more customer addresses. This workflow updates one or more customer addresses.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCustomersWorkflow - Medusa Workflows API Reference # updateCustomersWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateCustomersWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateCustomersWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow updates one or more customers. This workflow updates one or more customers.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomerGroupsStep - Medusa Workflows API Reference # createCustomerGroupsStep - Medusa Workflows API Reference
This documentation provides a reference to the `createCustomerGroupsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createCustomerGroupsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step creates one or more customer groups. This step creates one or more customer groups.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteCustomerGroupStep - Medusa Workflows API Reference # deleteCustomerGroupStep - Medusa Workflows API Reference
This documentation provides a reference to the `deleteCustomerGroupStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `deleteCustomerGroupStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step deletes one or more customer groups. This step deletes one or more customer groups.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# linkCustomersToCustomerGroupStep - Medusa Workflows API Reference # linkCustomersToCustomerGroupStep - Medusa Workflows API Reference
This documentation provides a reference to the `linkCustomersToCustomerGroupStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `linkCustomersToCustomerGroupStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step creates one or more links between customer and customer group records. This step creates one or more links between customer and customer group records.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCustomerGroupsStep - Medusa Workflows API Reference # updateCustomerGroupsStep - Medusa Workflows API Reference
This documentation provides a reference to the `updateCustomerGroupsStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateCustomerGroupsStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step updates one or more customer groups. This step updates one or more customer groups.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createCustomerGroupsWorkflow - Medusa Workflows API Reference # createCustomerGroupsWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createCustomerGroupsWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createCustomerGroupsWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow creates one or more customer groups. This workflow creates one or more customer groups.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteCustomerGroupsWorkflow - Medusa Workflows API Reference # deleteCustomerGroupsWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `deleteCustomerGroupsWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `deleteCustomerGroupsWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow deletes one or more customer groups. This workflow deletes one or more customer groups.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# linkCustomersToCustomerGroupWorkflow - Medusa Workflows API Reference # linkCustomersToCustomerGroupWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `linkCustomersToCustomerGroupWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `linkCustomersToCustomerGroupWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow creates one or more links between customer and customer group records. This workflow creates one or more links between customer and customer group records.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# updateCustomerGroupsWorkflow - Medusa Workflows API Reference # updateCustomerGroupsWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `updateCustomerGroupsWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `updateCustomerGroupsWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow updates one or more customer groups. This workflow updates one or more customer groups.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createDefaultStoreStep - Medusa Workflows API Reference # createDefaultStoreStep - Medusa Workflows API Reference
This documentation provides a reference to the `createDefaultStoreStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createDefaultStoreStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step creates a default store. This step creates a default store.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# createDefaultsWorkflow - Medusa Workflows API Reference # createDefaultsWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `createDefaultsWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `createDefaultsWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow creates default data for a Medusa application. This workflow creates default data for a Medusa application.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteFilesStep - Medusa Workflows API Reference # deleteFilesStep - Medusa Workflows API Reference
This documentation provides a reference to the `deleteFilesStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `deleteFilesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step deletes one or more files. This step deletes one or more files.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# uploadFilesStep - Medusa Workflows API Reference # uploadFilesStep - Medusa Workflows API Reference
This documentation provides a reference to the `uploadFilesStep`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `uploadFilesStep`. It belongs to the `@medusajs/medusa/core-flows` package.
This step uploads one or more files. This step uploads one or more files.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# deleteFilesWorkflow - Medusa Workflows API Reference # deleteFilesWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `deleteFilesWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `deleteFilesWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow deletes one or more files. This workflow deletes one or more files.
@@ -7,7 +7,7 @@ import { TypeList, WorkflowDiagram } from "docs-ui"
# uploadFilesWorkflow - Medusa Workflows API Reference # uploadFilesWorkflow - Medusa Workflows API Reference
This documentation provides a reference to the `uploadFilesWorkflow`. It belongs to the `@medusajs/core-flows` package. This documentation provides a reference to the `uploadFilesWorkflow`. It belongs to the `@medusajs/medusa/core-flows` package.
This workflow uploads one or more files. This workflow uploads one or more files.
Loaded 100 of 585 files, more files were not shown because too many files have changed in this diff. Show more