polyv-live-cli/dist/types/card-push.d.ts

CLI tool for managing PolyV live streaming services.

export interface CardPushServiceConfig {
    baseUrl: string;
    timeout: number;
    debug?: boolean;
}
export interface CardPushListOptions {
    channelId: string;
    output?: 'table' | 'json';
}
export interface CardPushCreateOptions {
    channelId: string;
    cardType?: 'common' | 'qrCode';
    imageType: 'giftbox' | 'redpack' | 'custom' | 'weixinWork';
    title: string;
    link: string;
    duration: number;
    durationPosition?: 'bottom' | 'top';
    showCondition: 'PUSH' | 'WATCH';
    conditionValue?: number;
    conditionUnit?: 'SECONDS' | 'MINUTES';
    countdownMsg?: string;
    enterEnabled?: 'Y' | 'N';
    linkEnabled?: 'Y' | 'N';
    redirectType?: 'iframe' | 'tab';
    output?: 'table' | 'json';
}
export interface CardPushUpdateOptions {
    channelId: string;
    cardPushId: string;
    cardType?: 'common' | 'qrCode';
    imageType?: 'giftbox' | 'redpack' | 'custom' | 'weixinWork';
    title?: string;
    link?: string;
    duration?: number;
    durationPosition?: 'bottom' | 'top';
    showCondition?: 'PUSH' | 'WATCH';
    conditionValue?: number;
    conditionUnit?: 'SECONDS' | 'MINUTES';
    countdownMsg?: string;
    enterEnabled?: 'Y' | 'N';
    linkEnabled?: 'Y' | 'N';
    redirectType?: 'iframe' | 'tab';
    output?: 'table' | 'json';
}
export interface CardPushPushOptions {
    channelId: string;
    cardPushId: string;
    output?: 'table' | 'json';
}
export interface CardPushCancelOptions {
    channelId: string;
    cardPushId: string;
    output?: 'table' | 'json';
}
export interface CardPushDeleteOptions {
    channelId: string;
    cardPushId: string;
    output?: 'table' | 'json';
}
export interface CardPushShareGetOptions {
    channelId: string;
    output?: 'table' | 'json';
}
export interface CardPushShareUpdateOptions extends CardPushShareGetOptions {
    shareBtnEnable: 'Y' | 'N';
    titleType: 'follow' | 'custom' | string;
    weixinShareTitle?: string;
    weixinShareDesc?: string;
    weixinShareCustomUrl?: string;
    webShareCustomUrl?: string;
    weixinShareCustomUrlWithParamEnabled?: 'Y' | 'N';
    webShareCustomUrlWithParamEnabled?: 'Y' | 'N';
    force?: boolean;
}
export interface CardPush {
    id: number;
    channelId: number;
    title: string;
    cardType?: 'common' | 'qrCode';
    imageType: 'giftbox' | 'redpack' | 'custom' | 'weixinWork';
    duration: number;
    durationPosition?: 'bottom' | 'top';
    link: string;
    pushStatus: 'Y' | 'N' | 'L';
    enterEnabled: 'Y' | 'N';
    showCondition: 'PUSH' | 'WATCH';
    conditionValue?: number;
    conditionUnit?: 'SECONDS' | 'MINUTES';
    countdownMsg?: string;
    linkEnabled?: 'Y' | 'N';
    redirectType?: 'iframe' | 'tab';
    createdTime: number;
    lastModified?: number;
    pushTime?: number;
    pushEndTime?: number;
    enterImage?: string;
    cardImage?: string;
}
export interface CreatedCardPush {
    id: number;
    channelId: number;
    title: string;
    cardType?: 'common' | 'qrCode';
    imageType: 'giftbox' | 'redpack' | 'custom' | 'weixinWork';
    duration: number;
    durationPosition?: 'bottom' | 'top';
    link: string;
    pushStatus: 'Y' | 'N' | 'L';
    enterEnabled?: 'Y' | 'N';
    showCondition: 'PUSH' | 'WATCH';
    conditionValue?: number;
    conditionUnit?: 'SECONDS' | 'MINUTES';
    countdownMsg?: string;
    linkEnabled?: 'Y' | 'N';
    redirectType?: 'iframe' | 'tab';
    createdTime: number;
    lastModified?: number;
    pushTime?: number;
    pushEndTime?: number;
}
export interface CardPushCreateParams {
    channelId: string;
    cardType?: 'common' | 'qrCode' | undefined;
    imageType: 'giftbox' | 'redpack' | 'custom' | 'weixinWork';
    title: string;
    link: string;
    duration: number;
    durationPosition?: 'bottom' | 'top' | undefined;
    showCondition: 'PUSH' | 'WATCH';
    conditionValue?: number | undefined;
    conditionUnit?: 'SECONDS' | 'MINUTES' | undefined;
    countdownMsg?: string | undefined;
    enterEnabled?: 'Y' | 'N' | undefined;
    linkEnabled?: 'Y' | 'N' | undefined;
    redirectType?: 'iframe' | 'tab' | undefined;
}
export interface CardPushUpdateParams {
    channelId: string;
    cardPushId: string;
    cardType?: 'common' | 'qrCode' | undefined;
    imageType?: 'giftbox' | 'redpack' | 'custom' | 'weixinWork' | undefined;
    title?: string | undefined;
    link?: string | undefined;
    duration?: number | undefined;
    durationPosition?: 'bottom' | 'top' | undefined;
    showCondition?: 'PUSH' | 'WATCH' | undefined;
    conditionValue?: number | undefined;
    conditionUnit?: 'SECONDS' | 'MINUTES' | undefined;
    countdownMsg?: string | undefined;
    enterEnabled?: 'Y' | 'N' | undefined;
    linkEnabled?: 'Y' | 'N' | undefined;
    redirectType?: 'iframe' | 'tab' | undefined;
}
export interface CardPushPushParams {
    channelId: string;
    cardPushId: string;
}
export interface CardPushCancelParams {
    channelId: string;
    cardPushId: string;
}
export interface CardPushDeleteParams {
    channelId: string;
    cardPushId: string;
}
//# sourceMappingURL=card-push.d.ts.map