@iterable/api 0.0.1

package/dist/types/campaigns.d.ts

@@ -0,0 +1,307 @@
+import { z } from "zod";
+import { SortParam } from "./common.js";
+/**
+ * Campaign management schemas and types
+ */
+export declare const CampaignDetailsSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    name: z.ZodString;
+    type: z.ZodEnum<{
+        Blast: "Blast";
+        Triggered: "Triggered";
+    }>;
+    campaignState: z.ZodEnum<{
+        Draft: "Draft";
+        Ready: "Ready";
+        Scheduled: "Scheduled";
+        Running: "Running";
+        Finished: "Finished";
+        Starting: "Starting";
+        Aborted: "Aborted";
+        Recurring: "Recurring";
+        Archived: "Archived";
+    }>;
+    messageMedium: z.ZodString;
+    createdAt: z.ZodNumber;
+    updatedAt: z.ZodNumber;
+    createdByUserId: z.ZodString;
+    templateId: z.ZodOptional<z.ZodNumber>;
+    updatedByUserId: z.ZodOptional<z.ZodString>;
+    startAt: z.ZodOptional<z.ZodNumber>;
+    endedAt: z.ZodOptional<z.ZodNumber>;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    listIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    suppressionListIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    recurringCampaignId: z.ZodOptional<z.ZodNumber>;
+    sendSize: z.ZodOptional<z.ZodNumber>;
+    workflowId: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type CampaignDetails = z.infer<typeof CampaignDetailsSchema>;
+declare const CAMPAIGN_SORT_FIELDS: readonly ["id", "name", "createdAt", "updatedAt", "startAt"];
+export declare const GetCampaignsParamsSchema: z.ZodObject<{
+    page: z.ZodOptional<z.ZodNumber>;
+    pageSize: z.ZodOptional<z.ZodNumber>;
+    sort: z.ZodOptional<z.ZodObject<{
+        field: z.ZodEnum<{
+            createdAt: "createdAt";
+            updatedAt: "updatedAt";
+            id: "id";
+            name: "name";
+            startAt: "startAt";
+        }>;
+        direction: z.ZodOptional<z.ZodEnum<{
+            asc: "asc";
+            desc: "desc";
+        }>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type GetCampaignsParams = z.infer<typeof GetCampaignsParamsSchema>;
+export type CampaignSortParam = SortParam<(typeof CAMPAIGN_SORT_FIELDS)[number]>;
+export declare const GetCampaignsResponseSchema: z.ZodObject<{
+    campaigns: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        name: z.ZodString;
+        type: z.ZodEnum<{
+            Blast: "Blast";
+            Triggered: "Triggered";
+        }>;
+        campaignState: z.ZodEnum<{
+            Draft: "Draft";
+            Ready: "Ready";
+            Scheduled: "Scheduled";
+            Running: "Running";
+            Finished: "Finished";
+            Starting: "Starting";
+            Aborted: "Aborted";
+            Recurring: "Recurring";
+            Archived: "Archived";
+        }>;
+        messageMedium: z.ZodString;
+        createdAt: z.ZodNumber;
+        updatedAt: z.ZodNumber;
+        createdByUserId: z.ZodString;
+        templateId: z.ZodOptional<z.ZodNumber>;
+        updatedByUserId: z.ZodOptional<z.ZodString>;
+        startAt: z.ZodOptional<z.ZodNumber>;
+        endedAt: z.ZodOptional<z.ZodNumber>;
+        labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        listIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+        suppressionListIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+        recurringCampaignId: z.ZodOptional<z.ZodNumber>;
+        sendSize: z.ZodOptional<z.ZodNumber>;
+        workflowId: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    nextPageUrl: z.ZodOptional<z.ZodString>;
+    previousPageUrl: z.ZodOptional<z.ZodString>;
+    totalCampaignsCount: z.ZodNumber;
+}, z.core.$strip>;
+export type GetCampaignsResponse = z.infer<typeof GetCampaignsResponseSchema>;
+export declare const GetCampaignParamsSchema: z.ZodObject<{
+    id: z.ZodNumber;
+}, z.core.$strip>;
+export declare const GetCampaignResponseSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    name: z.ZodString;
+    type: z.ZodEnum<{
+        Blast: "Blast";
+        Triggered: "Triggered";
+    }>;
+    campaignState: z.ZodEnum<{
+        Draft: "Draft";
+        Ready: "Ready";
+        Scheduled: "Scheduled";
+        Running: "Running";
+        Finished: "Finished";
+        Starting: "Starting";
+        Aborted: "Aborted";
+        Recurring: "Recurring";
+        Archived: "Archived";
+    }>;
+    messageMedium: z.ZodString;
+    createdAt: z.ZodNumber;
+    updatedAt: z.ZodNumber;
+    createdByUserId: z.ZodString;
+    templateId: z.ZodOptional<z.ZodNumber>;
+    updatedByUserId: z.ZodOptional<z.ZodString>;
+    startAt: z.ZodOptional<z.ZodNumber>;
+    endedAt: z.ZodOptional<z.ZodNumber>;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    listIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    suppressionListIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    recurringCampaignId: z.ZodOptional<z.ZodNumber>;
+    sendSize: z.ZodOptional<z.ZodNumber>;
+    workflowId: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type GetCampaignParams = z.infer<typeof GetCampaignParamsSchema>;
+export type GetCampaignResponse = z.infer<typeof GetCampaignResponseSchema>;
+export type GetCampaignMetricsParams = z.infer<typeof GetCampaignMetricsParamsSchema>;
+export type CreateCampaignParams = z.infer<typeof CreateCampaignParamsSchema>;
+export type CreateCampaignResponse = z.infer<typeof CreateCampaignResponseSchema>;
+export type GetChildCampaignsParams = z.infer<typeof GetChildCampaignsParamsSchema>;
+export declare const GetCampaignMetricsParamsSchema: z.ZodObject<{
+    campaignId: z.ZodNumber;
+    startDateTime: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodDate, z.ZodString]>, z.ZodTransform<string, string | Date>>>;
+    endDateTime: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodDate, z.ZodString]>, z.ZodTransform<string, string | Date>>>;
+}, z.core.$strip>;
+export declare const CampaignsResponseSchema: z.ZodObject<{
+    campaigns: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        name: z.ZodString;
+        type: z.ZodEnum<{
+            Blast: "Blast";
+            Triggered: "Triggered";
+        }>;
+        campaignState: z.ZodEnum<{
+            Draft: "Draft";
+            Ready: "Ready";
+            Scheduled: "Scheduled";
+            Running: "Running";
+            Finished: "Finished";
+            Starting: "Starting";
+            Aborted: "Aborted";
+            Recurring: "Recurring";
+            Archived: "Archived";
+        }>;
+        messageMedium: z.ZodString;
+        createdAt: z.ZodNumber;
+        updatedAt: z.ZodNumber;
+        createdByUserId: z.ZodString;
+        templateId: z.ZodOptional<z.ZodNumber>;
+        updatedByUserId: z.ZodOptional<z.ZodString>;
+        startAt: z.ZodOptional<z.ZodNumber>;
+        endedAt: z.ZodOptional<z.ZodNumber>;
+        labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        listIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+        suppressionListIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+        recurringCampaignId: z.ZodOptional<z.ZodNumber>;
+        sendSize: z.ZodOptional<z.ZodNumber>;
+        workflowId: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const CampaignMetricsResponseSchema: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>>;
+export declare const CreateCampaignParamsSchema: z.ZodObject<{
+    name: z.ZodString;
+    templateId: z.ZodNumber;
+    listIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    campaignDataFields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    sendAt: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodDate, z.ZodString]>, z.ZodTransform<string, string | Date>>>;
+    sendMode: z.ZodOptional<z.ZodEnum<{
+        ProjectTimeZone: "ProjectTimeZone";
+        RecipientTimeZone: "RecipientTimeZone";
+    }>>;
+    startTimeZone: z.ZodOptional<z.ZodString>;
+    defaultTimeZone: z.ZodOptional<z.ZodString>;
+    suppressionListIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+}, z.core.$strip>;
+export declare const CreateCampaignResponseSchema: z.ZodObject<{
+    campaignId: z.ZodNumber;
+}, z.core.$strip>;
+export declare const GetChildCampaignsParamsSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    page: z.ZodOptional<z.ZodNumber>;
+    pageSize: z.ZodOptional<z.ZodNumber>;
+    sort: z.ZodOptional<z.ZodObject<{
+        field: z.ZodEnum<{
+            createdAt: "createdAt";
+            updatedAt: "updatedAt";
+            id: "id";
+            name: "name";
+            startAt: "startAt";
+        }>;
+        direction: z.ZodOptional<z.ZodEnum<{
+            asc: "asc";
+            desc: "desc";
+        }>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const GetChildCampaignsResponseSchema: z.ZodObject<{
+    campaigns: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        name: z.ZodString;
+        type: z.ZodEnum<{
+            Blast: "Blast";
+            Triggered: "Triggered";
+        }>;
+        campaignState: z.ZodEnum<{
+            Draft: "Draft";
+            Ready: "Ready";
+            Scheduled: "Scheduled";
+            Running: "Running";
+            Finished: "Finished";
+            Starting: "Starting";
+            Aborted: "Aborted";
+            Recurring: "Recurring";
+            Archived: "Archived";
+        }>;
+        messageMedium: z.ZodString;
+        createdAt: z.ZodNumber;
+        updatedAt: z.ZodNumber;
+        createdByUserId: z.ZodString;
+        templateId: z.ZodOptional<z.ZodNumber>;
+        updatedByUserId: z.ZodOptional<z.ZodString>;
+        startAt: z.ZodOptional<z.ZodNumber>;
+        endedAt: z.ZodOptional<z.ZodNumber>;
+        labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        listIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+        suppressionListIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+        recurringCampaignId: z.ZodOptional<z.ZodNumber>;
+        sendSize: z.ZodOptional<z.ZodNumber>;
+        workflowId: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    nextPageUrl: z.ZodOptional<z.ZodString>;
+    previousPageUrl: z.ZodOptional<z.ZodString>;
+    totalCampaignsCount: z.ZodNumber;
+}, z.core.$strip>;
+export type GetChildCampaignsResponse = z.infer<typeof GetChildCampaignsResponseSchema>;
+export declare const RecipientTimeZoneSchema: z.ZodObject<{
+    defaultTimeZone: z.ZodString;
+    startTimeZone: z.ZodString;
+}, z.core.$strip>;
+export declare const ScheduleCampaignParamsSchema: z.ZodObject<{
+    campaignId: z.ZodNumber;
+    sendAt: z.ZodPipe<z.ZodUnion<readonly [z.ZodDate, z.ZodString]>, z.ZodTransform<string, string | Date>>;
+    recipientTimeZone: z.ZodOptional<z.ZodObject<{
+        defaultTimeZone: z.ZodString;
+        startTimeZone: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ScheduleCampaignParams = z.infer<typeof ScheduleCampaignParamsSchema>;
+export declare const AbortCampaignParamsSchema: z.ZodObject<{
+    campaignId: z.ZodNumber;
+}, z.core.$strip>;
+export type AbortCampaignParams = z.infer<typeof AbortCampaignParamsSchema>;
+export declare const CancelCampaignParamsSchema: z.ZodObject<{
+    campaignId: z.ZodNumber;
+}, z.core.$strip>;
+export type CancelCampaignParams = z.infer<typeof CancelCampaignParamsSchema>;
+export declare const ActivateTriggeredCampaignParamsSchema: z.ZodObject<{
+    campaignId: z.ZodNumber;
+}, z.core.$strip>;
+export type ActivateTriggeredCampaignParams = z.infer<typeof ActivateTriggeredCampaignParamsSchema>;
+export declare const DeactivateTriggeredCampaignParamsSchema: z.ZodObject<{
+    campaignId: z.ZodNumber;
+}, z.core.$strip>;
+export type DeactivateTriggeredCampaignParams = z.infer<typeof DeactivateTriggeredCampaignParamsSchema>;
+export declare const ArchiveCampaignsParamsSchema: z.ZodObject<{
+    campaignIds: z.ZodArray<z.ZodNumber>;
+}, z.core.$strip>;
+export type ArchiveCampaignsParams = z.infer<typeof ArchiveCampaignsParamsSchema>;
+export declare const ArchiveCampaignsResponseSchema: z.ZodObject<{
+    success: z.ZodArray<z.ZodNumber>;
+    failed: z.ZodArray<z.ZodAny>;
+}, z.core.$strip>;
+export type ArchiveCampaignsResponse = z.infer<typeof ArchiveCampaignsResponseSchema>;
+export declare const TriggerCampaignParamsSchema: z.ZodObject<{
+    campaignId: z.ZodNumber;
+    listIds: z.ZodArray<z.ZodNumber>;
+    dataFields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    suppressionListIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    allowRepeatMarketingSends: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type TriggerCampaignParams = z.infer<typeof TriggerCampaignParamsSchema>;
+export declare const SendCampaignParamsSchema: z.ZodObject<{
+    campaignId: z.ZodNumber;
+}, z.core.$strip>;
+export type SendCampaignParams = z.infer<typeof SendCampaignParamsSchema>;
+export {};
+//# sourceMappingURL=campaigns.d.ts.map

package/dist/types/campaigns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaigns.d.ts","sourceRoot":"","sources":["../../src/types/campaigns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAIL,SAAS,EAEV,MAAM,aAAa,CAAC;AAErB;;GAEG;AAEH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6BhC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAGpE,QAAA,MAAM,oBAAoB,8DAMhB,CAAC;AAGX,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;iBAmBnC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAC1E,MAAM,MAAM,iBAAiB,GAAG,SAAS,CACvC,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CACtC,CAAC;AAGF,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAerC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAG9E,eAAO,MAAM,uBAAuB;;iBAElC,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAwB,CAAC;AAE/D,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AACxE,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAC5C,OAAO,8BAA8B,CACtC,CAAC;AACF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAC1C,OAAO,4BAA4B,CACpC,CAAC;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,6BAA6B,CACrC,CAAC;AAEF,eAAO,MAAM,8BAA8B;;;;iBAQzC,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAElC,CAAC;AAEH,eAAO,MAAM,6BAA6B,gDAEC,CAAC;AAG5C,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;iBAsCrC,CAAC;AAEH,eAAO,MAAM,4BAA4B;;iBAEvC,CAAC;AAGH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;iBAoBxC,CAAC;AAEH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAe1C,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,+BAA+B,CACvC,CAAC;AAGF,eAAO,MAAM,uBAAuB;;;iBAOlC,CAAC;AAEH,eAAO,MAAM,4BAA4B;;;;;;;iBAQvC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAC1C,OAAO,4BAA4B,CACpC,CAAC;AAGF,eAAO,MAAM,yBAAyB;;iBAEpC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAG5E,eAAO,MAAM,0BAA0B;;iBAErC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAG9E,eAAO,MAAM,qCAAqC;;iBAEhD,CAAC;AAEH,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,qCAAqC,CAC7C,CAAC;AAGF,eAAO,MAAM,uCAAuC;;iBAElD,CAAC;AAEH,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,uCAAuC,CAC/C,CAAC;AAGF,eAAO,MAAM,4BAA4B;;iBAEvC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAC1C,OAAO,4BAA4B,CACpC,CAAC;AAGF,eAAO,MAAM,8BAA8B;;;iBAOzC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAC5C,OAAO,8BAA8B,CACtC,CAAC;AAGF,eAAO,MAAM,2BAA2B;;;;;;iBAkBtC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAGhF,eAAO,MAAM,wBAAwB;;iBAEnC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC"}

package/dist/types/campaigns.js

@@ -0,0 +1,226 @@
+import { z } from "zod";
+import { createSortParamSchema, IterableDateTimeSchema, IterableISODateTimeSchema, UnixTimestampSchema, } from "./common.js";
+/**
+ * Campaign management schemas and types
+ */
+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",
+    ]),
+    messageMedium: z.string(),
+    createdAt: UnixTimestampSchema,
+    updatedAt: UnixTimestampSchema,
+    createdByUserId: z.string(),
+    templateId: z.number().optional(),
+    updatedByUserId: z.string().optional(),
+    startAt: UnixTimestampSchema.optional(),
+    endedAt: UnixTimestampSchema.optional(),
+    labels: z.array(z.string()).optional(),
+    listIds: z.array(z.number()).optional(),
+    suppressionListIds: z.array(z.number()).optional(),
+    recurringCampaignId: z.number().optional(),
+    sendSize: z.number().optional(),
+    workflowId: z.number().optional(),
+});
+// Campaign sort fields
+const CAMPAIGN_SORT_FIELDS = [
+    "id",
+    "name",
+    "createdAt",
+    "updatedAt",
+    "startAt",
+];
+// Get campaigns parameters schema
+export const GetCampaignsParamsSchema = z.object({
+    page: z
+        .number()
+        .int()
+        .min(1)
+        .optional()
+        .describe("Page number (starting at 1)"),
+    pageSize: z
+        .number()
+        .int()
+        .min(1)
+        .max(1000)
+        .optional()
+        .describe("Number of results to return per page (defaults to 20, maximum of 1000)"),
+    sort: createSortParamSchema(CAMPAIGN_SORT_FIELDS).describe("Field to sort campaigns by with optional direction (defaults to id ascending)"),
+});
+// Response schemas
+export const GetCampaignsResponseSchema = z.object({
+    campaigns: z.array(CampaignDetailsSchema),
+    nextPageUrl: z
+        .string()
+        .optional()
+        .describe("The URL to the next page of campaigns, if applicable"),
+    previousPageUrl: z
+        .string()
+        .optional()
+        .describe("The URL to the previous page of campaigns, if applicable"),
+    totalCampaignsCount: z
+        .number()
+        .describe("The total count of campaigns across all pages for the supplied query"),
+});
+// Get single campaign endpoint
+export const GetCampaignParamsSchema = z.object({
+    id: z.number().describe("Campaign ID to retrieve"),
+});
+export const GetCampaignResponseSchema = CampaignDetailsSchema;
+export const GetCampaignMetricsParamsSchema = z.object({
+    campaignId: z.number().describe("Campaign ID to get metrics for"),
+    startDateTime: IterableDateTimeSchema.optional().describe("Start date for metrics (YYYY-MM-DD HH:MM:SS format)"),
+    endDateTime: IterableDateTimeSchema.optional().describe("End date for metrics (YYYY-MM-DD HH:MM:SS format)"),
+});
+export const CampaignsResponseSchema = z.object({
+    campaigns: z.array(CampaignDetailsSchema),
+});
+export const CampaignMetricsResponseSchema = z
+    .array(z.record(z.string(), z.any()))
+    .describe("Parsed campaign metrics data");
+// Campaign creation schemas
+export const CreateCampaignParamsSchema = z.object({
+    name: z.string().describe("The name to use in Iterable for the new campaign"),
+    templateId: z
+        .number()
+        .describe("The ID of a template to associate with the new campaign"),
+    listIds: z
+        .array(z.number())
+        .describe("Array of list IDs to which the campaign should be sent (for blast campaigns)")
+        .optional(),
+    campaignDataFields: z
+        .record(z.string(), z.any())
+        .optional()
+        .describe("A JSON object containing campaign-level data fields that are available as merge parameters (for example, {{field}}) during message rendering. These fields are available in templates, data feed URLs, and all other contexts where merge parameters are supported. Campaign-level fields are overridden by user and event data fields of the same name."),
+    sendAt: IterableDateTimeSchema.optional().describe("Scheduled send time for blast campaign (YYYY-MM-DD HH:MM:SS UTC). If not provided, the campaign will be sent immediately."),
+    sendMode: z
+        .enum(["ProjectTimeZone", "RecipientTimeZone"])
+        .optional()
+        .describe("Send mode for blast campaigns"),
+    startTimeZone: z
+        .string()
+        .optional()
+        .describe("Starting timezone for recipient timezone sends (IANA format)"),
+    defaultTimeZone: z
+        .string()
+        .optional()
+        .describe("Default timezone for recipients without known timezone (IANA format)"),
+    suppressionListIds: z
+        .array(z.number())
+        .optional()
+        .describe("Array of suppression list IDs"),
+});
+export const CreateCampaignResponseSchema = z.object({
+    campaignId: z.number(),
+});
+// Child campaigns schema
+export const GetChildCampaignsParamsSchema = z.object({
+    id: z.number().describe("ID of the recurring campaign"),
+    page: z
+        .number()
+        .int()
+        .min(1)
+        .optional()
+        .describe("Page number (starting at 1)"),
+    pageSize: z
+        .number()
+        .int()
+        .min(1)
+        .max(1000)
+        .optional()
+        .describe("Number of results to return per page (defaults to 20, maximum of 1000)"),
+    sort: createSortParamSchema(CAMPAIGN_SORT_FIELDS).describe("Field to sort campaigns by with optional direction (defaults to id ascending)"),
+});
+export const GetChildCampaignsResponseSchema = z.object({
+    campaigns: z.array(CampaignDetailsSchema),
+    nextPageUrl: z
+        .string()
+        .optional()
+        .describe("The URL to the next page of campaigns, if applicable"),
+    previousPageUrl: z
+        .string()
+        .optional()
+        .describe("The URL to the previous page of campaigns, if applicable"),
+    totalCampaignsCount: z
+        .number()
+        .describe("The total count of campaigns across all pages for the supplied query"),
+});
+// Campaign scheduling schemas
+export const RecipientTimeZoneSchema = z.object({
+    defaultTimeZone: z
+        .string()
+        .describe("Fallback timezone (IANA format, e.g. America/New_York)"),
+    startTimeZone: z
+        .string()
+        .describe("Starting timezone (IANA format, e.g. America/New_York)"),
+});
+export const ScheduleCampaignParamsSchema = z.object({
+    campaignId: z.number().describe("Campaign ID to schedule"),
+    sendAt: IterableISODateTimeSchema.describe("When to send (ISO-8601 format, e.g. 2024-12-20T10:15:30Z)"),
+    recipientTimeZone: RecipientTimeZoneSchema.optional().describe("Recipient timezone configuration"),
+});
+// Abort campaign schema
+export const AbortCampaignParamsSchema = z.object({
+    campaignId: z.number().describe("Campaign ID to abort"),
+});
+// Cancel campaign schema
+export const CancelCampaignParamsSchema = z.object({
+    campaignId: z.number().describe("Campaign ID to cancel"),
+});
+// Activate triggered campaign schema
+export const ActivateTriggeredCampaignParamsSchema = z.object({
+    campaignId: z.number().describe("Triggered campaign ID to activate"),
+});
+// Deactivate triggered campaign schema
+export const DeactivateTriggeredCampaignParamsSchema = z.object({
+    campaignId: z.number().describe("Triggered campaign ID to deactivate"),
+});
+// Archive campaigns schema
+export const ArchiveCampaignsParamsSchema = z.object({
+    campaignIds: z.array(z.number()).min(1).describe("Campaign IDs to archive"),
+});
+// Archive campaigns response schema
+export const ArchiveCampaignsResponseSchema = z.object({
+    success: z
+        .array(z.number())
+        .describe("Campaign IDs that were successfully archived"),
+    failed: z
+        .array(z.any())
+        .describe("Campaign IDs that failed to archive with error details"),
+});
+// Trigger campaign schema
+export const TriggerCampaignParamsSchema = z.object({
+    campaignId: z.number().describe("Campaign ID to trigger"),
+    listIds: z
+        .array(z.number())
+        .min(1)
+        .describe("A non-empty array of list IDs to send to"),
+    dataFields: z
+        .record(z.string(), z.any())
+        .optional()
+        .describe("Fields to merge into handlebars context"),
+    suppressionListIds: z
+        .array(z.number())
+        .optional()
+        .describe("Lists to suppress"),
+    allowRepeatMarketingSends: z
+        .boolean()
+        .optional()
+        .describe("Allow repeat marketing sends? Defaults to true."),
+});
+// Send campaign schema
+export const SendCampaignParamsSchema = z.object({
+    campaignId: z.number().describe("Campaign ID to send now"),
+});
+//# sourceMappingURL=campaigns.js.map

