diff --git a/packages/core/core-flows/src/product-category/steps/create-product-categories.ts b/packages/core/core-flows/src/product-category/steps/create-product-categories.ts index d8b178b22b..309e595353 100644 --- a/packages/core/core-flows/src/product-category/steps/create-product-categories.ts +++ b/packages/core/core-flows/src/product-category/steps/create-product-categories.ts @@ -5,11 +5,14 @@ import { import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type CreateProductCategoriesStepInput = { +export type CreateProductCategoriesStepInput = { product_categories: CreateProductCategoryDTO[] } export const createProductCategoriesStepId = "create-product-categories" +/** + * This step creates one or more product categories. + */ export const createProductCategoriesStep = createStep( createProductCategoriesStepId, async (data: CreateProductCategoriesStepInput, { container }) => { diff --git a/packages/core/core-flows/src/product-category/steps/delete-product-categories.ts b/packages/core/core-flows/src/product-category/steps/delete-product-categories.ts index 172c69ef5a..d0da9e86c3 100644 --- a/packages/core/core-flows/src/product-category/steps/delete-product-categories.ts +++ b/packages/core/core-flows/src/product-category/steps/delete-product-categories.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const deleteProductCategoriesStepId = "delete-product-categories" +/** + * This step deletes one or more product categories. + */ export const deleteProductCategoriesStep = createStep( deleteProductCategoriesStepId, async (ids: string[], { container }) => { diff --git a/packages/core/core-flows/src/product-category/steps/update-product-categories.ts b/packages/core/core-flows/src/product-category/steps/update-product-categories.ts index afdbca102f..ad41e5d74d 100644 --- a/packages/core/core-flows/src/product-category/steps/update-product-categories.ts +++ b/packages/core/core-flows/src/product-category/steps/update-product-categories.ts @@ -9,12 +9,15 @@ import { } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" -type UpdateProductCategoriesStepInput = { +export type UpdateProductCategoriesStepInput = { selector: FilterableProductCategoryProps update: UpdateProductCategoryDTO } export const updateProductCategoriesStepId = "update-product-categories" +/** + * This step updates product categories matching specified filters. + */ export const updateProductCategoriesStep = createStep( updateProductCategoriesStepId, async (data: UpdateProductCategoriesStepInput, { container }) => { diff --git a/packages/core/core-flows/src/product-category/workflows/create-product-categories.ts b/packages/core/core-flows/src/product-category/workflows/create-product-categories.ts index 2ce1896114..d8e0e4fb59 100644 --- a/packages/core/core-flows/src/product-category/workflows/create-product-categories.ts +++ b/packages/core/core-flows/src/product-category/workflows/create-product-categories.ts @@ -6,13 +6,13 @@ import { } from "@medusajs/workflows-sdk" import { createProductCategoriesStep } from "../steps" -type WorkflowInputData = - ProductCategoryWorkflow.CreateProductCategoriesWorkflowInput - export const createProductCategoriesWorkflowId = "create-product-categories" +/** + * This workflow creates one or more product categories. + */ export const createProductCategoriesWorkflow = createWorkflow( createProductCategoriesWorkflowId, - (input: WorkflowData) => { + (input: WorkflowData) => { return new WorkflowResponse(createProductCategoriesStep(input)) } ) diff --git a/packages/core/core-flows/src/product-category/workflows/delete-product-categories.ts b/packages/core/core-flows/src/product-category/workflows/delete-product-categories.ts index 3c65ab9d45..5106215cb2 100644 --- a/packages/core/core-flows/src/product-category/workflows/delete-product-categories.ts +++ b/packages/core/core-flows/src/product-category/workflows/delete-product-categories.ts @@ -2,6 +2,9 @@ import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk" import { deleteProductCategoriesStep } from "../steps" export const deleteProductCategoriesWorkflowId = "delete-product-categories" +/** + * This workflow deletes one or more product categories. + */ export const deleteProductCategoriesWorkflow = createWorkflow( deleteProductCategoriesWorkflowId, (input: WorkflowData) => { diff --git a/packages/core/core-flows/src/product-category/workflows/update-product-categories.ts b/packages/core/core-flows/src/product-category/workflows/update-product-categories.ts index 4c0f597d1c..dd8e62fa4c 100644 --- a/packages/core/core-flows/src/product-category/workflows/update-product-categories.ts +++ b/packages/core/core-flows/src/product-category/workflows/update-product-categories.ts @@ -6,13 +6,13 @@ import { } from "@medusajs/workflows-sdk" import { updateProductCategoriesStep } from "../steps" -type WorkflowInputData = - ProductCategoryWorkflow.UpdateProductCategoriesWorkflowInput - export const updateProductCategoriesWorkflowId = "update-product-categories" +/** + * This workflow updates product categories matching specified filters. + */ export const updateProductCategoriesWorkflow = createWorkflow( updateProductCategoriesWorkflowId, - (input: WorkflowData) => { + (input: WorkflowData) => { return new WorkflowResponse(updateProductCategoriesStep(input)) } ) diff --git a/packages/core/core-flows/src/promotion/steps/add-campaign-promotions.ts b/packages/core/core-flows/src/promotion/steps/add-campaign-promotions.ts index 3ce7e6ebee..08826a62fc 100644 --- a/packages/core/core-flows/src/promotion/steps/add-campaign-promotions.ts +++ b/packages/core/core-flows/src/promotion/steps/add-campaign-promotions.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, WorkflowData, createStep } from "@medusajs/workflows-sdk" export const addCampaignPromotionsStepId = "add-campaign-promotions" +/** + * This step adds promotions to a campaign. + */ export const addCampaignPromotionsStep = createStep( addCampaignPromotionsStepId, async (input: WorkflowData, { container }) => { diff --git a/packages/core/core-flows/src/promotion/steps/add-or-remove-campaign-promotions.ts b/packages/core/core-flows/src/promotion/steps/add-or-remove-campaign-promotions.ts index bbed397dc6..ac7261f103 100644 --- a/packages/core/core-flows/src/promotion/steps/add-or-remove-campaign-promotions.ts +++ b/packages/core/core-flows/src/promotion/steps/add-or-remove-campaign-promotions.ts @@ -4,6 +4,9 @@ import { StepResponse, WorkflowData, createStep } from "@medusajs/workflows-sdk" export const addOrRemoveCampaignPromotionsStepId = "add-or-remove-campaign-promotions" +/** + * This step adds or removes promotions from a campaign. + */ export const addOrRemoveCampaignPromotionsStep = createStep( addOrRemoveCampaignPromotionsStepId, async (input: WorkflowData, { container }) => { diff --git a/packages/core/core-flows/src/promotion/steps/add-rules-to-promotions.ts b/packages/core/core-flows/src/promotion/steps/add-rules-to-promotions.ts index b202110857..d0ba8412fd 100644 --- a/packages/core/core-flows/src/promotion/steps/add-rules-to-promotions.ts +++ b/packages/core/core-flows/src/promotion/steps/add-rules-to-promotions.ts @@ -6,6 +6,9 @@ import { ModuleRegistrationName, RuleType } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const addRulesToPromotionsStepId = "add-rules-to-promotions" +/** + * This step adds rules to a promotion. + */ export const addRulesToPromotionsStep = createStep( addRulesToPromotionsStepId, async (input: AddPromotionRulesWorkflowDTO, { container }) => { diff --git a/packages/core/core-flows/src/promotion/steps/create-campaigns.ts b/packages/core/core-flows/src/promotion/steps/create-campaigns.ts index 3b8a0a32cf..1811473a4f 100644 --- a/packages/core/core-flows/src/promotion/steps/create-campaigns.ts +++ b/packages/core/core-flows/src/promotion/steps/create-campaigns.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const createCampaignsStepId = "create-campaigns" +/** + * This step cancels one or more campaigns. + */ export const createCampaignsStep = createStep( createCampaignsStepId, async (data: CreateCampaignDTO[], { container }) => { diff --git a/packages/core/core-flows/src/promotion/steps/create-promotion-rules-workflow.ts b/packages/core/core-flows/src/promotion/steps/create-promotion-rules-workflow.ts index 6d79f4712d..602c991a5c 100644 --- a/packages/core/core-flows/src/promotion/steps/create-promotion-rules-workflow.ts +++ b/packages/core/core-flows/src/promotion/steps/create-promotion-rules-workflow.ts @@ -4,6 +4,9 @@ import { createPromotionRulesWorkflow } from "../workflows/create-promotion-rule export const createPromotionRulesWorkflowStepId = "create-promotion-rules-workflow" +/** + * This step creates promotion rules using the {@link createPromotionRulesWorkflow}. + */ export const createPromotionRulesWorkflowStep = createStep( createPromotionRulesWorkflowStepId, async (data: AddPromotionRulesWorkflowDTO, { container }) => { diff --git a/packages/core/core-flows/src/promotion/steps/create-promotions.ts b/packages/core/core-flows/src/promotion/steps/create-promotions.ts index aad05a3e01..135fede93d 100644 --- a/packages/core/core-flows/src/promotion/steps/create-promotions.ts +++ b/packages/core/core-flows/src/promotion/steps/create-promotions.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const createPromotionsStepId = "create-promotions" +/** + * This step creates one or more promotions. + */ export const createPromotionsStep = createStep( createPromotionsStepId, async (data: CreatePromotionDTO[], { container }) => { diff --git a/packages/core/core-flows/src/promotion/steps/delete-campaigns.ts b/packages/core/core-flows/src/promotion/steps/delete-campaigns.ts index 65b6849e0a..a1ce77b517 100644 --- a/packages/core/core-flows/src/promotion/steps/delete-campaigns.ts +++ b/packages/core/core-flows/src/promotion/steps/delete-campaigns.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const deleteCampaignsStepId = "delete-campaigns" +/** + * This step deletes one or more campaigns. + */ export const deleteCampaignsStep = createStep( deleteCampaignsStepId, async (ids: string[], { container }) => { diff --git a/packages/core/core-flows/src/promotion/steps/delete-promotion-rules-workflow.ts b/packages/core/core-flows/src/promotion/steps/delete-promotion-rules-workflow.ts index eec86cdf90..79e1aa9592 100644 --- a/packages/core/core-flows/src/promotion/steps/delete-promotion-rules-workflow.ts +++ b/packages/core/core-flows/src/promotion/steps/delete-promotion-rules-workflow.ts @@ -4,6 +4,9 @@ import { deletePromotionRulesWorkflow } from "../workflows/delete-promotion-rule export const deletePromotionRulesWorkflowStepId = "delete-promotion-rules-workflow" +/** + * This step deletes promotion rules using the {@link deletePromotionRulesWorkflow}. + */ export const deletePromotionRulesWorkflowStep = createStep( deletePromotionRulesWorkflowStepId, async (data: RemovePromotionRulesWorkflowDTO, { container }) => { diff --git a/packages/core/core-flows/src/promotion/steps/delete-promotions.ts b/packages/core/core-flows/src/promotion/steps/delete-promotions.ts index f907049440..c5e241537d 100644 --- a/packages/core/core-flows/src/promotion/steps/delete-promotions.ts +++ b/packages/core/core-flows/src/promotion/steps/delete-promotions.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const deletePromotionsStepId = "delete-promotions" +/** + * This step deletes one or more promotions. + */ export const deletePromotionsStep = createStep( deletePromotionsStepId, async (ids: string[], { container }) => { diff --git a/packages/core/core-flows/src/promotion/steps/remove-campaign-promotions.ts b/packages/core/core-flows/src/promotion/steps/remove-campaign-promotions.ts index 56c365e742..f088ec36b6 100644 --- a/packages/core/core-flows/src/promotion/steps/remove-campaign-promotions.ts +++ b/packages/core/core-flows/src/promotion/steps/remove-campaign-promotions.ts @@ -3,6 +3,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, WorkflowData, createStep } from "@medusajs/workflows-sdk" export const removeCampaignPromotionsStepId = "remove-campaign-promotions" +/** + * This step removes promotions from a campaigns. + */ export const removeCampaignPromotionsStep = createStep( removeCampaignPromotionsStepId, async (input: WorkflowData, { container }) => { diff --git a/packages/core/core-flows/src/promotion/steps/remove-rules-from-promotions.ts b/packages/core/core-flows/src/promotion/steps/remove-rules-from-promotions.ts index 01e9c03cc5..79207e9c2b 100644 --- a/packages/core/core-flows/src/promotion/steps/remove-rules-from-promotions.ts +++ b/packages/core/core-flows/src/promotion/steps/remove-rules-from-promotions.ts @@ -8,6 +8,9 @@ import { ModuleRegistrationName, RuleType } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const removeRulesFromPromotionsStepId = "remove-rules-from-promotions" +/** + * This step removes rules from a promotion. + */ export const removeRulesFromPromotionsStep = createStep( removeRulesFromPromotionsStepId, async (input: RemovePromotionRulesWorkflowDTO, { container }) => { diff --git a/packages/core/core-flows/src/promotion/steps/update-campaigns.ts b/packages/core/core-flows/src/promotion/steps/update-campaigns.ts index f93082934c..cb14be3d26 100644 --- a/packages/core/core-flows/src/promotion/steps/update-campaigns.ts +++ b/packages/core/core-flows/src/promotion/steps/update-campaigns.ts @@ -7,6 +7,9 @@ import { import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const updateCampaignsStepId = "update-campaigns" +/** + * This step updates one or more campaigns. + */ export const updateCampaignsStep = createStep( updateCampaignsStepId, async (data: UpdateCampaignDTO[], { container }) => { diff --git a/packages/core/core-flows/src/promotion/steps/update-promotion-rules-workflow.ts b/packages/core/core-flows/src/promotion/steps/update-promotion-rules-workflow.ts index d4560eae46..cdf0c51750 100644 --- a/packages/core/core-flows/src/promotion/steps/update-promotion-rules-workflow.ts +++ b/packages/core/core-flows/src/promotion/steps/update-promotion-rules-workflow.ts @@ -4,6 +4,9 @@ import { updatePromotionRulesWorkflow } from "../workflows/update-promotion-rule export const updatePromotionRulesWorkflowStepId = "update-promotion-rules-workflow" +/** + * This step updates promotion rules using the {@link updatePromotionRulesWorkflow}. + */ export const updatePromotionRulesWorkflowStep = createStep( updatePromotionRulesWorkflowStepId, async (data: UpdatePromotionRulesWorkflowDTO, { container }) => { diff --git a/packages/core/core-flows/src/promotion/steps/update-promotion-rules.ts b/packages/core/core-flows/src/promotion/steps/update-promotion-rules.ts index 9a851fddf9..1544922047 100644 --- a/packages/core/core-flows/src/promotion/steps/update-promotion-rules.ts +++ b/packages/core/core-flows/src/promotion/steps/update-promotion-rules.ts @@ -6,6 +6,9 @@ import { ModuleRegistrationName } from "@medusajs/utils" import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const updatePromotionRulesStepId = "update-promotion-rules" +/** + * This step updates one or more promotion rules. + */ export const updatePromotionRulesStep = createStep( updatePromotionRulesStepId, async (input: UpdatePromotionRulesWorkflowDTO, { container }) => { diff --git a/packages/core/core-flows/src/promotion/steps/update-promotions.ts b/packages/core/core-flows/src/promotion/steps/update-promotions.ts index c90d646580..5a899b3999 100644 --- a/packages/core/core-flows/src/promotion/steps/update-promotions.ts +++ b/packages/core/core-flows/src/promotion/steps/update-promotions.ts @@ -7,6 +7,9 @@ import { import { StepResponse, createStep } from "@medusajs/workflows-sdk" export const updatePromotionsStepId = "update-promotions" +/** + * This step updates one or more promotions. + */ export const updatePromotionsStep = createStep( updatePromotionsStepId, async (data: UpdatePromotionDTO[], { container }) => { diff --git a/packages/core/core-flows/src/promotion/workflows/add-or-remove-campaign-promotions.ts b/packages/core/core-flows/src/promotion/workflows/add-or-remove-campaign-promotions.ts index 154fe48d98..82faebaaa6 100644 --- a/packages/core/core-flows/src/promotion/workflows/add-or-remove-campaign-promotions.ts +++ b/packages/core/core-flows/src/promotion/workflows/add-or-remove-campaign-promotions.ts @@ -11,6 +11,9 @@ import { export const addOrRemoveCampaignPromotionsWorkflowId = "add-or-remove-campaign-promotions" +/** + * This workflow adds or removes promotions from campaigns. + */ export const addOrRemoveCampaignPromotionsWorkflow = createWorkflow( addOrRemoveCampaignPromotionsWorkflowId, (input: WorkflowData): WorkflowData => { diff --git a/packages/core/core-flows/src/promotion/workflows/batch-promotion-rules.ts b/packages/core/core-flows/src/promotion/workflows/batch-promotion-rules.ts index 64124a6ec6..307e6b3df7 100644 --- a/packages/core/core-flows/src/promotion/workflows/batch-promotion-rules.ts +++ b/packages/core/core-flows/src/promotion/workflows/batch-promotion-rules.ts @@ -18,6 +18,9 @@ import { updatePromotionRulesWorkflowStep } from "../steps/update-promotion-rule import { deletePromotionRulesWorkflowStep } from "../steps/delete-promotion-rules-workflow" export const batchPromotionRulesWorkflowId = "batch-promotion-rules" +/** + * This workflow creates, updates, or deletes promotion rules. + */ export const batchPromotionRulesWorkflow = createWorkflow( batchPromotionRulesWorkflowId, ( diff --git a/packages/core/core-flows/src/promotion/workflows/create-campaigns.ts b/packages/core/core-flows/src/promotion/workflows/create-campaigns.ts index 38096f2a96..40c20d27f4 100644 --- a/packages/core/core-flows/src/promotion/workflows/create-campaigns.ts +++ b/packages/core/core-flows/src/promotion/workflows/create-campaigns.ts @@ -7,12 +7,15 @@ import { } from "@medusajs/workflows-sdk" import { createCampaignsStep } from "../steps" -type WorkflowInput = { campaignsData: CreateCampaignDTO[] } & AdditionalData +export type CreateCampaignsWorkflowInput = { campaignsData: CreateCampaignDTO[] } & AdditionalData export const createCampaignsWorkflowId = "create-campaigns" +/** + * This workflow creates one or more campaigns. + */ export const createCampaignsWorkflow = createWorkflow( createCampaignsWorkflowId, - (input: WorkflowData) => { + (input: WorkflowData) => { const createdCampaigns = createCampaignsStep(input.campaignsData) const campaignsCreated = createHook("campaignsCreated", { campaigns: createdCampaigns, diff --git a/packages/core/core-flows/src/promotion/workflows/create-promotion-rules.ts b/packages/core/core-flows/src/promotion/workflows/create-promotion-rules.ts index fc2bbd7545..d6249deba2 100644 --- a/packages/core/core-flows/src/promotion/workflows/create-promotion-rules.ts +++ b/packages/core/core-flows/src/promotion/workflows/create-promotion-rules.ts @@ -7,6 +7,9 @@ import { import { addRulesToPromotionsStep } from "../steps" export const createPromotionRulesWorkflowId = "create-promotion-rules-workflow" +/** + * This workflow creates one or more promotion rules. + */ export const createPromotionRulesWorkflow = createWorkflow( createPromotionRulesWorkflowId, ( diff --git a/packages/core/core-flows/src/promotion/workflows/create-promotions.ts b/packages/core/core-flows/src/promotion/workflows/create-promotions.ts index 0ce51df955..085e404e12 100644 --- a/packages/core/core-flows/src/promotion/workflows/create-promotions.ts +++ b/packages/core/core-flows/src/promotion/workflows/create-promotions.ts @@ -7,12 +7,15 @@ import { } from "@medusajs/workflows-sdk" import { createPromotionsStep } from "../steps" -type WorkflowInput = { promotionsData: CreatePromotionDTO[] } & AdditionalData +export type CreatePromotionsWorkflowInput = { promotionsData: CreatePromotionDTO[] } & AdditionalData export const createPromotionsWorkflowId = "create-promotions" +/** + * This workflow creates one or more promotions. + */ export const createPromotionsWorkflow = createWorkflow( createPromotionsWorkflowId, - (input: WorkflowData) => { + (input: WorkflowData) => { const createdPromotions = createPromotionsStep(input.promotionsData) const promotionsCreated = createHook("promotionsCreated", { promotions: createdPromotions, diff --git a/packages/core/core-flows/src/promotion/workflows/delete-campaigns.ts b/packages/core/core-flows/src/promotion/workflows/delete-campaigns.ts index 2d4707d677..9213ee0b65 100644 --- a/packages/core/core-flows/src/promotion/workflows/delete-campaigns.ts +++ b/packages/core/core-flows/src/promotion/workflows/delete-campaigns.ts @@ -1,12 +1,15 @@ import { createHook, createWorkflow, WorkflowData, WorkflowResponse } from "@medusajs/workflows-sdk" import { deleteCampaignsStep } from "../steps" -type WorkflowInput = { ids: string[] } +export type DeleteCampaignsWorkflowInput = { ids: string[] } export const deleteCampaignsWorkflowId = "delete-campaigns" +/** + * This workflow deletes one or more campaigns. + */ export const deleteCampaignsWorkflow = createWorkflow( deleteCampaignsWorkflowId, - (input: WorkflowData) => { + (input: WorkflowData) => { const deletedCampaigns = deleteCampaignsStep(input.ids) const campaignsDeleted = createHook("campaignsDeleted", { ids: input.ids diff --git a/packages/core/core-flows/src/promotion/workflows/delete-promotion-rules.ts b/packages/core/core-flows/src/promotion/workflows/delete-promotion-rules.ts index 8023443db8..ad24536b0f 100644 --- a/packages/core/core-flows/src/promotion/workflows/delete-promotion-rules.ts +++ b/packages/core/core-flows/src/promotion/workflows/delete-promotion-rules.ts @@ -3,6 +3,9 @@ import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk" import { removeRulesFromPromotionsStep } from "../steps" export const deletePromotionRulesWorkflowId = "delete-promotion-rules-workflow" +/** + * This workflow deletes one or more promotion rules. + */ export const deletePromotionRulesWorkflow = createWorkflow( deletePromotionRulesWorkflowId, ( diff --git a/packages/core/core-flows/src/promotion/workflows/delete-promotions.ts b/packages/core/core-flows/src/promotion/workflows/delete-promotions.ts index 8a741d1acc..8f315f3a12 100644 --- a/packages/core/core-flows/src/promotion/workflows/delete-promotions.ts +++ b/packages/core/core-flows/src/promotion/workflows/delete-promotions.ts @@ -1,12 +1,15 @@ import { createHook, createWorkflow, WorkflowData, WorkflowResponse } from "@medusajs/workflows-sdk" import { deletePromotionsStep } from "../steps" -type WorkflowInput = { ids: string[] } +export type DeletePromotionsWorkflowInput = { ids: string[] } export const deletePromotionsWorkflowId = "delete-promotions" +/** + * This workflow deletes one or more promotions. + */ export const deletePromotionsWorkflow = createWorkflow( deletePromotionsWorkflowId, - (input: WorkflowData) => { + (input: WorkflowData) => { const deletedPromotions = deletePromotionsStep(input.ids) const promotionsDeleted = createHook("promotionsDeleted", { ids: input.ids diff --git a/packages/core/core-flows/src/promotion/workflows/update-campaigns.ts b/packages/core/core-flows/src/promotion/workflows/update-campaigns.ts index af23b93acb..4a9968462b 100644 --- a/packages/core/core-flows/src/promotion/workflows/update-campaigns.ts +++ b/packages/core/core-flows/src/promotion/workflows/update-campaigns.ts @@ -7,12 +7,15 @@ import { } from "@medusajs/workflows-sdk" import { updateCampaignsStep } from "../steps" -type WorkflowInput = { campaignsData: UpdateCampaignDTO[] } & AdditionalData +export type UpdateCampaignsWorkflowInput = { campaignsData: UpdateCampaignDTO[] } & AdditionalData export const updateCampaignsWorkflowId = "update-campaigns" +/** + * This workflow updates one or more campaigns. + */ export const updateCampaignsWorkflow = createWorkflow( updateCampaignsWorkflowId, - (input: WorkflowData) => { + (input: WorkflowData) => { const updatedCampaigns = updateCampaignsStep(input.campaignsData) const campaignsUpdated = createHook("campaignsUpdated", { campaigns: updatedCampaigns, diff --git a/packages/core/core-flows/src/promotion/workflows/update-promotion-rules.ts b/packages/core/core-flows/src/promotion/workflows/update-promotion-rules.ts index 3aab77cfd9..82073a2b28 100644 --- a/packages/core/core-flows/src/promotion/workflows/update-promotion-rules.ts +++ b/packages/core/core-flows/src/promotion/workflows/update-promotion-rules.ts @@ -10,6 +10,9 @@ import { import { updatePromotionRulesStep } from "../steps" export const updatePromotionRulesWorkflowId = "update-promotion-rules-workflow" +/** + * This workflow updates one or more promotion rules. + */ export const updatePromotionRulesWorkflow = createWorkflow( updatePromotionRulesWorkflowId, ( diff --git a/packages/core/core-flows/src/promotion/workflows/update-promotions.ts b/packages/core/core-flows/src/promotion/workflows/update-promotions.ts index 43ff820818..c4d4747285 100644 --- a/packages/core/core-flows/src/promotion/workflows/update-promotions.ts +++ b/packages/core/core-flows/src/promotion/workflows/update-promotions.ts @@ -10,12 +10,15 @@ import { } from "@medusajs/workflows-sdk" import { updatePromotionsStep } from "../steps" -type WorkflowInput = { promotionsData: UpdatePromotionDTO[] } & AdditionalData +export type UpdatePromotionsWorkflowInput = { promotionsData: UpdatePromotionDTO[] } & AdditionalData export const updatePromotionsWorkflowId = "update-promotions" +/** + * This workflow updates one or more promotions. + */ export const updatePromotionsWorkflow = createWorkflow( updatePromotionsWorkflowId, - (input: WorkflowData) => { + (input: WorkflowData) => { const updatedPromotions = updatePromotionsStep(input.promotionsData) const promotionsUpdated = createHook("promotionsUpdated", { promotions: updatedPromotions,