polyv-live-cli/dist/types/platform.d.ts

CLI tool for managing PolyV live streaming services.

export type OutputFormat = 'table' | 'json';
export interface PlatformGetOptions {
    output?: OutputFormat;
}
export interface PlatformSwitchGetOptions {
    output?: OutputFormat;
}
export type EnabledValue = 'Y' | 'N';
export interface PlatformSwitchUpdateOptions {
    param: string;
    enabled: EnabledValue;
    output?: OutputFormat;
}
export interface PlatformServiceConfig {
    baseUrl: string;
    timeout?: number;
    debug?: boolean;
}
export declare const VALID_SWITCH_PARAMS: readonly ["isClosePreview", "mobileWatch", "mobileAudio", "autoPlay", "booking", "redPack", "shareBtnEnabled", "chat", "chatPlayBack", "closeChaterList", "consultingMenu", "closeDanmu", "praise", "welcome", "viewerSendImgEnabled", "sendFlowersEnabled", "pushSharingEnabled", "qaMenuEnabled", "filterManagerMsgEnabled", "showCustomMessageEnabled", "chatOnlineNumberEnable", "pvShowEnabled", "rtsEnabled"];
export type ValidSwitchParam = typeof VALID_SWITCH_PARAMS[number];
export interface PlatformCallbackGetOptions {
    output?: OutputFormat;
}
export interface PlatformCallbackUpdateOptions {
    url?: string;
    clearUrl?: boolean;
    enabled?: EnabledValue;
    output?: OutputFormat;
}
export type ValidCoverImgType = 'contain' | 'cover';
export interface PlatformSettingGetOptions {
    output?: OutputFormat;
}
export interface PlatformSettingUpdateOptions {
    channelConcurrencesEnabled?: EnabledValue;
    timelyConvertEnabled?: EnabledValue;
    donateEnabled?: EnabledValue;
    rebirthAutoUploadEnabled?: EnabledValue;
    rebirthAutoConvertEnabled?: EnabledValue;
    pptCoveredEnabled?: EnabledValue;
    coverImgType?: ValidCoverImgType;
    testModeButtonEnabled?: EnabledValue;
    output?: OutputFormat;
}
export interface PlatformListAnchorsOptions {
    pageNumber?: number;
    pageSize?: number;
    status?: 0 | 1;
    sex?: 'M' | 'W';
    nickname?: string;
    startTime?: number;
    endTime?: number;
    output?: OutputFormat;
}
export interface PlatformAnchorGetOptions {
    anchorId: number;
    output?: OutputFormat;
}
export interface PlatformAnchorCreateOptions {
    nickname: string;
    sex: 'M' | 'W';
    avatar: string;
    description?: string;
    addChannelIds?: number[];
    force?: boolean;
    output?: OutputFormat;
}
export interface PlatformAnchorUpdateOptions {
    anchorId: number;
    nickname?: string;
    sex?: 'M' | 'W';
    avatar?: string;
    description?: string;
    addChannelIds?: number[];
    delChannelIds?: number[];
    force?: boolean;
    output?: OutputFormat;
}
export interface PlatformAnchorUpdateStatusOptions {
    anchorId: number;
    status: 0 | 1;
    force?: boolean;
    output?: OutputFormat;
}
export interface PlatformAnchorRelationOptions {
    anchorId: number;
    pageNumber?: number;
    pageSize?: number;
    output?: OutputFormat;
}
export interface PlatformContentGroupListOptions {
    type: 'script' | 'robot';
    output?: OutputFormat;
}
export interface PlatformCouponViewerListOptions {
    couponId: string;
    pageNumber?: number;
    pageSize?: number;
    keyword?: string;
    receiveSource?: 'CHANNEL' | 'AGGREGATE_PAGE';
    output?: OutputFormat;
}
export interface PlatformCouponUpdateOptions {
    couponId: string;
    config?: Record<string, unknown>;
    force?: boolean;
    output?: OutputFormat;
}
export interface PlatformCouponStatusBatchOptions {
    couponIds: string[];
    force?: boolean;
    output?: OutputFormat;
}
//# sourceMappingURL=platform.d.ts.map