polyv-live-api-sdk 1.0.0

package/dist/services/v4/platform.service.d.ts

@@ -0,0 +1,148 @@
+/**
+ * V4 Platform Service
+ *
+ * Service for managing PolyV V4 Platform operations (Coupon management).
+ * Provides methods for coupon CRUD, search, and batch operations.
+ *
+ * @module services/v4/platform
+ */
+import type { PolyVClient } from '../../client.js';
+import type { CreateCouponParams, UpdateCouponParams, SearchCouponsParams, SearchCouponsResponse, SearchCouponViewersParams, SearchCouponViewersResponse, DeleteCouponsBatchParams, UpdateCouponsStatusBatchParams } from '../../types/v4-platform.js';
+/**
+ * V4 Platform Service
+ *
+ * Provides methods for managing coupons including create, update, search, and batch operations.
+ */
+export declare class V4PlatformService {
+    private client;
+    constructor(client: PolyVClient);
+    /**
+     * Validate pagination parameters
+     */
+    private validatePagination;
+    /**
+     * Validate coupon IDs array for batch operations
+     */
+    private validateCouponIds;
+    /**
+     * Validate coupon creation parameters
+     */
+    private validateCreateCouponParams;
+    /**
+     * Validate coupon update parameters
+     */
+    private validateUpdateCouponParams;
+    /**
+     * Create a coupon
+     *
+     * Creates a new coupon with the specified parameters.
+     *
+     * @param params - Coupon creation parameters
+     * @returns Promise resolving to the created coupon ID
+     *
+     * @example
+     * ```typescript
+     * const couponId = await client.v4Platform.createCoupon({
+     *   name: 'Summer Discount',
+     *   receiveStartTime: Date.now(),
+     *   receiveEndTime: Date.now() + 7 * 24 * 60 * 60 * 1000,
+     *   useTimeType: 'DAY',
+     *   dayOfUse: 30,
+     *   type: 'MAX_OUT',
+     *   availableAmount: 1000,
+     *   rule: {
+     *     condition: 'UNCONDITIONAL',
+     *     unconditional: { enable: true, value: 10, unit: 'MONEY' },
+     *     limitPerPerson: 1
+     *   }
+     * });
+     * ```
+     */
+    createCoupon(params: CreateCouponParams): Promise<string>;
+    /**
+     * Update a coupon
+     *
+     * Updates an existing coupon. Cannot update coupons with status FINISHED or INVALID.
+     *
+     * @param params - Coupon update parameters
+     *
+     * @example
+     * ```typescript
+     * await client.v4Platform.updateCoupon({
+     *   couponId: 'coupon123',
+     *   name: 'Updated Coupon Name',
+     *   availableAmount: 2000
+     * });
+     * ```
+     */
+    updateCoupon(params: UpdateCouponParams): Promise<void>;
+    /**
+     * Search coupons
+     *
+     * Retrieves a paginated list of coupons with optional filtering.
+     *
+     * @param params - Search parameters
+     * @returns Promise resolving to paginated coupon list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.v4Platform.searchCoupons({
+     *   status: 'GOING',
+     *   pageNumber: 1,
+     *   pageSize: 20
+     * });
+     * console.log(`Found ${result.total} active coupons`);
+     * ```
+     */
+    searchCoupons(params?: SearchCouponsParams): Promise<SearchCouponsResponse>;
+    /**
+     * Search coupon viewers (recipients)
+     *
+     * Retrieves a paginated list of viewers who have received a specific coupon.
+     *
+     * @param params - Search parameters (couponId is required)
+     * @returns Promise resolving to paginated viewer list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.v4Platform.searchCouponViewers({
+     *   couponId: 'coupon123',
+     *   pageNumber: 1,
+     *   pageSize: 50
+     * });
+     * console.log(`${result.total} viewers received this coupon`);
+     * ```
+     */
+    searchCouponViewers(params: SearchCouponViewersParams): Promise<SearchCouponViewersResponse>;
+    /**
+     * Delete coupons in batch
+     *
+     * Deletes multiple coupons at once (max 200).
+     *
+     * @param params - Batch delete parameters
+     *
+     * @example
+     * ```typescript
+     * await client.v4Platform.deleteCouponsBatch({
+     *   couponIds: ['coupon1', 'coupon2', 'coupon3']
+     * });
+     * ```
+     */
+    deleteCouponsBatch(params: DeleteCouponsBatchParams): Promise<void>;
+    /**
+     * Update coupons status in batch
+     *
+     * Stops or invalidates multiple coupons at once (max 200).
+     *
+     * @param params - Batch status update parameters
+     *
+     * @example
+     * ```typescript
+     * await client.v4Platform.updateCouponsStatusBatch({
+     *   couponIds: ['coupon1', 'coupon2']
+     * });
+     * ```
+     */
+    updateCouponsStatusBatch(params: UpdateCouponsStatusBatchParams): Promise<void>;
+}
+//# sourceMappingURL=platform.service.d.ts.map

