polyv-live-api-sdk 1.0.3 → 1.0.8

package/README.md

@@ -0,0 +1,186 @@
+# PolyV Live API SDK
+
+TypeScript/Node.js SDK for PolyV Live Streaming API.
+
+## Installation
+
+```bash
+npm install polyv-live-api-sdk
+# or
+pnpm add polyv-live-api-sdk
+# or
+yarn add polyv-live-api-sdk
+```
+
+## Quick Start
+
+```typescript
+import { PolyVClient } from 'polyv-live-api-sdk';
+
+const client = new PolyVClient({
+  appId: 'your-app-id',
+  appSecret: 'your-app-secret'
+});
+
+// List channels
+const channels = await client.channel.listChannels({ pageNumber: 1, pageSize: 10 });
+
+// Get channel details
+const channel = await client.channel.getChannel({ channelId: 'your-channel-id' });
+```
+
+## Features
+
+- Full TypeScript support with type definitions
+- Automatic API signature generation
+- Promise-based API
+- Comprehensive error handling
+- Support for both V3 and V4 APIs
+
+## Services
+
+### V3 Services
+
+| Service | Description |
+|---------|-------------|
+| `channel` | Channel management (CRUD, settings, streams) |
+| `chat` | Chat operations (messages, bans, kicks) |
+| `account` | Account operations |
+| `group` | Group management |
+| `platform` | Platform operations |
+| `finance` | Financial operations |
+| `web` | Web settings |
+| `player` | Player configuration |
+| `liveInteraction` | Live interactions (check-in, lottery, Q&A) |
+| `statistics` | Statistics and reports |
+
+### V4 Services
+
+| Service | Description |
+|---------|-------------|
+| `v4Platform` | Coupon management |
+| `v4Channel` | V4 channel APIs |
+| `v4Chat` | V4 chat APIs |
+| `v4User` | User management |
+| `v4Group` | V4 group APIs |
+| `v4AI` | AI features |
+| `v4Robot` | Robot features |
+| `v4Material` | Materials management |
+| `v4Statistics` | V4 statistics |
+| `v4WebApp` | WebApp settings |
+| `v4Global` | Global settings |
+
+## Usage Examples
+
+### Channel Management
+
+```typescript
+// Create a channel
+const newChannel = await client.channel.createChannel({
+  name: 'My Live Channel',
+  channelPass: 'password123'
+});
+
+// List channels with pagination
+const result = await client.channel.listChannels({
+  pageNumber: 1,
+  pageSize: 20
+});
+
+// Update channel
+await client.channel.updateChannel({
+  channelId: 'xxx',
+  name: 'Updated Name'
+});
+```
+
+### Coupon Operations (V4)
+
+```typescript
+// Create a coupon
+const couponId = await client.v4Platform.createCoupon({
+  name: 'Discount Coupon',
+  discount: 100,
+  total: 1000
+});
+
+// Search coupons
+const coupons = await client.v4Platform.searchCoupons({
+  pageNumber: 1,
+  pageSize: 10
+});
+```
+
+### Product Management
+
+```typescript
+// Get product list
+const products = await client.channel.getProductList({
+  channelId: 'your-channel-id'
+});
+
+// Add product
+const product = await client.channel.addProduct({
+  channelId: 'your-channel-id',
+  name: 'Product Name',
+  price: '99.00'
+});
+```
+
+### Statistics
+
+```typescript
+// Get channel statistics
+const stats = await client.statistics.getChannelStats({
+  channelId: 'your-channel-id',
+  startDate: '2024-01-01',
+  endDate: '2024-01-31'
+});
+```
+
+### Error Handling
+
+```typescript
+import { PolyVAPIError, PolyVErrorCode } from 'polyv-live-api-sdk';
+
+try {
+  await client.channel.getChannel({ channelId: 'invalid-id' });
+} catch (error) {
+  if (error instanceof PolyVAPIError) {
+    console.log('Error code:', error.code);
+    console.log('Error message:', error.message);
+  }
+}
+```
+
+## Pagination Utilities
+
+```typescript
+import { paginate, collectAll } from 'polyv-live-api-sdk';
+
+// Auto-paginate through all results
+const allChannels = await collectAll(
+  (page) => client.channel.listChannels({ pageNumber: page, pageSize: 100 }),
+  (response) => response.contents
+);
+```
+
+## Configuration Options
+
+```typescript
+const client = new PolyVClient({
+  appId: 'your-app-id',
+  appSecret: 'your-app-secret',
+  userId: 'your-user-id',        // Optional
+  timeout: 30000,                 // Request timeout in ms (default: 30000)
+  baseURL: 'https://api.polyv.net' // Custom base URL (optional)
+});
+```
+
+## Requirements
+
+- Node.js >= 18.0.0
+
+## License
+
+MIT

package/dist/index.cjs

