polyv-live-api-sdk 1.0.11 → 1.0.13

package/dist/types/v4-channel.d.ts

@@ -817,11 +817,14 @@ export interface DonateSettings {
     /** Channel ID */
     channelId: string;
     /** Donate enabled */
-    donateEnabled: YNFlag;
+    donateEnabled?: YNFlag;
+    donateGiftEnabled?: YNFlag;
     /** Donate tips */
-    donateTips: string;
+    donateTips?: string;
     /** Donate amounts */
-    donateAmounts: number[];
+    donateAmounts?: number[];
+    giftDonate?: GiftDonateConfig;
+    [key: string]: unknown;
 }
 /**
  * Parameters for getting donate settings
@@ -838,10 +841,32 @@ export interface UpdateDonateParams {
     channelId: string;
     /** Donate enabled */
     donateEnabled?: YNFlag;
+    donateGiftEnabled?: YNFlag;
     /** Donate tips */
     donateTips?: string;
     /** Donate amounts */
     donateAmounts?: number[];
+    giftDonate?: GiftDonateConfig;
+}
+export interface GiftDonatePayItem {
+    name?: string;
+    enabled?: YNFlag;
+    imgType?: 'STATIC' | 'DYNAMIC' | string;
+    img?: string;
+    dynamicImg?: string;
+    dynamicFile?: string;
+    price?: number | string;
+}
+export interface GiftDonateConfig {
+    payWay?: 'CASH' | 'POINT' | string;
+    pointUnit?: string;
+    cashPays?: GiftDonatePayItem[];
+    pointPays?: GiftDonatePayItem[];
+}
+export interface UpdateDonateGiftParams {
+    channelId: string | number;
+    donateGiftEnabled: YNFlag;
+    giftDonate?: GiftDonateConfig;
 }
 /**
  * Distribute info
@@ -1027,68 +1052,139 @@ export interface QueryWinnerViewerResponse {
     /** Contents */
     contents: WinnerViewerInfo[];
 }
