polyv-live-api-sdk 1.0.0

package/dist/services/web.service.d.ts

@@ -0,0 +1,758 @@
+/**
+ * Web Service
+ *
+ * Service for managing PolyV web page-related operations.
+ * Provides methods for web info, menu management, and more.
+ *
+ * @module services/web
+ */
+import type { PolyVClient } from '../client.js';
+import type { GetSplashResponse, SetSplashParams, SetPublisherParams, UpdateChannelNameParams, UpdateChannelLogoParams, UpdateLikesParams, LiveLikesResponse, GetCountdownResponse, SetCountdownParams, GetMenuListParams, GetMenuListResponse, AddMenuParams, AddMenuResponse, DeleteMenuParams, UpdateMenuParams, SetMenuParams, UpdateRankParams, UpdateConsultingEnabledParams, GetTuwenListParams, GetTuwenListResponse, GetDonateResponse, GetWeixinShareResponse, UpdateCashParams, UpdateGoodParams, UpdateWeixinShareParams, UpdateGlobalEnabledParams, UploadImageParams, UploadImageResponse, WatchConditionResponse, GetWatchConditionParams, SetWatchConditionParams, SetAuthTypeParams, GetWhiteListParams, GetWhiteListResponse, AddWhiteListParams, UpdateWhiteListParams, DeleteWhiteListParams, UploadWhiteListParams, DownloadWhiteListParams, SetExternalAuthParams, SetCustomAuthParams, SetDirectAuthParams, DirectAuthParams, DirectAuthResponse, GetRecordFieldParams, RecordFieldResponse, GetRecordInfoParams, RecordInfoResponse, EnrollListParams, EnrollListResponse, DownloadRecordInfoParams, UpdateAuthUrlParams, SetAuthorizedAddressParams, CustomAuthInfoResponse, PolyvUrlResponse } from '../types/web.js';
+/**
+ * WebService
+ *
+ * Provides methods to interact with PolyV Live Web APIs.
+ *
+ * @example
+ * ```typescript
+ * const client = new PolyVClient({ appId: 'xxx', appSecret: 'yyy' });
+ * const splash = await client.web.getSplash('123456');
+ * ```
+ */
+export declare class WebService {
+    private client;
+    /**
+     * Create a new WebService instance
+     *
+     * @param client - The PolyVClient instance to use for API calls
+     */
+    constructor(client: PolyVClient);
+    /**
+     * Get splash screen settings
+     * Query splash screen status and image URL for a channel
+     *
+     * @param channelId - Channel ID
+     * @returns Splash screen settings
+     *
+     * @example
+     * ```typescript
+     * const splash = await client.web.getSplash('123456');
+     * console.log(splash.splashEnabled, splash.splashImg);
+     * ```
+     */
+    getSplash(channelId: string): Promise<GetSplashResponse>;
+    /**
+     * Set splash screen settings
+     * Configure splash screen on/off and optionally upload an image
+     *
+     * @param params - Set splash parameters
+     * @returns Image URL if uploaded, or "success"
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.setSplash({
+     *   channelId: '123456',
+     *   splashEnabled: 'Y',
+     * });
+     * ```
+     */
+    setSplash(params: SetSplashParams): Promise<string>;
+    /**
+     * Set publisher name
+     * Set the publisher/host name for a channel or all channels
+     *
+     * @param params - Set publisher parameters
+     * @returns Channel ID on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.setPublisher({
+     *   userId: 'user123',
+     *   publisher: 'John Doe',
+     *   channelId: '123456',
+     * });
+     * ```
+     */
+    setPublisher(params: SetPublisherParams): Promise<string>;
+    /**
+     * Update channel name
+     * Change the name of a channel
+     *
+     * @param params - Update parameters
+     * @returns true on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.updateChannelName({
+     *   channelId: '123456',
+     *   name: 'New Channel Name',
+     * });
+     * ```
+     */
+    updateChannelName(params: UpdateChannelNameParams): Promise<boolean>;
+    /**
+     * Update channel logo
+     * Upload a new logo image for a channel
+     *
+     * @param params - Update parameters including image file
+     * @returns Image URL on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.updateChannelLogo({
+     *   channelId: '123456',
+     *   imgfile: imageFile,
+     * });
+     * ```
+     */
+    updateChannelLogo(params: UpdateChannelLogoParams): Promise<string>;
+    /**
+     * Get live likes for channels
+     * Query likes and viewers count for one or more channels
+     *
+     * @param channelIds - Comma-separated channel IDs (max 20)
+     * @returns Array of channel likes info
+     *
+     * @example
+     * ```typescript
+     * const likes = await client.web.liveLikes('123456,789012');
+     * console.log(likes[0].likes, likes[0].viewers);
+     * ```
+     */
+    liveLikes(channelIds: string): Promise<LiveLikesResponse>;
+    /**
+     * Update likes and viewers count
+     * Modify the likes and/or viewers count for a channel
+     *
+     * @param params - Update parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.updateLikes({
+     *   channelId: '123456',
+     *   likes: 99999,
+     *   viewers: 1000000,
+     * });
+     * ```
+     */
+    updateLikes(params: UpdateLikesParams): Promise<string>;
+    /**
+     * Get countdown settings
+     * Query countdown configuration for a channel
+     *
+     * @param channelId - Channel ID
+     * @returns Countdown settings
+     *
+     * @example
+     * ```typescript
+     * const countdown = await client.web.getCountdown('123456');
+     * console.log(countdown.startTime, countdown.bookingEnabled);
+     * ```
+     */
+    getCountdown(channelId: string): Promise<GetCountdownResponse>;
+    /**
+     * Set countdown settings
+     * Configure countdown and booking settings for a channel
+     *
+     * @param params - Set countdown parameters
+     * @returns Empty string on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.setCountdown({
+     *   channelId: '123456',
+     *   bookingEnabled: 'Y',
+     *   startTime: '2024-03-15 15:00:00',
+     * });
+     * ```
+     */
+    setCountdown(params: SetCountdownParams): Promise<string>;
+    /**
+     * Get menu list for a channel
+     * Query all menus for a channel
+     *
+     * @param params - Query parameters
+     * @returns Array of menu items
+     *
+     * @example
+     * ```typescript
+     * const menus = await client.web.getMenuList({ channelId: '123456' });
+     * console.log(menus);
+     * ```
+     */
+    getMenuList(params: GetMenuListParams): Promise<GetMenuListResponse>;
+    /**
+     * Add a new menu
+     * Create a new menu for a channel
+     *
+     * @param params - Add menu parameters
+     * @returns Created menu details
+     *
+     * @example
+     * ```typescript
+     * const menu = await client.web.addMenu({
+     *   channelId: '123456',
+     *   name: 'My Menu',
+     *   type: 'text',
+     *   content: 'Menu content',
+     * });
+     * ```
+     */
+    addMenu(params: AddMenuParams): Promise<AddMenuResponse>;
+    /**
+     * Delete menus
+     * Remove one or more menus from a channel
+     *
+     * @param params - Delete parameters
+     * @returns 1 on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.deleteMenu({ menuIds: 'menu1,menu2' });
+     * ```
+     */
+    deleteMenu(params: DeleteMenuParams): Promise<number>;
+    /**
+     * Update menu content
+     * Modify the content of an existing menu
+     *
+     * @param params - Update parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.updateMenu({
+     *   menuId: 'menu123',
+     *   content: 'Updated content',
+     * });
+     * ```
+     */
+    updateMenu(params: UpdateMenuParams): Promise<string>;
+    /**
+     * Set menu (live introduction)
+     * Set the live introduction menu content
+     *
+     * @param params - Set menu parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.setMenu({
+     *   userId: 'user123',
+     *   channelId: '123456',
+     *   menuType: 'desc',
+     *   content: '<p>Introduction content</p>',
+     * });
+     * ```
+     */
+    setMenu(params: SetMenuParams): Promise<string>;
+    /**
+     * Update menu rank (order)
+     * Reorder menus by specifying their order
+     *
+     * @param params - Update rank parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.updateRank({
+     *   channelId: '123456',
+     *   menuIds: 'menu1,menu2,menu3',
+     * });
+     * ```
+     */
+    updateRank(params: UpdateRankParams): Promise<string>;
+    /**
+     * Update consulting enabled
+     * Toggle the consulting/quiz feature on/off
+     *
+     * @param params - Update parameters
+     * @returns Empty string on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.updateConsultingEnabled({
+     *   channelId: '123456',
+     *   enabled: 'Y',
+     * });
+     * ```
+     */
+    updateConsultingEnabled(params: UpdateConsultingEnabledParams): Promise<string>;
+    /**
+     * Get tuwen (image-text) list
+     * Query image-text content for a channel
+     *
+     * @param params - Query parameters
+     * @returns Tuwen content list with pagination
+     *
+     * @example
+     * ```typescript
+     * const tuwen = await client.web.getTuwenList({
+     *   channelId: '123456',
+     * });
+     * console.log(tuwen.contents);
+     * ```
+     */
+    getTuwenList(params: GetTuwenListParams): Promise<GetTuwenListResponse>;
+    /**
+     * Get donate settings
+     * Query channel donation settings
+     *
+     * @param channelId - Channel ID (optional, omit for global settings)
+     * @returns Donate settings
+     *
+     * @example
+     * ```typescript
+     * // Get channel donate settings
+     * const donate = await client.web.getDonate('123456');
+     * // Get global donate settings
+     * const globalDonate = await client.web.getDonate();
+     * ```
+     */
+    getDonate(channelId?: string): Promise<GetDonateResponse>;
+    /**
+     * Get weixin share settings
+     * Query channel WeChat share information
+     *
+     * @param channelId - Channel ID (required)
+     * @returns WeChat share settings
+     *
+     * @example
+     * ```typescript
+     * const share = await client.web.getWeixinShare('123456');
+     * console.log(share.weixinShareTitle, share.weixinShareDesc);
+     * ```
+     */
+    getWeixinShare(channelId: string): Promise<GetWeixinShareResponse>;
+    /**
+     * Update cash donation settings
+     * Configure cash donation options for a channel
+     *
+     * @param params - Update cash parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.updateCash({
+     *   channelId: '123456',
+     *   cashes: [1, 2, 5, 10, 50, 100],
+     *   cashMin: 1,
+     *   enabled: 'Y',
+     * });
+     * ```
+     */
+    updateCash(params: UpdateCashParams): Promise<string>;
+    /**
+     * Update goods donation settings
+     * Configure goods/gifts donation options for a channel
+     *
+     * @param params - Update good parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.updateGood({
+     *   channelId: '123456',
+     *   goods: [
+     *     { goodName: 'Rose', goodImg: 'http://...', goodPrice: 10, goodEnabled: 'Y' },
+     *   ],
+     *   enabled: 'Y',
+     * });
+     * ```
+     */
+    updateGood(params: UpdateGoodParams): Promise<string>;
+    /**
+     * Update weixin share settings
+     * Configure WeChat share title and description for a channel
+     *
+     * @param params - Update weixin share parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.updateWeixinShare({
+     *   channelId: '123456',
+     *   weixinShareTitle: 'My Live Stream',
+     *   weixinShareDesc: 'Join my live stream!',
+     * });
+     * ```
+     */
+    updateWeixinShare(params: UpdateWeixinShareParams): Promise<string>;
+    /**
+     * Update global enabled setting
+     * Enable or disable a global setting type for a channel
+     *
+     * @param params - Update global enabled parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * // Enable donation setting for channel
+     * await client.web.updateGlobalEnabled({
+     *   channelId: '123456',
+     *   globalEnabledType: 'donate',
+     *   enabled: 'Y',
+     * });
+     * ```
+     */
+    updateGlobalEnabled(params: UpdateGlobalEnabledParams): Promise<string>;
+    /**
+     * Upload image
+     * Upload channel decoration images
+     *
+     * @param params - Upload image parameters
+     * @returns Array of uploaded image URLs
+     *
+     * @example
+     * ```typescript
+     * const urls = await client.web.uploadImage({
+     *   type: 'coverImage',
+     *   files: [imageFile],
+     * });
+     * console.log(urls[0]); // First uploaded image URL
+     * ```
+     */
+    uploadImage(params: UploadImageParams): Promise<UploadImageResponse>;
+    /**
+     * Validate channel ID
+     */
+    private validateChannelId;
+    /**
+     * Get watch condition
+     * Query channel watch condition settings
+     *
+     * @param params - Get watch condition parameters
+     * @returns Watch condition settings
+     *
+     * @example
+     * ```typescript
+     * // Get channel watch condition
+     * const condition = await client.web.getWatchCondition({ channelId: '123456' });
+     * // Get global watch condition
+     * const globalCondition = await client.web.getWatchCondition({});
+     * ```
+     */
+    getWatchCondition(params: GetWatchConditionParams): Promise<WatchConditionResponse>;
+    /**
+     * Set watch condition
+     * Update channel watch condition settings
+     *
+     * @param params - Set watch condition parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.setWatchCondition({
+     *   channelId: '123456',
+     *   authSettings: [
+     *     { rank: 1, enabled: 'Y', authType: 'code', code: '123456' },
+     *   ],
+     * });
+     * ```
+     */
+    setWatchCondition(params: SetWatchConditionParams): Promise<string>;
+    /**
+     * Set auth type (simple version)
+     * Set channel authentication type
+     *
+     * @param params - Set auth type parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.setAuthType({
+     *   channelId: '123456',
+     *   authType: 'none',
+     * });
+     * ```
+     */
+    setAuthType(params: SetAuthTypeParams): Promise<string>;
+    /**
+     * Get white list
+     * Query channel white list with pagination
+     *
+     * @param params - Get white list parameters
+     * @returns Paginated white list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.getWhiteList({
+     *   rank: 1,
+     *   channelId: '123456',
+     *   page: 1,
+     *   pageSize: 10,
+     * });
+     * ```
+     */
+    getWhiteList(params: GetWhiteListParams): Promise<GetWhiteListResponse>;
+    /**
+     * Add white list item
+     * Add a single item to channel white list
+     *
+     * @param params - Add white list parameters
+     * @returns "success" or "true" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.addWhiteList({
+     *   rank: 1,
+     *   code: '13800138000',
+     *   name: 'John Doe',
+     *   channelId: '123456',
+     * });
+     * ```
+     */
+    addWhiteList(params: AddWhiteListParams): Promise<string>;
+    /**
+     * Update white list item
+     * Update a single item in channel white list
+     *
+     * @param params - Update white list parameters
+     * @returns "success" or "true" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.updateWhiteList({
+     *   rank: 1,
+     *   code: '13800138000',
+     *   name: 'Updated Name',
+     *   channelId: '123456',
+     * });
+     * ```
+     */
+    updateWhiteList(params: UpdateWhiteListParams): Promise<string>;
+    /**
+     * Delete white list items
+     * Delete one or more items from channel white list
+     *
+     * @param params - Delete white list parameters
+     * @returns "success" or "true" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.deleteWhiteList({
+     *   rank: 1,
+     *   codes: '13800138000,13800138001',
+     *   channelId: '123456',
+     * });
+     * ```
+     */
+    deleteWhiteList(params: DeleteWhiteListParams): Promise<string>;
+    /**
+     * Upload white list
+     * Batch upload white list from Excel file
+     *
+     * @param params - Upload white list parameters
+     * @returns "true" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.uploadWhiteList({
+     *   rank: 1,
+     *   file: excelFile,
+     *   channelId: '123456',
+     * });
+     * ```
+     */
+    uploadWhiteList(params: UploadWhiteListParams): Promise<string>;
+    /**
+     * Download white list template
+     * Download the white list Excel template
+     *
+     * @param params - Download white list parameters
+     * @returns File stream (binary data)
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.downloadWhiteList({
+     *   rank: 1,
+     *   channelId: '123456',
+     * });
+     * ```
+     */
+    downloadWhiteList(params: DownloadWhiteListParams): Promise<unknown>;
+    /**
+     * Set external auth
+     * Configure external authorization settings
+     *
+     * @param params - Set external auth parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.setExternalAuth({
+     *   channelId: '123456',
+     *   externalKey: 'your-key',
+     *   externalUri: 'https://your-auth-server.com/auth',
+     * });
+     * ```
+     */
+    setExternalAuth(params: SetExternalAuthParams): Promise<string>;
+    /**
+     * Set custom auth
+     * Configure custom authorization settings
+     *
+     * @param params - Set custom auth parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.setCustomAuth({
+     *   channelId: '123456',
+     *   customKey: 'your-key',
+     *   customUri: 'https://your-auth-server.com/custom',
+     * });
+     * ```
+     */
+    setCustomAuth(params: SetCustomAuthParams): Promise<string>;
+    /**
+     * Set direct auth
+     * Configure direct authorization settings
+     *
+     * @param params - Set direct auth parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.setDirectAuth({
+     *   channelId: '123456',
+     *   directKey: 'your-direct-key',
+     * });
+     * ```
+     */
+    setDirectAuth(params: SetDirectAuthParams): Promise<string>;
+    /**
+     * Get direct auth
+     * Query direct authorization settings
+     *
+     * @param params - Direct auth parameters
+     * @returns Direct auth settings
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.directAuth({ channelId: '123456' });
+     * console.log(result.directKey);
+     * ```
+     */
+    directAuth(params: DirectAuthParams): Promise<DirectAuthResponse>;
+    /**
+     * Get record field
+     * Query registration watching field settings
+     *
+     * @param params - Get record field parameters
+     * @returns Record field settings
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.getRecordField({ channelId: '123456' });
+     * console.log(result.infoFields);
+     * ```
+     */
+    getRecordField(params: GetRecordFieldParams): Promise<RecordFieldResponse>;
+    /**
+     * Get record info
+     * Query registration watching information
+     *
+     * @param params - Get record info parameters
+     * @returns Record info list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.getRecordInfo({ channelId: '123456' });
+     * console.log(result.contents);
+     * ```
+     */
+    getRecordInfo(params: GetRecordInfoParams): Promise<RecordInfoResponse>;
+    /**
+     * Get enroll list
+     * Query enrollment/registration list
+     *
+     * @param params - Enroll list parameters
+     * @returns Enroll list with pagination
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.enrollList({
+     *   channelId: '123456',
+     *   page: 1,
+     *   pageSize: 10,
+     * });
+     * ```
+     */
+    enrollList(params: EnrollListParams): Promise<EnrollListResponse>;
+    /**
+     * Download record info
+     * Download registration watching information as file
+     *
+     * @param params - Download record info parameters
+     * @returns File stream (binary data)
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.downloadRecordInfo({ channelId: '123456' });
+     * ```
+     */
+    downloadRecordInfo(params: DownloadRecordInfoParams): Promise<unknown>;
+    /**
+     * Update auth URL
+     * Update authorization redirect URL
+     *
+     * @param params - Update auth URL parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.updateAuthUrl({
+     *   channelId: '123456',
+     *   authUrl: 'https://example.com/auth-callback',
+     * });
+     * ```
+     */
+    updateAuthUrl(params: UpdateAuthUrlParams): Promise<string>;
+    /**
+     * Set authorized address
+     * Configure authorized IP addresses
+     *
+     * @param params - Set authorized address parameters
+     * @returns "success" on success
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.setAuthorizedAddress({
+     *   channelId: '123456',
+     *   authAddresses: '192.168.1.1,192.168.1.2',
+     * });
+     * ```
+     */
+    setAuthorizedAddress(params: SetAuthorizedAddressParams): Promise<string>;
+    /**
+     * Get custom auth info (customauth2)
+     * Query custom authorization information
+     *
+     * @param channelId - Channel ID (required)
+     * @returns Custom auth info
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.customauth2('123456');
+     * console.log(result.customKey, result.customUri);
+     * ```
+     */
+    customauth2(channelId: string): Promise<CustomAuthInfoResponse>;
+    /**
+     * Get PolyV URL
+     * Get PolyV authorization URL
+     *
+     * @param channelId - Channel ID (required)
+     * @returns PolyV auth URL
+     *
+     * @example
+     * ```typescript
+     * const result = await client.web.polyvUrl('123456');
+     * console.log(result.url);
+     * ```
+     */
+    polyvUrl(channelId: string): Promise<PolyvUrlResponse>;
+}
+//# sourceMappingURL=web.service.d.ts.map