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

CLI tool for managing PolyV live streaming services.

export type ViewerSource = 'IMPORT' | 'WX' | 'MOBILE';
export interface ViewerServiceConfig {
    baseUrl?: string;
    timeout?: number;
    debug?: boolean;
}
export interface ViewerGetOptions {
    viewerId: string;
    output?: 'table' | 'json';
}
export interface ViewerListOptions {
    source?: ViewerSource;
    mobile?: string;
    email?: string;
    area?: string;
    page?: number;
    size?: number;
    output?: 'table' | 'json';
}
export interface ViewerCreateOptions {
    nickname: string;
    mobile: string;
    name?: string;
    lastCollectMobile?: string;
    email?: string;
    area?: string;
    latestAccessIp?: string;
    device?: string;
    followUsers?: string;
    force?: boolean;
    output?: 'table' | 'json';
}
export interface ViewerUpdateOptions {
    viewerUnionId: string;
    nickname?: string;
    mobile?: string;
    name?: string;
    lastCollectMobile?: string;
    email?: string;
    area?: string;
    latestAccessIp?: string;
    device?: string;
    force?: boolean;
    output?: 'table' | 'json';
}
export interface ViewerDeleteOptions {
    viewerUnionId: string;
    force?: boolean;
    output?: 'table' | 'json';
}
export interface ViewerImportExternalOptions {
    viewers?: string;
    externalViewerId?: string;
    nickname?: string;
    labelIds?: string;
    followUserId?: string;
    followUserType?: string;
    force?: boolean;
    output?: 'table' | 'json';
}
export interface ViewerConfigUpdateOptions {
    mobileLoginEnabled: 'Y' | 'N';
    wxWorkLoginEnabled: 'Y' | 'N';
    viewerWeixinAuthExpired?: number;
    collectMobileEnabled?: 'Y' | 'N';
    guestModeEnabled?: 'Y' | 'N';
    touristExternalHrefEnabled?: 'Y' | 'N';
    touristExternalHrefConfig?: string;
    force?: boolean;
    output?: 'table' | 'json';
}
export interface ViewerLotteryWinsOptions {
    viewerId: string;
    page?: number;
    size?: number;
    output?: 'table' | 'json';
}
export interface ViewerTagAddOptions {
    viewerIds: string;
    labelIds: string;
    force?: boolean;
    output?: 'table' | 'json';
}
export interface ViewerTagRemoveOptions {
    viewerIds: string;
    labelIds: string;
    force?: boolean;
    output?: 'table' | 'json';
}
export interface ViewerTagListOptions {
    keyword?: string;
    page?: number;
    size?: number;
    output?: 'table' | 'json';
}
export interface ViewerTagCreateOptions {
    labels: string;
    force?: boolean;
    output?: 'table' | 'json';
}
export interface ViewerTagUpdateOptions {
    id: number;
    label?: string;
    force?: boolean;
    output?: 'table' | 'json';
}
export interface ViewerTagDeleteOptions {
    id: number;
    force?: boolean;
    output?: 'table' | 'json';
}
export interface ViewerLabelListOptions {
    page?: number;
    size?: number;
    output?: 'table' | 'json';
}
export interface ViewerLabelCreateOptions {
    labelName: string;
    force?: boolean;
    output?: 'table' | 'json';
}
export interface ViewerLabelUpdateOptions {
    labelId: string;
    labelName: string;
    force?: boolean;
    output?: 'table' | 'json';
}
export interface ViewerLabelDeleteOptions {
    labelId: string;
    force?: boolean;
    output?: 'table' | 'json';
}
export interface ViewerChannelLabelRefsOptions {
    channelIds: string;
    labelIds: string;
    force?: boolean;
    output?: 'table' | 'json';
}
//# sourceMappingURL=viewer.d.ts.map