feat(medusa,utils): added campaign get endpoints (#6125)

what:

adds endpoints for the following:

- list endpoint (RESOLVES CORE-1682)
- retrieve endpoint (RESOLVES CORE-1683)

packages/medusa/src/api-v2/admin/campaigns/[id]/route.ts

@@ -0,0 +1,19 @@
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { IPromotionModuleService } from "@medusajs/types"
+import { MedusaRequest, MedusaResponse } from "../../../../types/routing"
+
+export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
+  const promotionModuleService: IPromotionModuleService = req.scope.resolve(
+    ModuleRegistrationName.PROMOTION
+  )
+
+  const campaign = await promotionModuleService.retrieveCampaign(
+    req.params.id,
+    {
+      select: req.retrieveConfig.select,
+      relations: req.retrieveConfig.relations,
+    }
+  )
+
+  res.status(200).json({ campaign })
+}

packages/medusa/src/api-v2/admin/campaigns/middlewares.ts

@@ -0,0 +1,35 @@
+import { MedusaV2Flag } from "@medusajs/utils"
+import { isFeatureFlagEnabled, transformQuery } from "../../../api/middlewares"
+import { MiddlewareRoute } from "../../../loaders/helpers/routing/types"
+import * as QueryConfig from "./query-config"
+import {
+  AdminGetCampaignsCampaignParams,
+  AdminGetCampaignsParams,
+} from "./validators"
+
+export const adminCampaignRoutesMiddlewares: MiddlewareRoute[] = [
+  {
+    matcher: "/admin/campaigns*",
+    middlewares: [isFeatureFlagEnabled(MedusaV2Flag.key)],
+  },
+  {
+    method: ["GET"],
+    matcher: "/admin/campaigns",
+    middlewares: [
+      transformQuery(
+        AdminGetCampaignsParams,
+        QueryConfig.listTransformQueryConfig
+      ),
+    ],
+  },
+  {
+    method: ["GET"],
+    matcher: "/admin/campaigns/:id",
+    middlewares: [
+      transformQuery(
+        AdminGetCampaignsCampaignParams,
+        QueryConfig.retrieveTransformQueryConfig
+      ),
+    ],
+  },
+]

packages/medusa/src/api-v2/admin/campaigns/query-config.ts

@@ -0,0 +1,28 @@
+export const defaultAdminCampaignRelations = ["budget"]
+export const allowedAdminCampaignRelations = [
+  ...defaultAdminCampaignRelations,
+  "promotions",
+]
+export const defaultAdminCampaignFields = [
+  "name",
+  "description",
+  "currency",
+  "campaign_identifier",
+  "starts_at",
+  "ends_at",
+  "created_at",
+  "updated_at",
+  "deleted_at",
+]
+
+export const retrieveTransformQueryConfig = {
+  defaultFields: defaultAdminCampaignFields,
+  defaultRelations: defaultAdminCampaignRelations,
+  allowedRelations: allowedAdminCampaignRelations,
+  isList: false,
+}
+
+export const listTransformQueryConfig = {
+  ...retrieveTransformQueryConfig,
+  isList: true,
+}

packages/medusa/src/api-v2/admin/campaigns/route.ts

@@ -0,0 +1,23 @@
+import { ModuleRegistrationName } from "@medusajs/modules-sdk"
+import { IPromotionModuleService } from "@medusajs/types"
+import { MedusaRequest, MedusaResponse } from "../../../types/routing"
+
+export const GET = async (req: MedusaRequest, res: MedusaResponse) => {
+  const promotionModuleService: IPromotionModuleService = req.scope.resolve(
+    ModuleRegistrationName.PROMOTION
+  )
+
+  const [campaigns, count] = await promotionModuleService.listAndCountCampaigns(
+    req.filterableFields,
+    req.listConfig
+  )
+
+  const { limit, offset } = req.validatedQuery
+
+  res.json({
+    count,
+    campaigns,
+    offset,
+    limit,
+  })
+}

packages/medusa/src/api-v2/admin/campaigns/validators.ts

@@ -0,0 +1,17 @@
+import { IsOptional, IsString } from "class-validator"
+import { FindParams, extendedFindParamsMixin } from "../../../types/common"
+
+export class AdminGetCampaignsCampaignParams extends FindParams {}
+
+export class AdminGetCampaignsParams extends extendedFindParamsMixin({
+  limit: 100,
+  offset: 0,
+}) {
+  @IsString()
+  @IsOptional()
+  campaign_identifier?: string
+
+  @IsString()
+  @IsOptional()
+  currency?: string
+}