beeswax-node-client/dist/types/index.d.ts

TypeScript/JavaScript client library for the Beeswax DSP API

export declare enum CreativeType {
    DISPLAY = 0,
    VIDEO = 1,
    NATIVE = 2
}
export interface BeeswaxCredentials {
    email: string;
    password: string;
}
export interface BeeswaxClientOptions {
    apiRoot?: string;
    creds: BeeswaxCredentials;
    timeout?: number;
    retryOptions?: {
        retries?: number;
        retryDelay?: (retryCount: number) => number;
        retryCondition?: (error: any) => boolean;
    };
}
export interface BeeswaxResponse<T = any> {
    success: boolean;
    payload?: T;
    code?: number;
    message?: string;
    errors?: string[];
}
export interface QueryOptions {
    rows?: number;
    offset?: number;
    sort_by?: string;
    [key: string]: any;
}
export interface Advertiser {
    advertiser_id: number;
    advertiser_name: string;
    alternative_id?: string;
    active?: boolean;
    created_date?: string;
    updated_date?: string;
    [key: string]: any;
}
export interface Campaign {
    campaign_id: number;
    advertiser_id: number;
    campaign_name: string;
    campaign_budget?: number;
    start_date?: string;
    end_date?: string;
    active?: boolean;
    campaign_type?: string;
    frequency_cap?: any;
    created_date?: string;
    updated_date?: string;
    [key: string]: any;
}
export interface LineItem {
    line_item_id: number;
    campaign_id: number;
    line_item_name: string;
    line_item_type_id?: number;
    line_item_budget?: number;
    bidding?: {
        values: {
            cpm_bid?: number;
            cpc_bid?: number;
            cpa_bid?: number;
        };
        bidding_strategy?: string;
        pacing?: string;
        bid_shading?: boolean;
    };
    max_bid?: number;
    start_date?: string;
    end_date?: string;
    active?: boolean;
    targeting?: any;
    targeting_expression_id?: number;
    pacing?: string;
    delivery_model?: string;
    bid_strategy?: string;
    created_date?: string;
    updated_date?: string;
    [key: string]: any;
}
export interface Creative {
    creative_id: number;
    advertiser_id: number;
    creative_name: string;
    creative_type?: number;
    creative_template_id?: number;
    width?: number;
    height?: number;
    secure?: boolean;
    active?: boolean;
    creative_attributes?: any;
    created_date?: string;
    updated_date?: string;
    [key: string]: any;
}
export interface CreativeLineItem {
    cli_id: number;
    creative_id: number;
    line_item_id: number;
    active?: boolean;
    weighting?: number;
    created_date?: string;
    updated_date?: string;
    [key: string]: any;
}
export interface TargetingTemplate {
    targeting_template_id: number;
    advertiser_id: number;
    targeting_template_name: string;
    targeting?: any;
    active?: boolean;
    created_date?: string;
    updated_date?: string;
    [key: string]: any;
}
export interface CreativeAsset {
    creative_asset_id: number;
    advertiser_id: number;
    creative_asset_name: string;
    size_in_bytes?: number;
    notes?: string;
    active?: boolean;
    asset_type?: string;
    url?: string;
    created_date?: string;
    updated_date?: string;
    [key: string]: any;
}
export interface UploadCreativeAssetParams {
    advertiser_id: number;
    creative_asset_name?: string;
    size_in_bytes?: number;
    notes?: string;
    active?: boolean;
    sourceUrl: string;
}
export interface Segment {
    segment_id: number;
    advertiser_id: number;
    segment_name: string;
    segment_description?: string;
    active?: boolean;
    created_date?: string;
    updated_date?: string;
    [key: string]: any;
}
export interface Report {
    report_id: number;
    advertiser_id: number;
    report_name: string;
    report_type: string;
    dimensions: string[];
    metrics: string[];
    filters?: any;
    start_date: string;
    end_date: string;
    [key: string]: any;
}
export interface CampaignCreationOptions {
    advertiser_id: number;
    campaign_name: string;
    campaign_budget: number;
    start_date: string;
    end_date: string;
    line_items: LineItemCreationOptions[];
    targeting_templates?: TargetingTemplateCreationOptions[];
}
export interface LineItemCreationOptions {
    line_item_name: string;
    line_item_budget: number;
    bid_price: number;
    targeting_expression_id?: number;
    creatives?: CreativeCreationOptions[];
    pacing?: string;
    delivery_model?: string;
    bid_strategy?: string;
}
export interface CreativeCreationOptions {
    creative_name: string;
    creative_type: string;
    creative_template_id?: number;
    width?: number;
    height?: number;
    creative_attributes?: any;
    asset_url?: string;
    click_url?: string;
}
export interface TargetingTemplateCreationOptions {
    targeting_template_name: string;
    targeting: any;
}
export interface FullCampaignResponse {
    campaign: Campaign;
    line_items: LineItem[];
    creatives: Creative[];
    creative_line_items: CreativeLineItem[];
    targeting_templates?: TargetingTemplate[];
}
//# sourceMappingURL=index.d.ts.map