package/dist/services/v4/platform.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform.service.d.ts","sourceRoot":"","sources":["../../../src/services/v4/platform.service.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAEnD,OAAO,KAAK,EAEV,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,2BAA2B,EAE3B,wBAAwB,EACxB,8BAA8B,EAC/B,MAAM,4BAA4B,CAAC;AAEpC;;;;GAIG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAAc;gBAEhB,MAAM,EAAE,WAAW;IAQ/B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAS1B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IASzB;;OAEG;IACH,OAAO,CAAC,0BAA0B;IA0BlC;;OAEG;IACH,OAAO,CAAC,0BAA0B;IAUlC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAa/D;;;;;;;;;;;;;;;OAeG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAY7D;;;;;;;;;;;;;;;;;OAiBG;IACG,aAAa,CAAC,MAAM,GAAE,mBAAwB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAUrF;;;;;;;;;;;;;;;;;OAiBG;IACG,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAiBlG;;;;;;;;;;;;;OAaG;IACG,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC;IASzE;;;;;;;;;;;;;OAaG;IACG,wBAAwB,CAAC,MAAM,EAAE,8BAA8B,GAAG,OAAO,CAAC,IAAI,CAAC;CAQtF"}

package/dist/services/v4/robot.service.d.ts

@@ -0,0 +1,144 @@
+/**
+ * V4 Robot Service
+ *
+ * Service for managing PolyV V4 Robot operations.
+ * Provides methods for global robot management and channel robot settings.
+ *
+ * @module services/v4/robot
+ */
+import type { PolyVClient } from '../../client.js';
+import type { ListRobotsParams, ListRobotsResponse, BatchSaveRobotsParams, BatchSaveRobotsResponse, BatchDeleteRobotsParams, GetRobotSettingParams, RobotSetting, UpdateRobotSettingParams, GetRobotStatsParams, RobotStats, PauseRobotParams } from '../../types/v4-robot.js';
+/**
+ * V4RobotService
+ *
+ * Provides methods to interact with PolyV V4 Robot APIs.
+ *
+ * @example
+ * ```typescript
+ * const client = new PolyVClient({ appId: 'xxx', appSecret: 'yyy' });
+ * const robots = await client.v4Robot.listRobots({ pageNumber: 1, pageSize: 10 });
+ * ```
+ */
+export declare class V4RobotService {
+    private client;
+    /**
+     * Create a new V4RobotService instance
+     *
+     * @param client - The PolyVClient instance to use for API calls
+     */
+    constructor(client: PolyVClient);
+    /**
+     * Query robot virtual nicknames with pagination
+     *
+     * @param params - Query parameters (optional)
+     * @returns Paginated robot list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.v4Robot.listRobots({
+     *   pageNumber: 1,
+     *   pageSize: 10,
+     * });
+     * console.log(result.contents);
+     * ```
+     */
+    listRobots(params?: ListRobotsParams): Promise<ListRobotsResponse>;
+    /**
+     * Batch create robot virtual nicknames
+     *
+     * @param params - Batch creation parameters
+     * @returns Batch creation result
+     *
+     * @example
+     * ```typescript
+     * const result = await client.v4Robot.batchSaveRobots({
+     *   robots: [
+     *     { name: 'Robot A', avatar: 'https://example.com/a.jpg' },
+     *     { name: 'Robot B' },
+     *   ],
+     * });
+     * console.log(result.savedCount);
+     * ```
+     */
+    batchSaveRobots(params: BatchSaveRobotsParams): Promise<BatchSaveRobotsResponse>;
+    /**
+     * Batch delete robots
+     *
+     * @param params - Batch deletion parameters
+     *
+     * @example
+     * ```typescript
+     * await client.v4Robot.batchDeleteRobots({
+     *   ids: [3001, 3002, 3003],
+     * });
+     * ```
+     */
+    batchDeleteRobots(params: BatchDeleteRobotsParams): Promise<void>;
+    /**
+     * Query channel robot settings
+     *
+     * @param params - Query parameters
+     * @returns Channel robot settings
+     *
+     * @example
+     * ```typescript
+     * const settings = await client.v4Robot.getRobotSetting({
+     *   channelId: '12345678',
+     * });
+     * console.log(settings.robotNumber);
+     * ```
+     */
+    getRobotSetting(params: GetRobotSettingParams): Promise<RobotSetting>;
+    /**
+     * Update channel robot settings
+     *
+     * @param params - Update parameters
+     *
+     * @example
+     * ```typescript
+     * await client.v4Robot.updateRobotSetting({
+     *   channelId: '12345678',
+     *   robotNumber: 10,
+     *   addRobotModel: 'timely',
+     * });
+     * ```
+     */
+    updateRobotSetting(params: UpdateRobotSettingParams): Promise<void>;
+    /**
+     * Query channel robot stats
+     *
+     * @param params - Query parameters
+     * @returns Channel robot stats
+     *
+     * @example
+     * ```typescript
+     * const stats = await client.v4Robot.getRobotStats({
+     *   channelId: '12345678',
+     * });
+     * console.log(stats.robotCount);
+     * ```
+     */
+    getRobotStats(params: GetRobotStatsParams): Promise<RobotStats>;
+    /**
+     * Pause channel robots
+     *
+     * @param params - Pause parameters
+     *
+     * @example
+     * ```typescript
+     * await client.v4Robot.pauseRobot({
+     *   channelId: '12345678',
+     * });
+     * ```
+     */
+    pauseRobot(params: PauseRobotParams): Promise<void>;
+    /**
+     * Validate channel ID
+     */
+    private validateChannelId;
+    /**
+     * Check if string contains emoji
+     */
+    private containsEmoji;
+}
+//# sourceMappingURL=robot.service.d.ts.map

