Add campaign state filter (#20)

Author: gmethvin

api-docs.json

@@ -5231,6 +5231,17 @@
             "required": false,
             "type": "string",
             "x-example": "id"
+          },
+          {
+            "collectionFormat": "multi",
+            "description": "Filter campaigns by state. Can be specified multiple times to filter by multiple states. Valid states: Draft, Ready, Scheduled, Running, Finished, Starting, Aborted, Recurring, Archived. Example: ?campaignState=Ready&campaignState=Running",
+            "in": "query",
+            "items": {
+              "type": "string"
+            },
+            "name": "campaignState",
+            "required": false,
+            "type": "array"
           }
         ],
         "responses": {
@@ -5567,6 +5578,17 @@
             "required": false,
             "type": "string",
             "x-example": "id"
+          },
+          {
+            "collectionFormat": "multi",
+            "description": "Filter campaigns by state. Can be specified multiple times to filter by multiple states. Valid states: Draft, Ready, Scheduled, Running, Finished, Starting, Aborted, Recurring, Archived. Example: ?campaignState=Ready&campaignState=Running",
+            "in": "query",
+            "items": {
+              "type": "string"
+            },
+            "name": "campaignState",
+            "required": false,
+            "type": "array"
           }
         ],
         "responses": {

src/client/campaigns.ts

@@ -5,6 +5,7 @@ import {
   ArchiveCampaignsResponse,
   ArchiveCampaignsResponseSchema,
   CampaignMetricsResponse,
+  CampaignState,
   CancelCampaignParams,
   CreateBlastCampaignParams,
   CreateCampaignResponse,
@@ -58,6 +59,12 @@ export function Campaigns<T extends Constructor<BaseIterableClient>>(Base: T) {
         queryParams.append("sort", sortString);
       }
 
+      if (params?.campaignState) {
+        params.campaignState.forEach((state: CampaignState) =>
+          queryParams.append("campaignState", state)
+        );
+      }
+
       const url = `/api/campaigns?${queryParams.toString()}`;
       const response = await this.client.get(
         url,

src/types/campaigns.ts

@@ -12,21 +12,25 @@ import {
  * Campaign management schemas and types
  */
 
+export const CampaignStateSchema = z.enum([
+  "Draft",
+  "Ready",
+  "Scheduled",
+  "Running",
+  "Finished",
+  "Starting",
+  "Aborted",
+  "Recurring",
+  "Archived",
+]);
+
+export type CampaignState = z.infer<typeof CampaignStateSchema>;
+
 export const CampaignDetailsSchema = z.object({
   id: z.number(),
   name: z.string(),
   type: z.enum(["Blast", "Triggered"]),
-  campaignState: z.enum([
-    "Draft",
-    "Ready",
-    "Scheduled",
-    "Running",
-    "Finished",
-    "Starting",
-    "Aborted",
-    "Recurring",
-    "Archived",
-  ]),
+  campaignState: CampaignStateSchema,
   messageMedium: z.string(),
   createdAt: UnixTimestampSchema,
   updatedAt: UnixTimestampSchema,
@@ -74,6 +78,12 @@ export const GetCampaignsParamsSchema = z.object({
   sort: createSortParamSchema(CAMPAIGN_SORT_FIELDS).describe(
     "Field to sort campaigns by with optional direction (defaults to id ascending)"
   ),
+  campaignState: z
+    .array(CampaignStateSchema)
+    .optional()
+    .describe(
+      "Filter campaigns by state. Can specify multiple states. Valid states: Draft, Ready, Scheduled, Running, Finished, Starting, Aborted, Recurring, Archived"
+    ),
 });
 
 export type GetCampaignsParams = z.infer<typeof GetCampaignsParamsSchema>;