@neynar/nodejs-sdk/build/api/models/notification-campaign.d.ts

SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)

/**
 * Neynar API
 * The Neynar API allows you to interact with the Farcaster protocol among other things. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
 *
 * The version of the OpenAPI document: 3.175.0
 * Contact: team@neynar.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { NotificationCampaignStats } from './notification-campaign-stats';
export interface NotificationCampaign {
    /**
     * The body text of the notification.
     */
    'body': string;
    /**
     * When the campaign reached a terminal state (completed/failed/canceled). Null while still queued or running.
     */
    'completed_at'?: string | null;
    'created_at': string;
    /**
     * The unique identifier for the notification campaign.
     */
    'id': string;
    /**
     * When the campaign was enqueued for async delivery.
     */
    'queued_at'?: string;
    'stats': NotificationCampaignStats;
    /**
     * Lifecycle status of the campaign. Absent on campaigns created before async delivery was introduced.
     */
    'status'?: NotificationCampaignStatusEnum;
    /**
     * The title of the notification campaign.
     */
    'title': string;
}
export declare const NotificationCampaignStatusEnum: {
    readonly Queued: "queued";
    readonly Running: "running";
    readonly Completed: "completed";
    readonly Failed: "failed";
    readonly Canceled: "canceled";
};
export type NotificationCampaignStatusEnum = typeof NotificationCampaignStatusEnum[keyof typeof NotificationCampaignStatusEnum];