+export interface LotteryReceiveInfo {
+    type?: 'userName' | 'userPhone' | 'custom' | string;
+    field: string;
+    tips?: string;
+    required?: boolean;
+}
+export interface LotteryPrizeInfo {
+    prizeItem: string;
+    correctAnswerCount: number;
+    [key: string]: unknown;
+}
 /**
  * Lottery activity info
  */
 export interface LotteryActivity {
     /** Activity ID */
-    activityId: string;
+    id: number;
     /** Channel ID */
-    channelId: string;
+    channelId?: string;
     /** Activity name */
-    name: string;
-    /** Activity type */
-    type: string;
+    activityName: string;
+    /** Lottery condition type */
+    lotteryCondition: 'none' | 'invite' | 'duration' | 'comment' | 'question' | string;
     /** Status */
-    status: YNFlag;
-    /** Start time */
-    startTime: number;
-    /** End time */
-    endTime: number;
-    /** Created time */
-    createdTime: number;
+    status?: string | null;
+    /** Winner count */
+    amount: number;
+    /** Prize name */
+    prizeName: string;
+    hiddenWinnerAmount?: YNFlag;
+    lotteryRange?: 'all' | 'customGroup' | string;
+    customGroup?: Array<Record<string, unknown>>;
+    customGroupIds?: Array<string | number>;
+    customGroupLotteryType?: 'average' | 'random' | string;
+    customGroupLotteryAmount?: number | null;
+    hiddenAttendeeNumber?: YNFlag;
+    repeatWinEnabled?: YNFlag;
+    receiveEnabled?: YNFlag;
+    receiveInfo?: LotteryReceiveInfo[] | null;
+    thumbnail?: string | null;
+    activityDuration?: string | number | null;
+    activityDurationType?: 'second' | 'minute' | 'hour' | string | null;
+    inviteType?: 'poster' | 'external' | string | null;
+    externalListLink?: string | null;
+    externalInviteNumLink?: string | null;
+    inviteNum?: number | null;
+    duration?: number | null;
+    comment?: string | null;
+    acceptType?: 'form' | 'link' | 'qrCode' | string | null;
+    formInfo?: LotteryReceiveInfo[] | null;
+    prizeUrl?: string | null;
+    qrCode?: string | null;
+    qrCodeTips?: string | null;
+    realPrice?: number | null;
+    price?: number | null;
+    prizeInfo?: LotteryPrizeInfo[] | null;
+    questionGroupId?: number | null;
+    perAnswerDuration?: number | null;
+    lotteryOnlineEnabled?: YNFlag;
+    answerType?: 'pushQuestion' | 'autonomyAnswer' | string;
+    showWinnerCode?: YNFlag;
+    showWinners?: YNFlag;
+    [key: string]: unknown;
 }
 /**
  * Parameters for creating lottery activity
  */
 export interface LotteryActivityCreateParams {
     /** Channel ID */
-    channelId: string;
+    channelId: string | number;
     /** Activity name */
-    name: string;
-    /** Activity type */
-    type: string;
-    /** Start time */
-    startTime?: number;
-    /** End time */
-    endTime?: number;
+    activityName: string;
+    /** Lottery condition type */
+    lotteryCondition: 'none' | 'invite' | 'duration' | 'comment' | 'question' | string;
+    /** Winner count */
+    amount: number;
+    /** Prize name */
+    prizeName: string;
+    hiddenWinnerAmount?: YNFlag;
+    lotteryRange?: 'all' | 'customGroup' | string;
+    customGroupIds?: Array<string | number>;
+    customGroupLotteryType?: 'average' | 'random' | string;
+    customGroupLotteryAmount?: number;
+    hiddenAttendeeNumber?: YNFlag;
+    repeatWinEnabled?: YNFlag;
+    receiveEnabled?: YNFlag;
+    receiveInfo?: LotteryReceiveInfo[];
+    thumbnail?: string;
+    activityDuration?: string | number;
+    activityDurationType?: 'second' | 'minute' | 'hour' | string;
+    inviteType?: 'poster' | 'external' | string;
+    externalListLink?: string;
+    externalInviteNumLink?: string;
+    inviteNum?: number;
+    duration?: number;
+    comment?: string;
+    acceptType?: 'form' | 'link' | 'qrCode' | string;
+    formInfo?: LotteryReceiveInfo[];
+    prizeUrl?: string;
+    qrCode?: string;
+    qrCodeTips?: string;
+    realPrice?: number;
+    price?: number;
+    prizeInfo?: LotteryPrizeInfo[];
+    questionGroupId?: number;
+    perAnswerDuration?: number;
+    lotteryOnlineEnabled?: YNFlag;
+    answerType?: 'pushQuestion' | 'autonomyAnswer' | string;
+    showWinnerCode?: YNFlag;
+    showWinners?: YNFlag;
 }
 /**
  * Response for creating lottery activity
  */
 export interface LotteryActivityCreateResponse {
     /** Activity ID */
-    activityId: string;
+    id: number;
 }
 /**
  * Parameters for getting lottery activity
  */
 export interface LotteryActivityGetParams {
     /** Channel ID */
-    channelId: string;
+    channelId: string | number;
     /** Activity ID */
-    activityId: string;
+    id: string | number;
 }
 /**
  * Parameters for listing lottery activities
  */
