smartlead-mcp-server/dist/types/campaign.d.ts

MCP server for Smartlead campaign management integration. Features include creating campaigns, updating campaign settings, and managing campaign sequences.

export interface CreateCampaignParams {
    name: string;
    client_id?: number;
}
export interface UpdateCampaignScheduleParams {
    campaign_id: number;
    timezone?: string;
    days_of_the_week?: number[];
    start_hour?: string;
    end_hour?: string;
    min_time_btw_emails?: number;
    max_new_leads_per_day?: number;
    schedule_start_time?: string;
}
export interface UpdateCampaignSettingsParams {
    campaign_id: number;
    name?: string;
    status?: 'active' | 'paused' | 'completed';
    settings?: Record<string, any>;
}
export interface UpdateCampaignStatusParams {
    campaign_id: number;
    status: 'PAUSED' | 'STOPPED' | 'START';
}
export interface GetCampaignParams {
    campaign_id: number;
}
export interface GetCampaignSequenceParams {
    campaign_id: number;
}
export interface ListCampaignsParams {
    status?: 'active' | 'paused' | 'completed';
    limit?: number;
    offset?: number;
}
export interface SaveCampaignSequenceParams {
    campaign_id: number;
    sequence: Array<{
        seq_number: number;
        seq_delay_details: {
            delay_in_days: number;
        };
        variant_distribution_type: 'MANUAL_EQUAL' | 'MANUAL_PERCENTAGE' | 'AI_EQUAL';
        lead_distribution_percentage?: number;
        winning_metric_property?: 'OPEN_RATE' | 'CLICK_RATE' | 'REPLY_RATE' | 'POSITIVE_REPLY_RATE';
        seq_variants: Array<{
            subject: string;
            email_body: string;
            variant_label: string;
            id?: number;
            variant_distribution_percentage?: number;
        }>;
    }>;
}
export interface GetCampaignsByLeadParams {
    lead_id: number;
}
export interface ExportCampaignLeadsParams {
    campaign_id: number;
}
export interface DeleteCampaignParams {
    campaign_id: number;
}
export interface GetCampaignAnalyticsByDateParams {
    campaign_id: number;
    start_date: string;
    end_date: string;
}
export interface GetCampaignSequenceAnalyticsParams {
    campaign_id: number;
    start_date: string;
    end_date: string;
    time_zone?: string;
}
export declare function isCreateCampaignParams(args: unknown): args is CreateCampaignParams;
export declare function isUpdateCampaignScheduleParams(args: unknown): args is UpdateCampaignScheduleParams;
export declare function isUpdateCampaignSettingsParams(args: unknown): args is UpdateCampaignSettingsParams;
export declare function isUpdateCampaignStatusParams(args: unknown): args is UpdateCampaignStatusParams;
export declare function isGetCampaignParams(args: unknown): args is GetCampaignParams;
export declare function isGetCampaignSequenceParams(args: unknown): args is GetCampaignSequenceParams;
export declare function isListCampaignsParams(args: unknown): args is ListCampaignsParams;
export declare function isSaveCampaignSequenceParams(args: unknown): args is SaveCampaignSequenceParams;
export declare function isGetCampaignsByLeadParams(args: unknown): args is GetCampaignsByLeadParams;
export declare function isExportCampaignLeadsParams(args: unknown): args is ExportCampaignLeadsParams;
export declare function isDeleteCampaignParams(args: unknown): args is DeleteCampaignParams;
export declare function isGetCampaignAnalyticsByDateParams(args: unknown): args is GetCampaignAnalyticsByDateParams;
export declare function isGetCampaignSequenceAnalyticsParams(args: unknown): args is GetCampaignSequenceAnalyticsParams;