polyv-live-api-sdk 1.0.0

package/dist/services/live-interaction.service.d.ts

@@ -0,0 +1,474 @@
+/**
+ * LiveInteraction Service
+ *
+ * 直播互动功能服务 (抽奖、问卷、签到、答题卡、点赞、打赏)
+ *
+ * @module services/live-interaction.service
+ */
+import type { PolyVClient } from '../client.js';
+import type { GetCheckinListParams, GetCheckinByCheckinIdParams, GetCheckinBySessionIdParams, GetCheckinByTimeParams, CheckinListResponse, CheckinRecordResponse, CreateQuestionnaireParams, BatchCreateQuestionnaireParams, BatchCreateQuestionnaireBody, AddEditQuestionnaireParams, AddEditQuestionnaireBody, ListQuestionnaireParams, ListQuestionnaireByPageParams, GetQuestionnaireDetailParams, GetQuestionnaireResultParams, QuestionnaireListResponse, QuestionnaireDetailResponse, QuestionnaireResultResponse, ListQuestionParams, ListQuestionSendTimeParams, AddEditQuestionParams, DeleteQuestionParams, SendQuestionParams, StopQuestionParams, SendQuestionResultParams, GetAnswerListParams, QuestionListResponse, AnswerListResponse, ListLotteryParams, ListChannelsLotteryParams, GetWinnerDetailParams, DownloadWinnerDetailParams, AddReceiveInfoParams, AddReceiveInfoV4Params, LotteryListResponse, WinnerDetailResponse, AddReceiveInfoResponse, SendFavorParams, SendFavorResponse, SendRewardMsgParams, SendRewardMsgResponse, GetQuestionListParams, QuestionListResponse2 } from '../types/live-interaction.js';
+/**
+ * LiveInteractionService
+ *
+ * 提供直播互动功能API，包括：
+ * - 签到管理
+ * - 问卷管理
+ * - 答题卡管理
+ * - 抽奖管理
+ * - 点赞、打赏等互动功能
+ */
+export declare class LiveInteractionService {
+    private readonly client;
+    constructor(client: PolyVClient);
+    /**
+     * 查询频道签到记录（仅返回已签到记录）
+     *
+     * @param params - Query parameters
+     * @returns Paginated checkin list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.getCheckinList({
+     *   channelId: '2191569',
+     *   date: '2024-01-01',
+     *   page: 1,
+     *   pageSize: 20,
+     * });
+     * ```
+     */
+    getCheckinList(params: GetCheckinListParams): Promise<CheckinListResponse>;
+    /**
+     * 通过签到id查询签到记录（包括已签到与未签到记录）
+     *
+     * @param params - Query parameters
+     * @returns Checkin record data
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.getCheckinByCheckinId({
+     *   channelId: '2191569',
+     *   checkinId: 'checkin-001',
+     * });
+     * ```
+     */
+    getCheckinByCheckinId(params: GetCheckinByCheckinIdParams): Promise<CheckinRecordResponse>;
+    /**
+     * 通过直播场次id查询签到发起记录
+     *
+     * @param params - Query parameters
+     * @returns Checkin record data
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.getCheckinBySessionId({
+     *   channelId: '2191569',
+     *   sessionId: 'session-001',
+     * });
+     * ```
+     */
+    getCheckinBySessionId(params: GetCheckinBySessionIdParams): Promise<CheckinRecordResponse>;
+    /**
+     * 通过指定时间范围查询签到发起记录
+     *
+     * @param params - Query parameters
+     * @returns Checkin record data
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.getCheckinByTime({
+     *   channelId: '2191569',
+     *   startDate: '2024-01-01',
+     *   endDate: '2024-01-31',
+     * });
+     * ```
+     */
+    getCheckinByTime(params: GetCheckinByTimeParams): Promise<CheckinRecordResponse>;
+    /**
+     * 创建问卷
+     *
+     * @param params - Create parameters
+     * @param body - Questionnaire data
+     * @returns Questionnaire detail
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.createQuestionnaire({
+     *   channelId: 2191569,
+     * });
+     * ```
+     */
+    createQuestionnaire(params: CreateQuestionnaireParams): Promise<QuestionnaireDetailResponse>;
+    /**
+     * 批量创建问卷（支持多频道同时创建）
+     *
+     * @param params - Create parameters
+     * @param body - Questionnaire data with channel IDs
+     * @returns Questionnaire detail
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.batchCreateQuestionnaire({}, {
+     *   channelIds: [2191569, 2191570],
+     *   title: '问卷调查',
+     *   items: [{ type: 'R', question: '您喜欢这个直播吗?', options: ['是', '否'] }],
+     * });
+     * ```
+     */
+    batchCreateQuestionnaire(params: BatchCreateQuestionnaireParams, body: BatchCreateQuestionnaireBody): Promise<QuestionnaireDetailResponse>;
+    /**
+     * 编辑或添加问卷信息
+     *
+     * @param params - Query parameters
+     * @param body - Questionnaire data
+     * @returns Questionnaire detail
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.addEditQuestionnaire({
+     *   channelId: '2191569',
+     * }, {
+     *   questionnaireId: 'questionnaire-001',
+     *   title: '问卷调查',
+     *   items: [{ type: 'R', question: '问题', options: ['选项1', '选项2'] }],
+     * });
+     * ```
+     */
+    addEditQuestionnaire(params: AddEditQuestionnaireParams, body: AddEditQuestionnaireBody): Promise<QuestionnaireDetailResponse>;
+    /**
+     * 获取频道的问卷列表
+     *
+     * @param params - Query parameters
+     * @returns Questionnaire list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.listQuestionnaire({
+     *   channelId: '2191569',
+     *   startTime: 1704067200000,
+     *   endTime: 1704153600000,
+     * });
+     * ```
+     */
+    listQuestionnaire(params: ListQuestionnaireParams): Promise<QuestionnaireListResponse>;
+    /**
+     * 分页查询频道问卷结果
+     *
+     * @param params - Query parameters
+     * @returns Questionnaire list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.listQuestionnaireByPage({
+     *   channelId: '2191569',
+     *   page: 1,
+     *   pageSize: 10,
+     * });
+     * ```
+     */
+    listQuestionnaireByPage(params: ListQuestionnaireByPageParams): Promise<QuestionnaireListResponse>;
+    /**
+     * 查询频道问卷题目与结果
+     *
+     * @param params - Query parameters
+     * @returns Questionnaire detail
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.getQuestionnaireDetail({
+     *   channelId: '2191569',
+     *   questionnaireId: 'questionnaire-001',
+     * });
+     * ```
+     */
+    getQuestionnaireDetail(params: GetQuestionnaireDetailParams): Promise<QuestionnaireDetailResponse>;
+    /**
+     * 查询直播问卷的答题结果及统计
+     *
+     * @param params - Query parameters
+     * @returns Questionnaire result
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.getQuestionnaireResult({
+     *   channelId: '2191569',
+     *   questionnaireId: 'questionnaire-001',
+     * });
+     * ```
+     */
+    getQuestionnaireResult(params: GetQuestionnaireResultParams): Promise<QuestionnaireResultResponse>;
+    /**
+     * 获取频道的答题卡列表
+     *
+     * @param params - Query parameters
+     * @returns Question list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.listQuestion({
+     *   channelId: '2191569',
+     * });
+     * ```
+     */
+    listQuestion(params: ListQuestionParams): Promise<QuestionListResponse>;
+    /**
+     * 获取频道的答题卡发送时间列表
+     *
+     * @param params - Query parameters
+     * @returns Question send time list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.listQuestionSendTime({
+     *   channelId: '2191569',
+     * });
+     * ```
+     */
+    listQuestionSendTime(params: ListQuestionSendTimeParams): Promise<QuestionListResponse>;
+    /**
+     * 编辑或添加答题卡信息
+     *
+     * @param params - Query parameters
+     * @returns Success response
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.addEditQuestion({
+     *   channelId: '2191569',
+     *   _type: 'R',
+     *   answer: 'A',
+     *   name: '单选题',
+     *   itemType: 0,
+     *   option1_option15: 'A,B,C,D',
+     * });
+     * ```
+     */
+    addEditQuestion(params: AddEditQuestionParams): Promise<QuestionListResponse>;
+    /**
+     * 删除频道答题卡信息
+     *
+     * @param params - Delete parameters
+     * @returns Success response
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.deleteQuestion({
+     *   channelId: '2191569',
+     *   questionId: 'question-001',
+     * });
+     * ```
+     */
+    deleteQuestion(params: DeleteQuestionParams): Promise<QuestionListResponse>;
+    /**
+     * 发送答题卡
+     *
+     * @param params - Send parameters
+     * @returns Success response
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.sendQuestion({
+     *   channelId: 2191569,
+     *   questionId: 'question-001',
+     *   duration: 30,
+     * });
+     * ```
+     */
+    sendQuestion(params: SendQuestionParams): Promise<QuestionListResponse>;
+    /**
+     * 停止答题卡
+     *
+     * @param params - Stop parameters
+     * @returns Success response
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.stopQuestion({
+     *   channelId: 2191569,
+     *   questionId: 'question-001',
+     * });
+     * ```
+     */
+    stopQuestion(params: StopQuestionParams): Promise<QuestionListResponse>;
+    /**
+     * 发送答题卡结果
+     *
+     * @param params - Send parameters
+     * @returns Success response
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.sendQuestionResult({
+     *   channelId: 2191569,
+     *   questionId: 'question-001',
+     * });
+     * ```
+     */
+    sendQuestionResult(params: SendQuestionResultParams): Promise<QuestionListResponse>;
+    /**
+     * 查询答题卡答题结果列表
+     *
+     * @param params - Query parameters
+     * @returns Answer list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.getAnswerList({
+     *   channelId: '2191569',
+     *   sessionId: 'session-001',
+     * });
+     * ```
+     */
+    getAnswerList(params: GetAnswerListParams): Promise<AnswerListResponse>;
+    /**
+     * 获取一段时间内的直播频道抽奖记录列表
+     *
+     * @param params - Query parameters
+     * @returns Lottery list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.listLottery({
+     *   channelId: '2191569',
+     *   startTime: 1704067200000,
+     *   endTime: 1704153600000,
+     * });
+     * ```
+     */
+    listLottery(params: ListLotteryParams): Promise<LotteryListResponse>;
+    /**
+     * 获取一段时间内的多个直播频道发起抽奖记录列表
+     *
+     * @param params - Query parameters
+     * @returns Lottery list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.listChannelsLottery({
+     *   channelIds: '2191569,2191570',
+     *   startTime: 1704067200000,
+     *   endTime: 1704153600000,
+     * });
+     * ```
+     */
+    listChannelsLottery(params: ListChannelsLotteryParams): Promise<LotteryListResponse>;
+    /**
+     * 通过抽奖ID获取频道的单场抽奖的中奖用户列表
+     *
+     * @param params - Query parameters
+     * @returns Winner detail list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.getWinnerDetail({
+     *   channelId: '2191569',
+     *   lotteryId: 'lottery-001',
+     *   page: 1,
+     *   limit: 10,
+     * });
+     * ```
+     */
+    getWinnerDetail(params: GetWinnerDetailParams): Promise<WinnerDetailResponse>;
+    /**
+     * 导出频道的单抽奖的中奖用户列表的中奖文件
+     *
+     * @param params - Query parameters
+     * @returns File download URL or data
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.downloadWinnerDetail({
+     *   channelId: '2191569',
+     *   lotteryId: 'lottery-001',
+     * });
+     * ```
+     */
+    downloadWinnerDetail(params: DownloadWinnerDetailParams): Promise<unknown>;
+    /**
+     * 提交中奖者填写的信息
+     *
+     * @param params - Receive info parameters
+     * @returns Success response
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.addReceiveInfo({
+     *   channelId: '2191569',
+     *   lotteryId: 'lottery-001',
+     *   winnerCode: 'WIN001',
+     *   viewerId: 'viewer-001',
+     *   name: '张三',
+     *   telephone: '13800138000',
+     * });
+     * ```
+     */
+    addReceiveInfo(params: AddReceiveInfoParams): Promise<AddReceiveInfoResponse>;
+    /**
+     * 提交中奖者填写的信息 (V4版本)
+     *
+     * @param params - Receive info parameters
+     * @returns Success response
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.addReceiveInfoV4({
+     *   channelId: '2191569',
+     *   lotteryId: 'lottery-001',
+     *   winnerCode: 'WIN001',
+     *   viewerId: 'viewer-001',
+     *   receiveInfo: [{ field: '姓名', value: '张三' }],
+     * });
+     * ```
+     */
+    addReceiveInfoV4(params: AddReceiveInfoV4Params): Promise<AddReceiveInfoResponse>;
+    /**
+     * 点赞
+     *
+     * @param params - Favor parameters
+     * @returns Like count
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.sendFavor({
+     *   viewerId: 'viewer-001',
+     *   times: 1,
+     * });
+     * ```
+     */
+    sendFavor(params: SendFavorParams): Promise<SendFavorResponse>;
+    /**
+     * 发送打赏消息
+     *
+     * @param params - Reward parameters
+     * @returns Success response
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.sendRewardMsg({
+     *   channelId: '2191569',
+     *   nickname: '张三',
+     *   avatar: 'https://example.com/avatar.png',
+     *   viewerId: 'viewer-001',
+     *   donateType: 'cash',
+     *   content: '100',
+     * });
+     * ```
+     */
+    sendRewardMsg(params: SendRewardMsgParams): Promise<SendRewardMsgResponse>;
+    /**
+     * 查询咨询提问记录
+     *
+     * @param channelId - Channel ID
+     * @param params - Query parameters
+     * @returns Question list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.liveInteraction.getQuestionList('2191569', {
+     *   begin: 0,
+     *   end: 100,
+     * });
+     * ```
+     */
+    getQuestionList(channelId: string, params?: GetQuestionListParams): Promise<QuestionListResponse2>;
+}
+//# sourceMappingURL=live-interaction.service.d.ts.map