package/dist/services/v4/robot.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"robot.service.d.ts","sourceRoot":"","sources":["../../../src/services/v4/robot.service.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EACV,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACrB,YAAY,EACZ,wBAAwB,EACxB,mBAAmB,EACnB,UAAU,EACV,gBAAgB,EAEjB,MAAM,yBAAyB,CAAC;AAGjC;;;;;;;;;;GAUG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAc;IAE5B;;;;OAIG;gBACS,MAAM,EAAE,WAAW;IAQ/B;;;;;;;;;;;;;;OAcG;IACG,UAAU,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAQxE;;;;;;;;;;;;;;;;OAgBG;IACG,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAsCtF;;;;;;;;;;;OAWG;IACG,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBvE;;;;;;;;;;;;;OAaG;IACG,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,YAAY,CAAC;IAU3E;;;;;;;;;;;;;OAaG;IACG,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqCzE;;;;;;;;;;;;;OAaG;IACG,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAUrE;;;;;;;;;;;OAWG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAczD;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAMzB;;OAEG;IACH,OAAO,CAAC,aAAa;CAKtB"}

package/dist/services/v4/statistics.service.d.ts

@@ -0,0 +1,61 @@
+/**
+ * V4 Statistics Service
+ *
+ * Service for managing PolyV V4 Statistics operations.
+ * Provides methods for querying live session statistics.
+ *
+ * @module services/v4/statistics
+ */
+import type { PolyVClient } from '../../client.js';
+import type { GetSessionStatsSummaryListParams, GetSessionStatsSummaryListResponse } from '../../types/v4-statistics.js';
+/**
+ * V4StatisticsService
+ *
+ * Provides methods to interact with PolyV V4 Statistics APIs.
+ *
+ * @example
+ * ```typescript
+ * const client = new PolyVClient({ appId: 'xxx', appSecret: 'yyy' });
+ * const stats = await client.v4Statistics.getSessionStatsSummaryList({
+ *   channelId: '123456',
+ *   pageNumber: 1,
+ *   pageSize: 10,
+ * });
+ * ```
+ */
+export declare class V4StatisticsService {
+    private client;
+    /**
+     * Create a new V4StatisticsService instance
+     *
+     * @param client - The PolyVClient instance to use for API calls
+     */
+    constructor(client: PolyVClient);
+    /**
+     * Get session stats summary list
+     *
+     * Query live session summary data list with pagination support.
+     *
+     * @param params - Query parameters
+     * @returns Paginated session stats summary list
+     *
+     * @example
+     * ```typescript
+     * const result = await client.v4Statistics.getSessionStatsSummaryList({
+     *   channelId: '123456',
+     *   keyword: 'test',
+     *   startTime: '1678800000000',
+     *   endTime: '1678999999999',
+     *   pageNumber: 1,
+     *   pageSize: 10,
+     * });
+     * console.log(result.contents);
+     * ```
+     */
+    getSessionStatsSummaryList(params: GetSessionStatsSummaryListParams): Promise<GetSessionStatsSummaryListResponse>;
+    /**
+     * Validate pagination parameters
+     */
+    private validatePaginationParams;
+}
+//# sourceMappingURL=statistics.service.d.ts.map

package/dist/services/v4/statistics.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"statistics.service.d.ts","sourceRoot":"","sources":["../../../src/services/v4/statistics.service.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EACV,gCAAgC,EAChC,kCAAkC,EACnC,MAAM,8BAA8B,CAAC;AAGtC;;;;;;;;;;;;;;GAcG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,MAAM,CAAc;IAE5B;;;;OAIG;gBACS,MAAM,EAAE,WAAW;IAQ/B;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,0BAA0B,CAC9B,MAAM,EAAE,gCAAgC,GACvC,OAAO,CAAC,kCAAkC,CAAC;IAc9C;;OAEG;IACH,OAAO,CAAC,wBAAwB;CAwBjC"}