-export interface LotteryActivityListParams {
+export interface LotteryActivityListParams extends V4PaginationParams {
     /** Channel ID */
-    channelId: string;
-    /** Page number */
-    pageNumber?: number;
-    /** Page size */
-    pageSize?: number;
+    channelId: string | number;
 }
 /**
  * Response for listing lottery activities
@@ -1108,26 +1204,58 @@ export interface LotteryActivityListResponse {
  */
 export interface LotteryActivityUpdateParams {
     /** Channel ID */
-    channelId: string;
+    channelId: string | number;
     /** Activity ID */
-    activityId: string;
+    id: string | number;
     /** Activity name */
-    name?: string;
-    /** Start time */
-    startTime?: number;
-    /** End time */
-    endTime?: number;
-    /** Status */
-    status?: YNFlag;
+    activityName: string;
+    /** Lottery condition type */
+    lotteryCondition: 'none' | 'invite' | 'duration' | 'comment' | 'question' | string;
+    /** Winner count */
+    amount: number;
+    /** Prize name */
+    prizeName: string;
+    hiddenWinnerAmount?: YNFlag;
+    lotteryRange?: 'all' | 'customGroup' | string;
+    customGroupIds?: Array<string | number>;
+    customGroupLotteryType?: 'average' | 'random' | string;
+    customGroupLotteryAmount?: number;
+    hiddenAttendeeNumber?: YNFlag;
+    repeatWinEnabled?: YNFlag;
+    receiveEnabled?: YNFlag;
+    receiveInfo?: LotteryReceiveInfo[];
+    thumbnail?: string;
+    activityDuration?: string | number;
+    activityDurationType?: 'second' | 'minute' | 'hour' | string;
+    inviteType?: 'poster' | 'external' | string;
+    externalListLink?: string;
+    externalInviteNumLink?: string;
+    inviteNum?: number;
+    duration?: number;
+    comment?: string;
+    acceptType?: 'form' | 'link' | 'qrCode' | string;
+    formInfo?: LotteryReceiveInfo[];
+    prizeUrl?: string;
+    qrCode?: string;
+    qrCodeTips?: string;
+    realPrice?: number;
+    price?: number;
+    prizeInfo?: LotteryPrizeInfo[];
+    questionGroupId?: number;
+    perAnswerDuration?: number;
+    lotteryOnlineEnabled?: YNFlag;
+    answerType?: 'pushQuestion' | 'autonomyAnswer' | string;
+    showWinnerCode?: YNFlag;
+    showWinners?: YNFlag;
 }
 /**
  * Parameters for deleting lottery activity
  */
 export interface LotteryActivityDeleteParams {
     /** Channel ID */
-    channelId: string;
+    channelId: string | number;
     /** Activity ID */
-    activityId: string;
+    id: string | number;
 }
 /**
  * Parameters for adding to blacklist
@@ -1414,126 +1542,137 @@ export interface DiskVideoScriptDeleteParams {
  * Share settings
  */
 export interface ShareSettings {
-    /** Channel ID */
-    channelId: string;
-    /** Share title */
-    title: string;
-    /** Share description */
-    description: string;
-    /** Share image URL */
-    imageUrl: string;
+    shareBtnEnable?: YNFlag;
+    titleType?: 'follow' | 'custom' | string;
+    weixinShareTitle?: string;
+    weixinShareDesc?: string;
+    weixinShareCustomUrl?: string;
+    webShareCustomUrl?: string;
+    weixinShareCustomUrlWithParamEnabled?: YNFlag;
+    webShareCustomUrlWithParamEnabled?: YNFlag;
+    [key: string]: unknown;
 }
 /**
  * Parameters for getting share settings
  */
 export interface ShareGetParams {
     /** Channel ID */
-    channelId: string;
+    channelId: string | number;
 }
 /**
  * Parameters for updating share settings
  */
 export interface ShareUpdateParams {
     /** Channel ID */
-    channelId: string;
-    /** Share title */
-    title?: string;
-    /** Share description */
-    description?: string;
-    /** Share image URL */
-    imageUrl?: string;
+    channelId: string | number;
+    shareBtnEnable: YNFlag;
+    titleType: 'follow' | 'custom' | string;
+    weixinShareTitle?: string;
+    weixinShareDesc?: string;
+    weixinShareCustomUrl?: string;
+    webShareCustomUrl?: string;
+    weixinShareCustomUrlWithParamEnabled?: YNFlag;
+    webShareCustomUrlWithParamEnabled?: YNFlag;
 }
 /**
  * Card push info
  */
 export interface CardPushInfo {
-    /** Card push ID */
-    id: number;
-    /** Channel ID */
-    channelId: string;
-    /** Card title */
-    title: string;
-    /** Card content */
-    content: string;
-    /** Card type */
-    type: string;
-    /** Card URL */
-    url: string;
-    /** Created time */
-    createdTime: number;
+    cardPushId?: number | string;
+    channelId?: string | number;
+    cardType?: 'common' | 'qrCode' | string;
+    imageType?: 'giftbox' | 'redpack' | 'custom' | 'weixinWork' | string;
+    title?: string;
+    link?: string;
+    duration?: 0 | 5 | 10 | 20 | 30 | number;
+    showCondition?: 'PUSH' | 'WATCH' | string;
+    [key: string]: unknown;
 }
 /**
  * Parameters for creating card push
  */
 export interface CardPushCreateParams {
     /** Channel ID */
-    channelId: string;
-    /** Card title */
+    channelId: string | number;
+    cardType?: 'common' | 'qrCode' | string;
+    imageType: 'giftbox' | 'redpack' | 'custom' | 'weixinWork' | string;
     title: string;
-    /** Card content */
-    content: string;
-    /** Card type */
-    type: string;
-    /** Card URL */
-    url?: string;
+    link: string;
+    duration: 0 | 5 | 10 | 20 | 30 | number;
+    durationPosition?: 'bottom' | 'top' | string;
+    showCondition: 'PUSH' | 'WATCH' | string;
+    conditionValue?: number;
+    conditionUnit?: 'SECONDS' | 'MINUTES' | string;
+    countdownMsg?: string;
+    enterEnabled?: YNFlag;
+    linkEnabled?: YNFlag;
+    redirectType?: 'iframe' | 'tab' | string;
+    enterImage?: string;
+    cardImage?: string;
+    weixinWordQrCodeId?: string;
+    qrCodeImage?: string;
+    hrefType?: 'common' | 'multiplatform' | string;
+    pcLink?: string;
+    mobileLink?: string;
+    wxMiniprogramOriginalId?: string;
+    wxMiniprogramAppId?: string;
+    wxMiniprogramLink?: string;
+    mobileAppLink?: string;
 }
 /**
  * Response for creating card push
  */
 export interface CardPushCreateResponse {
     /** Card push ID */
-    id: number;
-}
-/**
- * Parameters for getting card push
- */
-export interface CardPushGetParams {
-    /** Channel ID */
-    channelId: string;
-    /** Card push ID */
-    id: number;
+    cardPushId?: number | string;
+    [key: string]: unknown;
 }
 /**
  * Parameters for updating card push
  */
 export interface CardPushUpdateParams {
     /** Channel ID */
-    channelId: string;
+    channelId: string | number;
     /** Card push ID */
-    id: number;
-    /** Card title */
+    cardPushId: string | number;
     title?: string;
-    /** Card content */
-    content?: string;
-    /** Card URL */
-    url?: string;
+    duration?: 0 | 5 | 10 | 20 | 30 | number;
+    imageType?: 'giftbox' | 'redpack' | 'custom' | 'weixinWork' | string;
+    link?: string;
+    showCondition?: 'PUSH' | 'WATCH' | string;
+    conditionValue?: number;
+    conditionUnit?: 'SECONDS' | 'MINUTES' | string;
+    countdownMsg?: string;
+    enterEnabled?: YNFlag;
+    linkEnabled?: YNFlag;
+    [key: string]: unknown;
 }
 /**
  * Parameters for deleting card push
  */
 export interface CardPushDeleteParams {
     /** Channel ID */
-    channelId: string;
+    channelId: string | number;
     /** Card push ID */
-    id: number;
+    cardPushId: string | number;
 }
 /**
  * Parameters for pushing card
  */
 export interface CardPushPushParams {
     /** Channel ID */
-    channelId: string;
+    channelId: string | number;
     /** Card push ID */
-    id: number;
+    cardPushId: string | number;
 }
 /**
  * Parameters for canceling card push
  */
 export interface CardPushCancelPushParams {
     /** Channel ID */
-    channelId: string;
+    channelId: string | number;
     /** Card push ID */
-    id: number;
+    cardPushId: string | number;
 }
 /**
  * Parameters for browsers summary
@@ -1767,67 +1906,64 @@ export interface ProductStatsPageResponse {
  */
 export interface ProductTag {
     /** Tag ID */
-    tagId: string;
+    id?: number | string;
     /** Tag name */
-    name: string;
-    /** Tag color */
-    color: string;
+    name?: string;
+    [key: string]: unknown;
 }
 /**
  * Parameters for creating product tag
  */
 export interface ProductTagCreateParams {
     /** Channel ID */
-    channelId: string;
+    channelId: string | number;
     /** Tag name */
     name: string;
-    /** Tag color */
-    color?: string;
 }
 /**
  * Response for creating product tag
  */
 export interface ProductTagCreateResponse {
     /** Tag ID */
-    tagId: string;
+    id?: number | string;
+    name?: string;
+    [key: string]: unknown;
 }
 /**
  * Parameters for getting product tag
  */
 export interface ProductTagGetParams {
     /** Channel ID */
-    channelId: string;
+    channelId: string | number;
     /** Tag ID */
-    tagId: string;
+    id: string | number;
 }
 /**
  * Parameters for listing product tags
  */
-export interface ProductTagListParams {
+export interface ProductTagListParams extends V4PaginationParams {
     /** Channel ID */
-    channelId: string;
+    channelId: string | number;
 }
 /**
  * Parameters for updating product tag
  */
 export interface ProductTagUpdateParams {
     /** Channel ID */
-    channelId: string;
+    channelId: string | number;
     /** Tag ID */
-    tagId: string;
+    id: string | number;
     /** Tag name */
-    name?: string;
-    /** Tag color */
-    color?: string;
+    name: string;
 }
 /**
  * Parameters for deleting product tag
  */
 export interface ProductTagDeleteParams {
     /** Channel ID */
-    channelId: string;
+    channelId: string | number;
     /** Tag ID */
-    tagId: string;
+    id: string | number;
 }
 /**
  * Parameters for paging gifts
@@ -1900,6 +2036,48 @@ export interface LikeInfo {
     /** Like time */
     likeTime: number;
 }
+export interface RewardGiftRecord {
+    viewerId?: string;
+    viewerName?: string;
+    giftName?: string;
+    price?: number;
+    count?: number;
+    createTime?: number;
+    [key: string]: unknown;
+}
+export interface ListRewardGiftsParams extends V4PaginationParams {
+    channelId: string | number;
+    start: number;
+    end: number;
+}
+export interface ListRewardGiftsResponse {
+    pageNumber?: number;
+    pageSize?: number;
+    totalItems?: number;
+    totalPages?: number;
+    contents?: RewardGiftRecord[];
+    [key: string]: unknown;
+}
+export interface RewardLikeRecord {
+    viewerId?: string;
+    viewerName?: string;
+    likeCount?: number;
+    createTime?: number;
+    [key: string]: unknown;
+}
+export interface ListRewardLikesParams extends V4PaginationParams {
+    channelId: string | number;
+    start?: number;
+    end?: number;
+}
+export interface ListRewardLikesResponse {
+    pageNumber?: number;
+    pageSize?: number;
+    totalItems?: number;
+    totalPages?: number;
+    contents?: RewardLikeRecord[];
+    [key: string]: unknown;
+}
 /**
  * Response for paging likes
  */
@@ -2307,6 +2485,10 @@ export interface LiveSessionInfo {
     /** Max viewer count */
     maxViewerCount: number;
 }
+export interface ListCardPushesParams {
+    channelId: string | number;
+}
+export type ListCardPushesResponse = CardPushInfo[];
 /** V4 Pagination parameters */
 export interface V4PaginationParams {
     /** Page number (1-based) */
@@ -2327,6 +2509,7 @@ export interface V4PaginatedResponse<T> {
     /** Page size */
     pageSize?: number;
 }
+export type V4ChannelPageResponse<T> = V4PaginatedResponse<T>;
 /** Channel ID parameter */
 export interface ChannelIdParam {
     /** Channel ID */
@@ -2358,6 +2541,7 @@ export type CreateLotteryActivityParams = LotteryActivityCreateParams;
 export type CreateLotteryActivityResponse = LotteryActivityCreateResponse;
 export type GetLotteryActivityParams = LotteryActivityGetParams;
 export type ListLotteryActivitiesParams = LotteryActivityListParams;
+export type ListLotteryActivitiesResponse = LotteryActivityListResponse;
 export type UpdateLotteryActivityParams = LotteryActivityUpdateParams;
 export type DeleteLotteryActivityParams = LotteryActivityDeleteParams;
 export type GroupResponse = GroupAddResponse;
@@ -2367,7 +2551,6 @@ export type GetShareParams = ShareGetParams;
 export type UpdateShareParams = ShareUpdateParams;
 export type CreateCardPushParams = CardPushCreateParams;
 export type CreateCardPushResponse = CardPushCreateResponse;
-export type GetCardPushParams = CardPushGetParams;
 export type UpdateCardPushParams = CardPushUpdateParams;
 export type DeleteCardPushParams = CardPushDeleteParams;
 export type PushCardParams = CardPushPushParams;
@@ -2382,6 +2565,7 @@ export type CreateProductTagParams = ProductTagCreateParams;
 export type CreateProductTagResponse = ProductTagCreateResponse;
 export type GetProductTagParams = ProductTagGetParams;
 export type ListProductTagsParams = ProductTagListParams;
+export type ListChannelProductTagsResponse = V4ChannelPageResponse<ProductTag>;
 export type UpdateProductTagParams = ProductTagUpdateParams;
 export type DeleteProductTagParams = ProductTagDeleteParams;
 export type GiftItem = GiftInfo;