stream-chat/dist/types/campaign.d.ts

JS SDK for the Stream Chat API

import type { StreamChat } from './client';
import type { CampaignData, GetCampaignOptions } from './types';
export declare class Campaign {
    id: string | null;
    data?: CampaignData;
    client: StreamChat;
    constructor(client: StreamChat, id: string | null, data?: CampaignData);
    create(): Promise<{
        campaign: import("./types").CampaignResponse;
        users: {
            next?: string;
            prev?: string;
        };
    } & import("./types").APIResponse>;
    verifyCampaignId(): void;
    start(options?: {
        scheduledFor?: string;
        stopAt?: string;
    }): Promise<{
        campaign: import("./types").CampaignResponse;
        users: {
            next?: string;
            prev?: string;
        };
    } & import("./types").APIResponse>;
    update(data: Partial<CampaignData>): Promise<{
        campaign: import("./types").CampaignResponse;
        users: {
            next?: string;
            prev?: string;
        };
    }>;
    delete(): Promise<import("./types").APIResponse>;
    stop(): Promise<{
        campaign: import("./types").CampaignResponse;
    }>;
    get(options?: GetCampaignOptions): Promise<{
        campaign: import("./types").CampaignResponse;
        users: {
            next?: string;
            prev?: string;
        };
    } & import("./types").APIResponse>;
}