package/dist/types/campaigns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaigns.js","sourceRoot":"","sources":["../../src/types/campaigns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,yBAAyB,EAEzB,mBAAmB,GACpB,MAAM,aAAa,CAAC;AAErB;;GAEG;AAEH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACpC,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC;QACpB,OAAO;QACP,OAAO;QACP,WAAW;QACX,SAAS;QACT,UAAU;QACV,UAAU;QACV,SAAS;QACT,WAAW;QACX,UAAU;KACX,CAAC;IACF,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,SAAS,EAAE,mBAAmB;IAC9B,SAAS,EAAE,mBAAmB;IAC9B,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;IAC3B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,OAAO,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IACvC,OAAO,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IACvC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACtC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,kBAAkB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAClD,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC;AAIH,uBAAuB;AACvB,MAAM,oBAAoB,GAAG;IAC3B,IAAI;IACJ,MAAM;IACN,WAAW;IACX,WAAW;IACX,SAAS;CACD,CAAC;AAEX,kCAAkC;AAClC,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,EAAE;SACV,QAAQ,CAAC,6BAA6B,CAAC;IAC1C,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,IAAI,CAAC;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,wEAAwE,CACzE;IACH,IAAI,EAAE,qBAAqB,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CACxD,+EAA+E,CAChF;CACF,CAAC,CAAC;AAOH,mBAAmB;AACnB,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC;IACzC,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,sDAAsD,CAAC;IACnE,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,0DAA0D,CAAC;IACvE,mBAAmB,EAAE,CAAC;SACnB,MAAM,EAAE;SACR,QAAQ,CACP,sEAAsE,CACvE;CACJ,CAAC,CAAC;AAIH,+BAA+B;AAC/B,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;CACnD,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,yBAAyB,GAAG,qBAAqB,CAAC;AAgB/D,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gCAAgC,CAAC;IACjE,aAAa,EAAE,sBAAsB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CACvD,qDAAqD,CACtD;IACD,WAAW,EAAE,sBAAsB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CACrD,mDAAmD,CACpD;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC;CAC1C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC;KAC3C,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;KACpC,QAAQ,CAAC,8BAA8B,CAAC,CAAC;AAE5C,4BAA4B;AAC5B,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kDAAkD,CAAC;IAC7E,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,CAAC,yDAAyD,CAAC;IACtE,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,CACP,8EAA8E,CAC/E;SACA,QAAQ,EAAE;IACb,kBAAkB,EAAE,CAAC;SAClB,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;SAC3B,QAAQ,EAAE;SACV,QAAQ,CACP,0VAA0V,CAC3V;IACH,MAAM,EAAE,sBAAsB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAChD,2HAA2H,CAC5H;IACD,QAAQ,EAAE,CAAC;SACR,IAAI,CAAC,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,CAAC;SAC9C,QAAQ,EAAE;SACV,QAAQ,CAAC,+BAA+B,CAAC;IAC5C,aAAa,EAAE,CAAC;SACb,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,8DAA8D,CAAC;IAC3E,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACP,sEAAsE,CACvE;IACH,kBAAkB,EAAE,CAAC;SAClB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,EAAE;SACV,QAAQ,CAAC,+BAA+B,CAAC;CAC7C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;CACvB,CAAC,CAAC;AAEH,yBAAyB;AACzB,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IACvD,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,EAAE;SACV,QAAQ,CAAC,6BAA6B,CAAC;IAC1C,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,IAAI,CAAC;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,wEAAwE,CACzE;IACH,IAAI,EAAE,qBAAqB,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CACxD,+EAA+E,CAChF;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CAAC;IACtD,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC;IACzC,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,sDAAsD,CAAC;IACnE,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,0DAA0D,CAAC;IACvE,mBAAmB,EAAE,CAAC;SACnB,MAAM,EAAE;SACR,QAAQ,CACP,sEAAsE,CACvE;CACJ,CAAC,CAAC;AAMH,8BAA8B;AAC9B,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,QAAQ,CAAC,wDAAwD,CAAC;IACrE,aAAa,EAAE,CAAC;SACb,MAAM,EAAE;SACR,QAAQ,CAAC,wDAAwD,CAAC;CACtE,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IAC1D,MAAM,EAAE,yBAAyB,CAAC,QAAQ,CACxC,2DAA2D,CAC5D;IACD,iBAAiB,EAAE,uBAAuB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAC5D,kCAAkC,CACnC;CACF,CAAC,CAAC;AAMH,wBAAwB;AACxB,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;CACxD,CAAC,CAAC;AAIH,yBAAyB;AACzB,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;CACzD,CAAC,CAAC;AAIH,qCAAqC;AACrC,MAAM,CAAC,MAAM,qCAAqC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5D,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;CACrE,CAAC,CAAC;AAMH,uCAAuC;AACvC,MAAM,CAAC,MAAM,uCAAuC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9D,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC;CACvE,CAAC,CAAC;AAMH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC;CAC5E,CAAC,CAAC;AAMH,oCAAoC;AACpC,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,CAAC,8CAA8C,CAAC;IAC3D,MAAM,EAAE,CAAC;SACN,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;SACd,QAAQ,CAAC,wDAAwD,CAAC;CACtE,CAAC,CAAC;AAMH,0BAA0B;AAC1B,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IACzD,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,0CAA0C,CAAC;IACvD,UAAU,EAAE,CAAC;SACV,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;SAC3B,QAAQ,EAAE;SACV,QAAQ,CAAC,yCAAyC,CAAC;IACtD,kBAAkB,EAAE,CAAC;SAClB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACjB,QAAQ,EAAE;SACV,QAAQ,CAAC,mBAAmB,CAAC;IAChC,yBAAyB,EAAE,CAAC;SACzB,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,iDAAiD,CAAC;CAC/D,CAAC,CAAC;AAIH,uBAAuB;AACvB,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;CAC3D,CAAC,CAAC"}