@@ -5292,6 +5292,9 @@ var LiveInteractionService = class {
    * ```
    */
   async getCheckinList(params) {
+    if (!params.channelId) {
+      throw new Error("channelId is required");
+    }
     const response = await this.client.httpClient.get(
       "/live/v2/chat/getCheckinList",
       { params }
@@ -7626,7 +7629,8 @@ var WebService = class {
    * ```typescript
    * const result = await client.web.updateWhiteList({
    *   rank: 1,
-   *   code: '13800138000',
+   *   oldCode: '13800138000',
+   *   code: '13900139000',
    *   name: 'Updated Name',
    *   channelId: '123456',
    * });
@@ -7636,6 +7640,9 @@ var WebService = class {
     if (params.rank !== 1 && params.rank !== 2) {
       throw new PolyVValidationError("rank must be 1 or 2");
     }
+    if (!params.oldCode || params.oldCode.trim() === "") {
+      throw new PolyVValidationError("oldCode is required");
+    }
     if (!params.code || params.code.trim() === "") {
       throw new PolyVValidationError("code is required");
     }
@@ -7647,6 +7654,7 @@ var WebService = class {
     }
     const apiParams = {
       rank: params.rank,
+      oldCode: params.oldCode,
       code: params.code
     };
     if (params.name) {
@@ -7671,24 +7679,39 @@ var WebService = class {
    *
    * @example
    * ```typescript
+   * // Delete specific codes
    * const result = await client.web.deleteWhiteList({
    *   rank: 1,
+   *   isClear: 'N',
    *   codes: '13800138000,13800138001',
    *   channelId: '123456',
    * });
+   *
+   * // Clear all
+   * const result = await client.web.deleteWhiteList({
+   *   rank: 1,
+   *   isClear: 'Y',
+   *   channelId: '123456',
+   * });
    * ```
    */
   async deleteWhiteList(params) {
     if (params.rank !== 1 && params.rank !== 2) {
       throw new PolyVValidationError("rank must be 1 or 2");
     }
-    if (!params.codes || params.codes.trim() === "") {
-      throw new PolyVValidationError("codes is required");
+    if (!params.isClear) {
+      throw new PolyVValidationError("isClear is required");
+    }
+    if (params.isClear === "N" && (!params.codes || params.codes.trim() === "")) {
+      throw new PolyVValidationError("codes is required when isClear=N");
     }
     const apiParams = {
       rank: params.rank,
-      codes: params.codes
+      isClear: params.isClear
     };
+    if (params.codes) {
+      apiParams.code = params.codes;
+    }
     if (params.channelId) {
       apiParams.channelId = params.channelId;
     }
@@ -13126,7 +13149,7 @@ var V4UserService = class {
    */
   async listViewerLabels() {
     const response = await this.client.httpClient.get(
-      "/live/v4/user/viewer-record/label/list",
+      "/live/v4/user/viewer-label/list",
       {}
     );
     return response;
@@ -13206,8 +13229,11 @@ var V4UserService = class {
     this.validateRequiredString(params.viewerUnionId, "viewerUnionId");
     this.validateRequiredNumber(params.labelId, "labelId");
     await this.client.httpClient.post(
-      "/live/v4/user/viewer-record/label/add",
-      params
+      "/live/v4/user/viewer-label/add-viewers-label",
+      {
+        viewerUnionIds: [params.viewerUnionId],
+        labelIds: [params.labelId]
+      }
     );
   }
   /**
@@ -13227,8 +13253,11 @@ var V4UserService = class {
     this.validateRequiredString(params.viewerUnionId, "viewerUnionId");
     this.validateRequiredNumber(params.labelId, "labelId");
     await this.client.httpClient.post(
-      "/live/v4/user/viewer-record/label/delete-ref",
-      params
+      "/live/v4/user/viewer-label/remove-viewers-label",
+      {
+        viewerUnionIds: [params.viewerUnionId],
+        labelIds: [params.labelId]
+      }
     );
   }
   // ============================================
@@ -14242,6 +14271,47 @@ var V4UserService = class {
     return response;
   }
   // ============================================
+  // Story 13-3: Global Channel Settings APIs
+  // ============================================
+  /**
+   * Get global channel settings
+   *
+   * @returns Global channel settings
+   *
+   * @example
+   * ```typescript
+   * const settings = await client.v4User.getGlobalChannelSettings();
+   * ```
+   */
+  async getGlobalChannelSettings() {
+    const response = await this.client.httpClient.get(
+      "/live/v4/user/global-setting/switch/get",
+      {}
+    );
+    return response;
+  }
+  /**
+   * Update global channel settings
+   *
+   * @param params - Update parameters
+   *
+   * @example
+   * ```typescript
+   * await client.v4User.updateGlobalChannelSettings({
+   *   channelConcurrencesEnabled: 'Y',
+   *   donateEnabled: 'N',
+   *   coverImgType: 'contain',
+   * });
+   * ```
+   */
+  async updateGlobalChannelSettings(params) {
+    this.validateGlobalSettingsParams(params);
+    await this.client.httpClient.post(
+      "/live/v4/user/global-setting/switch/update",
+      params
+    );
+  }
+  // ============================================
   // Private Validation Helpers
   // ============================================
   /**
@@ -14271,6 +14341,31 @@ var V4UserService = class {
       throw new PolyVValidationError(`${fieldName} is required`, fieldName, value);
     }
   }
+  /**
+   * Validate global settings update parameters
+   */
+  validateGlobalSettingsParams(params) {
+    const booleanFields = [
+      "channelConcurrencesEnabled",
+      "timelyConvertEnabled",
+      "donateEnabled",
+      "rebirthAutoUploadEnabled",
+      "rebirthAutoConvertEnabled",
+      "pptCoveredEnabled",
+      "testModeButtonEnabled"
+    ];
+    for (const field of booleanFields) {
+      const value = params[field];
+      if (value !== void 0 && value !== "Y" && value !== "N") {
+        throw new PolyVValidationError(`${field} must be 'Y' or 'N'`, field, value);
+      }
+    }
+    if (params.coverImgType !== void 0) {
+      if (params.coverImgType !== "contain" && params.coverImgType !== "cover") {
+        throw new PolyVValidationError("coverImgType must be 'contain' or 'cover'", "coverImgType", params.coverImgType);
+      }
+    }
+  }
 };
 
 // src/services/v4/global.service.ts