package/dist/services/live-interaction.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"live-interaction.service.d.ts","sourceRoot":"","sources":["../../src/services/live-interaction.service.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,KAAK,EAEV,oBAAoB,EACpB,2BAA2B,EAC3B,2BAA2B,EAC3B,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EAErB,yBAAyB,EACzB,8BAA8B,EAC9B,4BAA4B,EAC5B,0BAA0B,EAC1B,wBAAwB,EACxB,uBAAuB,EACvB,6BAA6B,EAC7B,4BAA4B,EAC5B,4BAA4B,EAC5B,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,EAE3B,kBAAkB,EAClB,0BAA0B,EAC1B,qBAAqB,EACrB,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAClB,wBAAwB,EACxB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAElB,iBAAiB,EACjB,yBAAyB,EACzB,qBAAqB,EACrB,0BAA0B,EAC1B,oBAAoB,EACpB,sBAAsB,EACtB,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EAEtB,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,8BAA8B,CAAC;AAEtC;;;;;;;;;GASG;AACH,qBAAa,sBAAsB;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,WAAW;IAMhD;;;;;;;;;;;;;;;OAeG;IACG,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAQhF;;;;;;;;;;;;;OAaG;IACG,qBAAqB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAQhG;;;;;;;;;;;;;OAaG;IACG,qBAAqB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAQhG;;;;;;;;;;;;;;OAcG;IACG,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAYtF;;;;;;;;;;;;;OAaG;IACG,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,2BAA2B,CAAC;IASlG;;;;;;;;;;;;;;;OAeG;IACG,wBAAwB,CAC5B,MAAM,EAAE,8BAA8B,EACtC,IAAI,EAAE,4BAA4B,GACjC,OAAO,CAAC,2BAA2B,CAAC;IASvC;;;;;;;;;;;;;;;;;OAiBG;IACG,oBAAoB,CACxB,MAAM,EAAE,0BAA0B,EAClC,IAAI,EAAE,wBAAwB,GAC7B,OAAO,CAAC,2BAA2B,CAAC;IASvC;;;;;;;;;;;;;;OAcG;IACG,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAQ5F;;;;;;;;;;;;;;OAcG;IACG,uBAAuB,CAAC,MAAM,EAAE,6BAA6B,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAQxG;;;;;;;;;;;;;OAaG;IACG,sBAAsB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAQxG;;;;;;;;;;;;;OAaG;IACG,sBAAsB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAYxG;;;;;;;;;;;;OAYG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAQ7E;;;;;;;;;;;;OAYG;IACG,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAQ7F;;;;;;;;;;;;;;;;;OAiBG;IACG,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IASnF;;;;;;;;;;;;;OAaG;IACG,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IASjF;;;;;;;;;;;;;;OAcG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAS7E;;;;;;;;;;;;;OAaG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAS7E;;;;;;;;;;;;;OAaG;IACG,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IASzF;;;;;;;;;;;;;OAaG;IACG,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAY7E;;;;;;;;;;;;;;OAcG;IACG,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAQ1E;;;;;;;;;;;;;;OAcG;IACG,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAQ1F;;;;;;;;;;;;;;;OAeG;IACG,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAQnF;;;;;;;;;;;;;OAaG;IACG,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,OAAO,CAAC;IAQhF;;;;;;;;;;;;;;;;;OAiBG;IACG,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IASnF;;;;;;;;;;;;;;;;OAgBG;IACG,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAavF;;;;;;;;;;;;;OAaG;IACG,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IASpE;;;;;;;;;;;;;;;;;OAiBG;IACG,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAShF;;;;;;;;;;;;;;OAcG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAOzG"}