polyv-live-api-sdk 1.0.0 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/dist/client.d.ts +5 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/index.cjs +859 -6
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1232 -327
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +856 -7
- package/dist/index.js.map +1 -1
- package/dist/services/channel.service.d.ts +43 -2
- package/dist/services/channel.service.d.ts.map +1 -1
- package/dist/services/player.service.d.ts +38 -1
- package/dist/services/player.service.d.ts.map +1 -1
- package/dist/services/statistics.service.d.ts +211 -0
- package/dist/services/statistics.service.d.ts.map +1 -0
- package/dist/services/v4/channel.service.d.ts.map +1 -1
- package/dist/types/channel.d.ts +119 -5
- package/dist/types/channel.d.ts.map +1 -1
- package/dist/types/index.d.ts +4 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/player.d.ts +103 -0
- package/dist/types/player.d.ts.map +1 -1
- package/dist/types/statistics-export.d.ts +133 -0
- package/dist/types/statistics-export.d.ts.map +1 -0
- package/dist/types/statistics.d.ts +217 -0
- package/dist/types/statistics.d.ts.map +1 -0
- package/dist/types/v4-channel.d.ts +16 -16
- package/dist/types/v4-channel.d.ts.map +1 -1
- package/dist/utils/date-validation.d.ts +128 -0
- package/dist/utils/date-validation.d.ts.map +1 -0
- package/dist/utils/index.d.ts +1 -0
- package/dist/utils/index.d.ts.map +1 -1
- package/package.json +15 -14
package/dist/index.d.cts
CHANGED
|
@@ -875,7 +875,7 @@ interface GetDocListRequest {
|
|
|
875
875
|
status?: DocStatus;
|
|
876
876
|
page?: number;
|
|
877
877
|
limit?: number;
|
|
878
|
-
isShowUrl?:
|
|
878
|
+
isShowUrl?: 'Y' | 'N';
|
|
879
879
|
}
|
|
880
880
|
/**
|
|
881
881
|
* Document Model
|
|
@@ -914,7 +914,7 @@ interface DocListResponse {
|
|
|
914
914
|
interface UploadDocRequest {
|
|
915
915
|
file?: File | Blob | Buffer;
|
|
916
916
|
url?: string;
|
|
917
|
-
type?:
|
|
917
|
+
type?: DocConvertType;
|
|
918
918
|
docName?: string;
|
|
919
919
|
callbackUrl?: string;
|
|
920
920
|
}
|
|
@@ -1346,11 +1346,58 @@ interface PlaybackEnabledResponse {
|
|
|
1346
1346
|
enabled: boolean;
|
|
1347
1347
|
}
|
|
1348
1348
|
/**
|
|
1349
|
-
* Playback Setting Response
|
|
1349
|
+
* Playback Setting Response (Story 9.7)
|
|
1350
1350
|
*/
|
|
1351
1351
|
interface PlaybackSettingResponse {
|
|
1352
|
-
|
|
1353
|
-
|
|
1352
|
+
channelId?: string;
|
|
1353
|
+
playbackEnabled?: YNFlag$1;
|
|
1354
|
+
type?: 'single' | 'list';
|
|
1355
|
+
origin?: 'record' | 'playback' | 'vod' | 'material';
|
|
1356
|
+
videoId?: string;
|
|
1357
|
+
videoName?: string;
|
|
1358
|
+
sectionEnabled?: YNFlag$1;
|
|
1359
|
+
globalSettingEnabled?: YNFlag$1;
|
|
1360
|
+
crontabType?: string;
|
|
1361
|
+
startTime?: number;
|
|
1362
|
+
endTime?: number;
|
|
1363
|
+
playbackMultiplierEnabled?: YNFlag$1;
|
|
1364
|
+
playbackProgressBarEnabled?: YNFlag$1;
|
|
1365
|
+
playbackProgressBarOperationType?: string;
|
|
1366
|
+
showPlayButtonEnabled?: YNFlag$1;
|
|
1367
|
+
chatPlaybackEnabled?: YNFlag$1;
|
|
1368
|
+
productPlaybackEnabled?: YNFlag$1;
|
|
1369
|
+
questionnairePlaybackEnabled?: YNFlag$1;
|
|
1370
|
+
qaPlaybackEnabled?: YNFlag$1;
|
|
1371
|
+
cardPushPlaybackEnabled?: YNFlag$1;
|
|
1372
|
+
checkInPlaybackEnabled?: YNFlag$1;
|
|
1373
|
+
sortType?: string;
|
|
1374
|
+
autoPublish?: boolean;
|
|
1375
|
+
}
|
|
1376
|
+
/**
|
|
1377
|
+
* Set Playback Setting Request (Story 9.7)
|
|
1378
|
+
* API: POST /live/v3/channel/playback/set-setting
|
|
1379
|
+
*/
|
|
1380
|
+
interface SetPlaybackSettingRequest {
|
|
1381
|
+
globalSettingEnabled?: YNFlag$1;
|
|
1382
|
+
crontabType?: string;
|
|
1383
|
+
startTime?: number;
|
|
1384
|
+
endTime?: number;
|
|
1385
|
+
playbackEnabled?: YNFlag$1;
|
|
1386
|
+
type?: 'single' | 'list';
|
|
1387
|
+
origin?: 'record' | 'playback' | 'vod' | 'material';
|
|
1388
|
+
videoId?: string;
|
|
1389
|
+
sectionEnabled?: YNFlag$1;
|
|
1390
|
+
playbackMultiplierEnabled?: YNFlag$1;
|
|
1391
|
+
playbackProgressBarEnabled?: YNFlag$1;
|
|
1392
|
+
playbackProgressBarOperationType?: string;
|
|
1393
|
+
showPlayButtonEnabled?: YNFlag$1;
|
|
1394
|
+
productPlaybackEnabled?: YNFlag$1;
|
|
1395
|
+
customOpenDuration?: number;
|
|
1396
|
+
chatPlaybackEnabled?: YNFlag$1;
|
|
1397
|
+
questionnairePlaybackEnabled?: YNFlag$1;
|
|
1398
|
+
qaPlaybackEnabled?: YNFlag$1;
|
|
1399
|
+
cardPushPlaybackEnabled?: YNFlag$1;
|
|
1400
|
+
checkInPlaybackEnabled?: YNFlag$1;
|
|
1354
1401
|
}
|
|
1355
1402
|
/**
|
|
1356
1403
|
* Set Record Setting Request
|
|
@@ -1397,6 +1444,12 @@ interface RecordMergeArrayRequest {
|
|
|
1397
1444
|
fileIds: string[];
|
|
1398
1445
|
fileName?: string;
|
|
1399
1446
|
callbackUrl?: string;
|
|
1447
|
+
/** Whether to auto-convert to VOD (Y/N) - for async merge */
|
|
1448
|
+
autoConvert?: 'Y' | 'N';
|
|
1449
|
+
/** Merge output type (Y=MP4, N=m3u8) - for async merge */
|
|
1450
|
+
mergeMp4?: 'Y' | 'N';
|
|
1451
|
+
/** Whether to merge in order of fileIds parameter (Y/N) - for async merge */
|
|
1452
|
+
orderByCustom?: 'Y' | 'N';
|
|
1400
1453
|
}
|
|
1401
1454
|
/**
|
|
1402
1455
|
* Record Merge Response
|
|
@@ -2432,6 +2485,67 @@ interface DeleteChannelProductParams {
|
|
|
2432
2485
|
/** Product ID - REQUIRED */
|
|
2433
2486
|
productId: number;
|
|
2434
2487
|
}
|
|
2488
|
+
/**
|
|
2489
|
+
* List Channel Products Request
|
|
2490
|
+
*
|
|
2491
|
+
* Parameters for listing products in a channel.
|
|
2492
|
+
*/
|
|
2493
|
+
interface ListChannelProductsParams {
|
|
2494
|
+
/** Channel ID - REQUIRED */
|
|
2495
|
+
channelId: string;
|
|
2496
|
+
/** Page number, default 1 */
|
|
2497
|
+
pageNumber?: number;
|
|
2498
|
+
/** Page size, default 20, max 100 */
|
|
2499
|
+
pageSize?: number;
|
|
2500
|
+
}
|
|
2501
|
+
/**
|
|
2502
|
+
* Channel Product Item
|
|
2503
|
+
*/
|
|
2504
|
+
interface ChannelProductItem {
|
|
2505
|
+
/** Product ID */
|
|
2506
|
+
productId: number;
|
|
2507
|
+
/** Channel ID */
|
|
2508
|
+
channelId: string;
|
|
2509
|
+
/** Product name */
|
|
2510
|
+
name: string;
|
|
2511
|
+
/** Product type */
|
|
2512
|
+
productType?: string;
|
|
2513
|
+
/** Product status: 1 (on shelf) | 2 (off shelf) */
|
|
2514
|
+
status: number;
|
|
2515
|
+
/** Product cover URL */
|
|
2516
|
+
cover?: string;
|
|
2517
|
+
/** Product link */
|
|
2518
|
+
link?: string;
|
|
2519
|
+
/** Link type: 10 (universal) | 11 (multi-platform) */
|
|
2520
|
+
linkType?: number;
|
|
2521
|
+
/** Price */
|
|
2522
|
+
price?: number;
|
|
2523
|
+
/** Real price */
|
|
2524
|
+
realPrice?: number;
|
|
2525
|
+
/** Price type */
|
|
2526
|
+
priceType?: string;
|
|
2527
|
+
/** Original price type */
|
|
2528
|
+
originalPriceType?: string;
|
|
2529
|
+
/** Product description */
|
|
2530
|
+
productDesc?: string;
|
|
2531
|
+
/** Button text */
|
|
2532
|
+
btnShow?: string;
|
|
2533
|
+
/** Created time (13-bit ms timestamp) */
|
|
2534
|
+
createdTime?: number;
|
|
2535
|
+
/** Last modified time (13-bit ms timestamp) */
|
|
2536
|
+
lastModified?: number;
|
|
2537
|
+
}
|
|
2538
|
+
/**
|
|
2539
|
+
* List Channel Products Response
|
|
2540
|
+
*/
|
|
2541
|
+
interface ListChannelProductsResponse {
|
|
2542
|
+
/** Array of product items */
|
|
2543
|
+
contents: ChannelProductItem[];
|
|
2544
|
+
/** Total count */
|
|
2545
|
+
total: number;
|
|
2546
|
+
/** Has more pages */
|
|
2547
|
+
hasMore?: boolean;
|
|
2548
|
+
}
|
|
2435
2549
|
|
|
2436
2550
|
/**
|
|
2437
2551
|
* Account Service Types
|
|
@@ -4115,31 +4229,31 @@ interface SessionInfo {
|
|
|
4115
4229
|
/** Channel ID */
|
|
4116
4230
|
channelId: number;
|
|
4117
4231
|
/** Session name */
|
|
4118
|
-
name
|
|
4232
|
+
name?: string;
|
|
4119
4233
|
/** Status */
|
|
4120
4234
|
status: 'unStart' | 'live' | 'end' | 'playback' | 'expired';
|
|
4121
|
-
/** Start time */
|
|
4122
|
-
startTime
|
|
4235
|
+
/** Start time (can be string or number) */
|
|
4236
|
+
startTime?: string | number;
|
|
4123
4237
|
/** End time */
|
|
4124
|
-
endTime
|
|
4238
|
+
endTime?: number;
|
|
4125
4239
|
/** Created time */
|
|
4126
|
-
createdTime
|
|
4240
|
+
createdTime?: number;
|
|
4127
4241
|
/** Plan start time */
|
|
4128
|
-
planStartTime
|
|
4242
|
+
planStartTime?: number;
|
|
4129
4243
|
/** Plan end time */
|
|
4130
|
-
planEndTime
|
|
4244
|
+
planEndTime?: number;
|
|
4131
4245
|
/** Stream type */
|
|
4132
|
-
streamType
|
|
4246
|
+
streamType?: string;
|
|
4133
4247
|
/** Push client */
|
|
4134
|
-
pushClient
|
|
4248
|
+
pushClient?: string;
|
|
4135
4249
|
/** Splash image */
|
|
4136
|
-
splashImg
|
|
4250
|
+
splashImg?: string;
|
|
4137
4251
|
/** Splash large image */
|
|
4138
|
-
splashLargeImg
|
|
4252
|
+
splashLargeImg?: string;
|
|
4139
4253
|
/** Watch URL */
|
|
4140
|
-
watchUrl
|
|
4254
|
+
watchUrl?: string;
|
|
4141
4255
|
/** User ID */
|
|
4142
|
-
userId
|
|
4256
|
+
userId?: string;
|
|
4143
4257
|
}
|
|
4144
4258
|
/**
|
|
4145
4259
|
* Parameters for getting session relevance
|
|
@@ -4188,7 +4302,7 @@ interface CreateSessionResponse {
|
|
|
4188
4302
|
*/
|
|
4189
4303
|
interface GetSessionParams {
|
|
4190
4304
|
/** Channel ID */
|
|
4191
|
-
channelId: string;
|
|
4305
|
+
channelId: string | number;
|
|
4192
4306
|
/** Session ID */
|
|
4193
4307
|
sessionId: string;
|
|
4194
4308
|
}
|
|
@@ -4196,8 +4310,8 @@ interface GetSessionParams {
|
|
|
4196
4310
|
* Parameters for listing sessions
|
|
4197
4311
|
*/
|
|
4198
4312
|
interface ListSessionsParams {
|
|
4199
|
-
/** Channel ID */
|
|
4200
|
-
channelId
|
|
4313
|
+
/** Channel ID (optional - if not provided, returns sessions for all channels) */
|
|
4314
|
+
channelId?: string | number | undefined;
|
|
4201
4315
|
/** Page number (>= 1) */
|
|
4202
4316
|
pageNumber?: number;
|
|
4203
4317
|
/** Page size (1-1000) */
|
|
@@ -5995,6 +6109,223 @@ interface GetSessionStatsSummaryListResponse {
|
|
|
5995
6109
|
contents: SessionStatsSummary[];
|
|
5996
6110
|
}
|
|
5997
6111
|
|
|
6112
|
+
/**
|
|
6113
|
+
* Statistics Types
|
|
6114
|
+
*
|
|
6115
|
+
* Type definitions for V3 Statistics APIs (Daily View Statistics).
|
|
6116
|
+
*
|
|
6117
|
+
* @module types/statistics
|
|
6118
|
+
*/
|
|
6119
|
+
/**
|
|
6120
|
+
* Daily view statistics entity
|
|
6121
|
+
*
|
|
6122
|
+
* Represents a single day's viewing statistics for a channel.
|
|
6123
|
+
*/
|
|
6124
|
+
interface DailyViewStatistics {
|
|
6125
|
+
/** Query date, format: yyyy-MM-dd */
|
|
6126
|
+
currentDay: string;
|
|
6127
|
+
/** Channel ID */
|
|
6128
|
+
channelId: string;
|
|
6129
|
+
/** POLYV user ID */
|
|
6130
|
+
userId: string;
|
|
6131
|
+
/** PC端播放时长,单位:分钟 */
|
|
6132
|
+
pcPlayDuration: number;
|
|
6133
|
+
/** PC端总播放量(PV) */
|
|
6134
|
+
pcVideoView: number;
|
|
6135
|
+
/** PC端唯一观众数(UV) */
|
|
6136
|
+
pcUniqueViewer: number;
|
|
6137
|
+
/** 移动端播放时长,单位:分钟 */
|
|
6138
|
+
mobilePlayDuration: number;
|
|
6139
|
+
/** 移动端总播放量(PV) */
|
|
6140
|
+
mobileVideoView: number;
|
|
6141
|
+
/** 移动端唯一观众数(UV) */
|
|
6142
|
+
mobileUniqueViewer: number;
|
|
6143
|
+
/** 记录添加时间(13位时间戳) */
|
|
6144
|
+
createdTime: number;
|
|
6145
|
+
/** 记录修改时间(13位时间戳) */
|
|
6146
|
+
lastModified: number;
|
|
6147
|
+
}
|
|
6148
|
+
/**
|
|
6149
|
+
* Parameters for getting daily view statistics
|
|
6150
|
+
*
|
|
6151
|
+
* @property channelId - 频道号(必需)
|
|
6152
|
+
* @property startDay - 开始日期,格式:yyyy-MM-dd(必需)
|
|
6153
|
+
* @property endDay - 结束日期,格式:yyyy-MM-dd(必需)
|
|
6154
|
+
*/
|
|
6155
|
+
interface GetDailyViewStatisticsParams {
|
|
6156
|
+
/** 频道号(必需) */
|
|
6157
|
+
channelId: string;
|
|
6158
|
+
/** 开始日期,格式:yyyy-MM-dd(必需) */
|
|
6159
|
+
startDay: string;
|
|
6160
|
+
/** 结束日期,格式:yyyy-MM-dd(必需) */
|
|
6161
|
+
endDay: string;
|
|
6162
|
+
}
|
|
6163
|
+
/**
|
|
6164
|
+
* Response for getting daily view statistics
|
|
6165
|
+
*
|
|
6166
|
+
* Contains an array of daily statistics for the requested date range.
|
|
6167
|
+
*/
|
|
6168
|
+
interface GetDailyViewStatisticsResponse {
|
|
6169
|
+
/** Array of daily view statistics */
|
|
6170
|
+
contents: DailyViewStatistics[];
|
|
6171
|
+
}
|
|
6172
|
+
/**
|
|
6173
|
+
* Single concurrency data point
|
|
6174
|
+
*
|
|
6175
|
+
* Represents concurrent viewer count at a specific time.
|
|
6176
|
+
*/
|
|
6177
|
+
interface ConcurrencyDataPoint {
|
|
6178
|
+
/** Concurrency date, format: yyyy-MM-dd */
|
|
6179
|
+
day: string;
|
|
6180
|
+
/** Concurrency time point, format: HH:mm */
|
|
6181
|
+
minute: string;
|
|
6182
|
+
/** Concurrent viewers count */
|
|
6183
|
+
viewers: number;
|
|
6184
|
+
}
|
|
6185
|
+
/**
|
|
6186
|
+
* Parameters for getting concurrency data
|
|
6187
|
+
*
|
|
6188
|
+
* @property channelId - 频道号(必需)
|
|
6189
|
+
* @property startDate - 开始日期,格式:yyyy-MM-dd(必需)
|
|
6190
|
+
* @property endDate - 结束日期,格式:yyyy-MM-dd(必需)
|
|
6191
|
+
*/
|
|
6192
|
+
interface GetConcurrencyDataParams {
|
|
6193
|
+
/** 频道号(必需) */
|
|
6194
|
+
channelId: string;
|
|
6195
|
+
/** 开始日期,格式:yyyy-MM-dd(必需) */
|
|
6196
|
+
startDate: string;
|
|
6197
|
+
/** 结束日期,格式:yyyy-MM-dd(必需) */
|
|
6198
|
+
endDate: string;
|
|
6199
|
+
}
|
|
6200
|
+
/**
|
|
6201
|
+
* Response for getting concurrency data
|
|
6202
|
+
*
|
|
6203
|
+
* Contains an array of concurrency data points.
|
|
6204
|
+
*/
|
|
6205
|
+
interface GetConcurrencyDataResponse {
|
|
6206
|
+
/** Array of concurrency data points */
|
|
6207
|
+
contents: ConcurrencyDataPoint[];
|
|
6208
|
+
}
|
|
6209
|
+
/**
|
|
6210
|
+
* Parameters for getting max concurrent viewers
|
|
6211
|
+
*
|
|
6212
|
+
* @property channelId - 频道号(必需)
|
|
6213
|
+
* @property startTime - 开始时间,13位毫秒级时间戳(必需)
|
|
6214
|
+
* @property endTime - 结束时间,13位毫秒级时间戳(必需)
|
|
6215
|
+
*/
|
|
6216
|
+
interface GetMaxConcurrentParams {
|
|
6217
|
+
/** 频道号(必需) */
|
|
6218
|
+
channelId: string;
|
|
6219
|
+
/** 开始时间,13位毫秒级时间戳(必需) */
|
|
6220
|
+
startTime: number;
|
|
6221
|
+
/** 结束时间,13位毫秒级时间戳(必需) */
|
|
6222
|
+
endTime: number;
|
|
6223
|
+
}
|
|
6224
|
+
/**
|
|
6225
|
+
* Response for getting max concurrent viewers
|
|
6226
|
+
*
|
|
6227
|
+
* Contains the maximum concurrent viewer count for the time range.
|
|
6228
|
+
*/
|
|
6229
|
+
interface GetMaxConcurrentResponse {
|
|
6230
|
+
/** Maximum concurrent viewers count */
|
|
6231
|
+
contents: number;
|
|
6232
|
+
}
|
|
6233
|
+
/**
|
|
6234
|
+
* Region distribution item
|
|
6235
|
+
*
|
|
6236
|
+
* Represents viewing statistics for a specific region (country/province/city).
|
|
6237
|
+
*/
|
|
6238
|
+
interface RegionDistributionItem {
|
|
6239
|
+
/** Number of unique IP addresses */
|
|
6240
|
+
ips: number;
|
|
6241
|
+
/** Total play duration in minutes */
|
|
6242
|
+
playDuration: number;
|
|
6243
|
+
/** Total number of plays */
|
|
6244
|
+
plays: number;
|
|
6245
|
+
/** Number of unique viewers */
|
|
6246
|
+
viewers: number;
|
|
6247
|
+
/** Country name (null if not applicable) */
|
|
6248
|
+
country: string | null;
|
|
6249
|
+
/** Province name (null if not applicable) */
|
|
6250
|
+
province: string | null;
|
|
6251
|
+
/** City name (null if not applicable) */
|
|
6252
|
+
city: string | null;
|
|
6253
|
+
/** Percentage of total (0-100) */
|
|
6254
|
+
percent: number;
|
|
6255
|
+
}
|
|
6256
|
+
/**
|
|
6257
|
+
* Parameters for getting region distribution
|
|
6258
|
+
*
|
|
6259
|
+
* @property channelId - 频道号(必需)
|
|
6260
|
+
* @property startTime - 开始时间,13位毫秒级时间戳(必需)
|
|
6261
|
+
* @property endTime - 结束时间,13位毫秒级时间戳(必需)
|
|
6262
|
+
* @property type - 区域类型:country/province/city(可选,默认 province)
|
|
6263
|
+
*/
|
|
6264
|
+
interface GetRegionDistributionParams {
|
|
6265
|
+
/** 频道号(必需) */
|
|
6266
|
+
channelId: string;
|
|
6267
|
+
/** 开始时间,13位毫秒级时间戳(必需) */
|
|
6268
|
+
startTime: number;
|
|
6269
|
+
/** 结束时间,13位毫秒级时间戳(必需) */
|
|
6270
|
+
endTime: number;
|
|
6271
|
+
/** 区域类型:country/province/city(可选,默认 province) */
|
|
6272
|
+
type?: 'country' | 'province' | 'city';
|
|
6273
|
+
}
|
|
6274
|
+
/**
|
|
6275
|
+
* Response for getting region distribution
|
|
6276
|
+
*
|
|
6277
|
+
* Contains an array of region distribution items.
|
|
6278
|
+
*/
|
|
6279
|
+
interface GetRegionDistributionResponse {
|
|
6280
|
+
/** Array of region distribution items */
|
|
6281
|
+
data: RegionDistributionItem[];
|
|
6282
|
+
}
|
|
6283
|
+
/**
|
|
6284
|
+
* Device distribution item
|
|
6285
|
+
*
|
|
6286
|
+
* Represents viewing statistics for a specific browser/device.
|
|
6287
|
+
*/
|
|
6288
|
+
interface DeviceDistributionItem {
|
|
6289
|
+
/** Browser/device name */
|
|
6290
|
+
name: string;
|
|
6291
|
+
/** Platform type (pc/mobile) */
|
|
6292
|
+
platform: string;
|
|
6293
|
+
/** Total number of plays */
|
|
6294
|
+
plays: number;
|
|
6295
|
+
/** Number of unique viewers */
|
|
6296
|
+
viewers: number;
|
|
6297
|
+
/** Number of unique IP addresses */
|
|
6298
|
+
ips: number;
|
|
6299
|
+
/** Total play duration in minutes */
|
|
6300
|
+
playDuration: number;
|
|
6301
|
+
/** Percentage of total (0-100) */
|
|
6302
|
+
percent: number;
|
|
6303
|
+
}
|
|
6304
|
+
/**
|
|
6305
|
+
* Parameters for getting device distribution
|
|
6306
|
+
*
|
|
6307
|
+
* @property channelId - 频道号(必需)
|
|
6308
|
+
* @property startTime - 开始时间,13位毫秒级时间戳(必需)
|
|
6309
|
+
* @property endTime - 结束时间,13位毫秒级时间戳(必需)
|
|
6310
|
+
*/
|
|
6311
|
+
interface GetDeviceDistributionParams {
|
|
6312
|
+
/** 频道号(必需) */
|
|
6313
|
+
channelId: string;
|
|
6314
|
+
/** 开始时间,13位毫秒级时间戳(必需) */
|
|
6315
|
+
startTime: number;
|
|
6316
|
+
/** 结束时间,13位毫秒级时间戳(必需) */
|
|
6317
|
+
endTime: number;
|
|
6318
|
+
}
|
|
6319
|
+
/**
|
|
6320
|
+
* Response for getting device distribution
|
|
6321
|
+
*
|
|
6322
|
+
* Contains an array of device distribution items.
|
|
6323
|
+
*/
|
|
6324
|
+
interface GetDeviceDistributionResponse {
|
|
6325
|
+
/** Array of device distribution items */
|
|
6326
|
+
data: DeviceDistributionItem[];
|
|
6327
|
+
}
|
|
6328
|
+
|
|
5998
6329
|
/**
|
|
5999
6330
|
* V4 User Types
|
|
6000
6331
|
*
|
|
@@ -8460,92 +8791,470 @@ interface WatchFeedbackListResponse {
|
|
|
8460
8791
|
/** Total items */
|
|
8461
8792
|
totalItems: number;
|
|
8462
8793
|
}
|
|
8463
|
-
|
|
8464
8794
|
/**
|
|
8465
|
-
*
|
|
8466
|
-
|
|
8467
|
-
|
|
8468
|
-
|
|
8469
|
-
|
|
8470
|
-
|
|
8795
|
+
* Channel decorate player configuration
|
|
8796
|
+
*/
|
|
8797
|
+
interface ChannelDecoratePlayer {
|
|
8798
|
+
/** Watermark enabled: Y or N */
|
|
8799
|
+
watermarkEnabled: 'Y' | 'N';
|
|
8800
|
+
/** Watermark image URL */
|
|
8801
|
+
iconUrl: string;
|
|
8802
|
+
/** Watermark position: tl (top-left), tr (top-right), bl (bottom-left), br (bottom-right) */
|
|
8803
|
+
iconPosition: LogoPosition;
|
|
8804
|
+
/** Watermark opacity (0-1) */
|
|
8805
|
+
logoOpacity: number;
|
|
8806
|
+
/** Watermark link URL */
|
|
8807
|
+
iconLink: string;
|
|
8808
|
+
/** Warmup enabled: Y or N */
|
|
8809
|
+
warmUpEnabled: 'Y' | 'N';
|
|
8810
|
+
/** Warmup image URL */
|
|
8811
|
+
warmUpImageUrl: string;
|
|
8812
|
+
/** Cover jump URL */
|
|
8813
|
+
coverJumpUrl: string;
|
|
8814
|
+
/** Background image URL */
|
|
8815
|
+
backgroundUrl: string;
|
|
8816
|
+
/** Base page views */
|
|
8817
|
+
basePV: number;
|
|
8818
|
+
/** Actual page views */
|
|
8819
|
+
actualPV: number;
|
|
8820
|
+
}
|
|
8821
|
+
/**
|
|
8822
|
+
* Channel decorate chat configuration
|
|
8471
8823
|
*/
|
|
8472
|
-
|
|
8824
|
+
interface ChannelDecorateChat {
|
|
8825
|
+
/** Chat enabled: Y or N */
|
|
8826
|
+
chatEnabled: 'Y' | 'N';
|
|
8827
|
+
/** Chat admin type */
|
|
8828
|
+
chatAdminType: string;
|
|
8829
|
+
}
|
|
8473
8830
|
/**
|
|
8474
|
-
*
|
|
8475
|
-
*
|
|
8476
|
-
* The signature algorithm:
|
|
8477
|
-
* 1. Filter out null/undefined parameter values
|
|
8478
|
-
* 2. Sort remaining parameters by key (ASCII order)
|
|
8479
|
-
* 3. Concatenate as key1value1key2value2...
|
|
8480
|
-
* 4. Prepend and append appSecret
|
|
8481
|
-
* 5. Compute MD5 or SHA256 hash (uppercase hex)
|
|
8482
|
-
*
|
|
8483
|
-
* @param params Parameters to sign (includes appId, timestamp, and optional business params)
|
|
8484
|
-
* @param config Signature configuration with appSecret and optional method
|
|
8485
|
-
* @returns Signature output with sign, timestamp, and method
|
|
8486
|
-
*
|
|
8487
|
-
* @example
|
|
8488
|
-
* ```typescript
|
|
8489
|
-
* const result = generateSignature(
|
|
8490
|
-
* { appId: 'g4rqgmmjuo', timestamp: 1660270926732 },
|
|
8491
|
-
* { appSecret: 'fsq2k5weced1h8vui657xtdva66whf0g' }
|
|
8492
|
-
* );
|
|
8493
|
-
* // result.sign === '0D2BDA2FD04D93A2B8832B91FD973C4D'
|
|
8494
|
-
* ```
|
|
8831
|
+
* Channel decorate description page configuration
|
|
8495
8832
|
*/
|
|
8496
|
-
|
|
8833
|
+
interface ChannelDecorateDesc {
|
|
8834
|
+
/** Description enabled: Y or N */
|
|
8835
|
+
descEnabled: 'Y' | 'N';
|
|
8836
|
+
/** Description content */
|
|
8837
|
+
descContent: string;
|
|
8838
|
+
}
|
|
8497
8839
|
/**
|
|
8498
|
-
*
|
|
8499
|
-
*
|
|
8500
|
-
* @param input Signature input with appId, timestamp, and optional params
|
|
8501
|
-
* @param config Signature configuration with appSecret and optional method
|
|
8502
|
-
* @returns Signature output with sign, timestamp, and method
|
|
8840
|
+
* Channel decorate splash configuration
|
|
8503
8841
|
*/
|
|
8504
|
-
|
|
8842
|
+
interface ChannelDecorateSplash {
|
|
8843
|
+
/** Splash enabled: Y or N */
|
|
8844
|
+
splashEnabled: 'Y' | 'N';
|
|
8845
|
+
/** Splash image URL */
|
|
8846
|
+
splashImage: string;
|
|
8847
|
+
}
|
|
8505
8848
|
/**
|
|
8506
|
-
*
|
|
8507
|
-
* @param customTimestamp Optional custom timestamp for testing
|
|
8508
|
-
* @returns Current timestamp in milliseconds
|
|
8849
|
+
* Channel decorate menu configuration
|
|
8509
8850
|
*/
|
|
8510
|
-
|
|
8851
|
+
interface ChannelDecorateMenu {
|
|
8852
|
+
/** Menu enabled: Y or N */
|
|
8853
|
+
menuEnabled: 'Y' | 'N';
|
|
8854
|
+
}
|
|
8511
8855
|
/**
|
|
8512
|
-
*
|
|
8513
|
-
* @param params Parameters to sort
|
|
8514
|
-
* @returns Sorted keys array
|
|
8856
|
+
* Channel decorate get response
|
|
8515
8857
|
*/
|
|
8516
|
-
|
|
8858
|
+
interface ChannelDecorateGetResponse {
|
|
8859
|
+
/** Player configuration */
|
|
8860
|
+
player: ChannelDecoratePlayer;
|
|
8861
|
+
/** Chat configuration (optional) */
|
|
8862
|
+
chat?: ChannelDecorateChat;
|
|
8863
|
+
/** Description page configuration (optional) */
|
|
8864
|
+
desc?: ChannelDecorateDesc;
|
|
8865
|
+
/** Splash configuration (optional) */
|
|
8866
|
+
splash?: ChannelDecorateSplash;
|
|
8867
|
+
/** Menu configuration (optional) */
|
|
8868
|
+
menu?: ChannelDecorateMenu;
|
|
8869
|
+
}
|
|
8517
8870
|
/**
|
|
8518
|
-
*
|
|
8519
|
-
* Convenience function that auto-generates timestamp
|
|
8520
|
-
*
|
|
8521
|
-
* @param appId PolyV App ID
|
|
8522
|
-
* @param appSecret PolyV App Secret
|
|
8523
|
-
* @param params Optional business parameters
|
|
8524
|
-
* @param method Signature method (default: MD5)
|
|
8525
|
-
* @returns Signature output
|
|
8871
|
+
* Channel decorate update parameters
|
|
8526
8872
|
*/
|
|
8527
|
-
|
|
8873
|
+
interface ChannelDecorateUpdateParams {
|
|
8874
|
+
/** Watermark enabled: Y or N */
|
|
8875
|
+
watermarkEnabled?: 'Y' | 'N';
|
|
8876
|
+
/** Watermark image URL */
|
|
8877
|
+
iconUrl?: string;
|
|
8878
|
+
/** Watermark position */
|
|
8879
|
+
iconPosition?: LogoPosition;
|
|
8880
|
+
/** Watermark opacity (0-1) */
|
|
8881
|
+
logoOpacity?: number;
|
|
8882
|
+
/** Watermark link URL */
|
|
8883
|
+
iconLink?: string;
|
|
8884
|
+
/** Warmup enabled: Y or N */
|
|
8885
|
+
warmUpEnabled?: 'Y' | 'N';
|
|
8886
|
+
/** Warmup image URL */
|
|
8887
|
+
warmUpImageUrl?: string;
|
|
8888
|
+
/** Cover jump URL */
|
|
8889
|
+
coverJumpUrl?: string;
|
|
8890
|
+
/** Background image URL */
|
|
8891
|
+
backgroundUrl?: string;
|
|
8892
|
+
/** Base page views */
|
|
8893
|
+
basePV?: number;
|
|
8894
|
+
/** Actual page views */
|
|
8895
|
+
actualPV?: number;
|
|
8896
|
+
}
|
|
8528
8897
|
|
|
8529
8898
|
/**
|
|
8530
|
-
*
|
|
8899
|
+
* Statistics Export Types
|
|
8531
8900
|
*
|
|
8532
|
-
*
|
|
8533
|
-
*
|
|
8534
|
-
|
|
8535
|
-
/**
|
|
8536
|
-
* Check if running in Node.js environment
|
|
8537
|
-
*/
|
|
8538
|
-
declare const isNode: boolean;
|
|
8539
|
-
/**
|
|
8540
|
-
* Check if running in browser environment
|
|
8541
|
-
*/
|
|
8542
|
-
declare const isBrowser: boolean;
|
|
8543
|
-
/**
|
|
8544
|
-
* Check if running in Web Worker
|
|
8901
|
+
* Type definitions for statistics export operations (Story 10.4)
|
|
8902
|
+
*
|
|
8903
|
+
* @module types/statistics-export
|
|
8545
8904
|
*/
|
|
8546
|
-
declare const isWebWorker: boolean;
|
|
8547
8905
|
/**
|
|
8548
|
-
*
|
|
8906
|
+
* Viewlog item - a single viewing log entry from API
|
|
8907
|
+
* Contains detailed information about a single viewing session
|
|
8908
|
+
*/
|
|
8909
|
+
interface ViewlogItem {
|
|
8910
|
+
/** Play action ID */
|
|
8911
|
+
playId: string;
|
|
8912
|
+
/** User ID (account ID) */
|
|
8913
|
+
userId: string;
|
|
8914
|
+
/** Channel ID */
|
|
8915
|
+
channelId: string;
|
|
8916
|
+
/** Play duration in seconds */
|
|
8917
|
+
playDuration: number;
|
|
8918
|
+
/** Stay duration in seconds */
|
|
8919
|
+
stayDuration: number;
|
|
8920
|
+
/** Session ID */
|
|
8921
|
+
sessionId: string;
|
|
8922
|
+
/** Viewer ID (param1) */
|
|
8923
|
+
param1: string;
|
|
8924
|
+
/** Viewer nickname (param2) */
|
|
8925
|
+
param2: string;
|
|
8926
|
+
/** Watch type: live or vod (param3) */
|
|
8927
|
+
param3: string;
|
|
8928
|
+
/** IP address */
|
|
8929
|
+
ipAddress: string;
|
|
8930
|
+
/** Country */
|
|
8931
|
+
country: string;
|
|
8932
|
+
/** Province */
|
|
8933
|
+
province: string;
|
|
8934
|
+
/** City */
|
|
8935
|
+
city: string;
|
|
8936
|
+
/** ISP provider */
|
|
8937
|
+
isp: string;
|
|
8938
|
+
/** Referrer URL */
|
|
8939
|
+
referer: string;
|
|
8940
|
+
/** User agent string */
|
|
8941
|
+
userAgent: string;
|
|
8942
|
+
/** Operating system */
|
|
8943
|
+
operatingSystem: string;
|
|
8944
|
+
/** Browser name */
|
|
8945
|
+
browser: string;
|
|
8946
|
+
/** Is mobile: Y/N */
|
|
8947
|
+
isMobile: string;
|
|
8948
|
+
/** Current day (yyyy-MM-dd) */
|
|
8949
|
+
currentDay: string;
|
|
8950
|
+
/** Created timestamp (13-digit milliseconds) */
|
|
8951
|
+
createdTime: number;
|
|
8952
|
+
/** Last modified timestamp (13-digit milliseconds) */
|
|
8953
|
+
lastModified: number;
|
|
8954
|
+
/** Live type: 0(normal)/1(ultra-low latency)/2(PRTC) */
|
|
8955
|
+
ptype: number;
|
|
8956
|
+
/** First active time (enter page time) */
|
|
8957
|
+
firstActiveTime: number;
|
|
8958
|
+
/** Last active time (exit page time) */
|
|
8959
|
+
lastActiveTime: number;
|
|
8960
|
+
}
|
|
8961
|
+
/**
|
|
8962
|
+
* Type guard stub for ViewlogItem - returns true if object matches shape
|
|
8963
|
+
* Note: This is a runtime check for testing purposes
|
|
8964
|
+
*/
|
|
8965
|
+
declare const ViewlogItem: unique symbol;
|
|
8966
|
+
/**
|
|
8967
|
+
* Parameters for getViewlog API call
|
|
8968
|
+
*/
|
|
8969
|
+
interface GetViewlogParams {
|
|
8970
|
+
/** Channel ID (required for CLI, optional in API to query all channels) */
|
|
8971
|
+
channelId: string;
|
|
8972
|
+
/** Start date time (yyyy-MM-dd HH:mm:ss format, required) */
|
|
8973
|
+
startDate: string;
|
|
8974
|
+
/** End date time (yyyy-MM-dd HH:mm:ss format, required) */
|
|
8975
|
+
endDate: string;
|
|
8976
|
+
/** Watch type filter: live or vod (optional) */
|
|
8977
|
+
watchType?: 'live' | 'vod';
|
|
8978
|
+
/** Page number (default: 1) */
|
|
8979
|
+
page?: number;
|
|
8980
|
+
/** Page size (default: 1000) */
|
|
8981
|
+
pageSize?: number;
|
|
8982
|
+
}
|
|
8983
|
+
/**
|
|
8984
|
+
* Type guard stub for GetViewlogParams - returns true if object matches shape
|
|
8985
|
+
*/
|
|
8986
|
+
declare const GetViewlogParams: unique symbol;
|
|
8987
|
+
/**
|
|
8988
|
+
* Response from getViewlog API call
|
|
8989
|
+
*/
|
|
8990
|
+
interface GetViewlogResponse {
|
|
8991
|
+
/** Page size */
|
|
8992
|
+
pageSize: number;
|
|
8993
|
+
/** Current page number */
|
|
8994
|
+
pageNumber: number;
|
|
8995
|
+
/** Total number of items */
|
|
8996
|
+
totalItems: number;
|
|
8997
|
+
/** Total number of pages */
|
|
8998
|
+
totalPages: number;
|
|
8999
|
+
/** Viewlog contents array */
|
|
9000
|
+
contents: ViewlogItem[];
|
|
9001
|
+
}
|
|
9002
|
+
/**
|
|
9003
|
+
* Type guard stub for GetViewlogResponse - returns true if object matches shape
|
|
9004
|
+
*/
|
|
9005
|
+
declare const GetViewlogResponse: unique symbol;
|
|
9006
|
+
/**
|
|
9007
|
+
* Parameters for exportSessionStats API call
|
|
9008
|
+
*/
|
|
9009
|
+
interface ExportSessionStatsParams {
|
|
9010
|
+
/** Channel ID (required) */
|
|
9011
|
+
channelId: string;
|
|
9012
|
+
/** Session ID (required) */
|
|
9013
|
+
sessionId: string;
|
|
9014
|
+
}
|
|
9015
|
+
/**
|
|
9016
|
+
* Type guard stub for ExportSessionStatsParams - returns true if object matches shape
|
|
9017
|
+
*/
|
|
9018
|
+
declare const ExportSessionStatsParams: unique symbol;
|
|
9019
|
+
/**
|
|
9020
|
+
* Response from exportSessionStats API call
|
|
9021
|
+
*/
|
|
9022
|
+
interface ExportSessionStatsResponse {
|
|
9023
|
+
/** Download URL for the report (valid for 60 days) */
|
|
9024
|
+
downloadUrl: string;
|
|
9025
|
+
}
|
|
9026
|
+
/**
|
|
9027
|
+
* Type guard stub for ExportSessionStatsResponse - returns true if object matches shape
|
|
9028
|
+
*/
|
|
9029
|
+
declare const ExportSessionStatsResponse: unique symbol;
|
|
9030
|
+
|
|
9031
|
+
/**
|
|
9032
|
+
* Chat Service Types
|
|
9033
|
+
*
|
|
9034
|
+
* Types for the ChatService message APIs (Epic 3, Story 3.1)
|
|
9035
|
+
*/
|
|
9036
|
+
interface getHistoryPageParams {
|
|
9037
|
+
channelId: string;
|
|
9038
|
+
startDay?: string;
|
|
9039
|
+
endDay?: string;
|
|
9040
|
+
page?: number;
|
|
9041
|
+
pageSize?: number;
|
|
9042
|
+
userType?: string;
|
|
9043
|
+
status?: string;
|
|
9044
|
+
source?: string;
|
|
9045
|
+
roomId?: string;
|
|
9046
|
+
}
|
|
9047
|
+
interface sendAdminMsgParams {
|
|
9048
|
+
channelId: string;
|
|
9049
|
+
msg?: string;
|
|
9050
|
+
imgUrl?: string;
|
|
9051
|
+
pic?: string;
|
|
9052
|
+
nickName?: string;
|
|
9053
|
+
actor?: string;
|
|
9054
|
+
adminIndex?: number;
|
|
9055
|
+
freeReview?: boolean;
|
|
9056
|
+
apiVersion?: string;
|
|
9057
|
+
}
|
|
9058
|
+
interface sendChatParams {
|
|
9059
|
+
channelId: string;
|
|
9060
|
+
userId: string;
|
|
9061
|
+
content: string;
|
|
9062
|
+
imgUrl?: string;
|
|
9063
|
+
}
|
|
9064
|
+
interface sendHiddenByAdminParams {
|
|
9065
|
+
channelId: string;
|
|
9066
|
+
content: string;
|
|
9067
|
+
role: string;
|
|
9068
|
+
}
|
|
9069
|
+
interface delChatParams {
|
|
9070
|
+
channelId: string;
|
|
9071
|
+
id: string;
|
|
9072
|
+
}
|
|
9073
|
+
interface cleanChatParams {
|
|
9074
|
+
channelId: string;
|
|
9075
|
+
}
|
|
9076
|
+
interface messageAuditParams {
|
|
9077
|
+
channelId: string;
|
|
9078
|
+
messages: messageAuditItem[];
|
|
9079
|
+
}
|
|
9080
|
+
interface messageAuditItem {
|
|
9081
|
+
msgId: string;
|
|
9082
|
+
content: string;
|
|
9083
|
+
viewerId: string;
|
|
9084
|
+
nickName: string;
|
|
9085
|
+
avatar?: string;
|
|
9086
|
+
sessionId?: string;
|
|
9087
|
+
viewerType?: string;
|
|
9088
|
+
}
|
|
9089
|
+
interface alertToSpecialParams {
|
|
9090
|
+
channelId: string;
|
|
9091
|
+
message: string;
|
|
9092
|
+
title: string;
|
|
9093
|
+
}
|
|
9094
|
+
interface getSpeakListParams {
|
|
9095
|
+
startTime?: number;
|
|
9096
|
+
endTime?: number;
|
|
9097
|
+
cursor?: string;
|
|
9098
|
+
size?: number;
|
|
9099
|
+
}
|
|
9100
|
+
interface ChatMessage {
|
|
9101
|
+
id: string;
|
|
9102
|
+
content: string;
|
|
9103
|
+
msgType?: string;
|
|
9104
|
+
user?: {
|
|
9105
|
+
userId: string;
|
|
9106
|
+
nick: string;
|
|
9107
|
+
pic: string;
|
|
9108
|
+
userType: string;
|
|
9109
|
+
};
|
|
9110
|
+
time?: number;
|
|
9111
|
+
status?: string;
|
|
9112
|
+
image?: string;
|
|
9113
|
+
roomId?: string;
|
|
9114
|
+
sessionId?: string;
|
|
9115
|
+
accountId?: string;
|
|
9116
|
+
}
|
|
9117
|
+
interface ChatHistoryPageResponse {
|
|
9118
|
+
contents: ChatMessage[];
|
|
9119
|
+
total: number;
|
|
9120
|
+
pageSize: number;
|
|
9121
|
+
pageNumber: number;
|
|
9122
|
+
totalPages: number;
|
|
9123
|
+
}
|
|
9124
|
+
interface SendAdminMsgResponse {
|
|
9125
|
+
success: boolean;
|
|
9126
|
+
message: string;
|
|
9127
|
+
data?: string;
|
|
9128
|
+
}
|
|
9129
|
+
interface SendChatResponse {
|
|
9130
|
+
status: string;
|
|
9131
|
+
result?: string;
|
|
9132
|
+
}
|
|
9133
|
+
interface SendHiddenByAdminResponse {
|
|
9134
|
+
code?: number;
|
|
9135
|
+
status: string;
|
|
9136
|
+
message?: string;
|
|
9137
|
+
data?: string;
|
|
9138
|
+
}
|
|
9139
|
+
interface delChatResponse {
|
|
9140
|
+
success: boolean;
|
|
9141
|
+
message: string;
|
|
9142
|
+
data: string;
|
|
9143
|
+
}
|
|
9144
|
+
interface cleanChatResponse {
|
|
9145
|
+
success: boolean;
|
|
9146
|
+
data: boolean;
|
|
9147
|
+
}
|
|
9148
|
+
interface messageAuditResponse {
|
|
9149
|
+
code?: number;
|
|
9150
|
+
status?: string;
|
|
9151
|
+
requestId?: string;
|
|
9152
|
+
success?: boolean;
|
|
9153
|
+
data: {
|
|
9154
|
+
id: string;
|
|
9155
|
+
msgId: string;
|
|
9156
|
+
status: boolean;
|
|
9157
|
+
msg: string;
|
|
9158
|
+
}[];
|
|
9159
|
+
}
|
|
9160
|
+
interface alertToSpecialResponse {
|
|
9161
|
+
code?: number;
|
|
9162
|
+
status?: string;
|
|
9163
|
+
requestId?: string;
|
|
9164
|
+
success?: boolean;
|
|
9165
|
+
data: boolean;
|
|
9166
|
+
}
|
|
9167
|
+
interface SpeakListResponse {
|
|
9168
|
+
cursor: string;
|
|
9169
|
+
size: number;
|
|
9170
|
+
list: ChatMessage[];
|
|
9171
|
+
}
|
|
9172
|
+
|
|
9173
|
+
/**
|
|
9174
|
+
* Signature Generation Module
|
|
9175
|
+
*
|
|
9176
|
+
* Provides MD5 and SHA256 signature generation for PolyV API authentication.
|
|
9177
|
+
* Supports both Node.js (native crypto) and browser (crypto-js) environments.
|
|
9178
|
+
*
|
|
9179
|
+
* @module auth/signature
|
|
9180
|
+
*/
|
|
9181
|
+
|
|
9182
|
+
/**
|
|
9183
|
+
* Generate signature for PolyV API authentication
|
|
9184
|
+
*
|
|
9185
|
+
* The signature algorithm:
|
|
9186
|
+
* 1. Filter out null/undefined parameter values
|
|
9187
|
+
* 2. Sort remaining parameters by key (ASCII order)
|
|
9188
|
+
* 3. Concatenate as key1value1key2value2...
|
|
9189
|
+
* 4. Prepend and append appSecret
|
|
9190
|
+
* 5. Compute MD5 or SHA256 hash (uppercase hex)
|
|
9191
|
+
*
|
|
9192
|
+
* @param params Parameters to sign (includes appId, timestamp, and optional business params)
|
|
9193
|
+
* @param config Signature configuration with appSecret and optional method
|
|
9194
|
+
* @returns Signature output with sign, timestamp, and method
|
|
9195
|
+
*
|
|
9196
|
+
* @example
|
|
9197
|
+
* ```typescript
|
|
9198
|
+
* const result = generateSignature(
|
|
9199
|
+
* { appId: 'g4rqgmmjuo', timestamp: 1660270926732 },
|
|
9200
|
+
* { appSecret: 'fsq2k5weced1h8vui657xtdva66whf0g' }
|
|
9201
|
+
* );
|
|
9202
|
+
* // result.sign === '0D2BDA2FD04D93A2B8832B91FD973C4D'
|
|
9203
|
+
* ```
|
|
9204
|
+
*/
|
|
9205
|
+
declare function generateSignature(params: Record<string, unknown>, config: SignatureConfig): SignatureOutput;
|
|
9206
|
+
/**
|
|
9207
|
+
* Generate signature for PolyV API authentication (alternative signature)
|
|
9208
|
+
*
|
|
9209
|
+
* @param input Signature input with appId, timestamp, and optional params
|
|
9210
|
+
* @param config Signature configuration with appSecret and optional method
|
|
9211
|
+
* @returns Signature output with sign, timestamp, and method
|
|
9212
|
+
*/
|
|
9213
|
+
declare function generateSignature(input: SignatureInput, config: SignatureConfig): SignatureOutput;
|
|
9214
|
+
/**
|
|
9215
|
+
* Generate timestamp in milliseconds
|
|
9216
|
+
* @param customTimestamp Optional custom timestamp for testing
|
|
9217
|
+
* @returns Current timestamp in milliseconds
|
|
9218
|
+
*/
|
|
9219
|
+
declare function generateTimestamp(customTimestamp?: number): number;
|
|
9220
|
+
/**
|
|
9221
|
+
* Sort parameters by key name (ASCII order)
|
|
9222
|
+
* @param params Parameters to sort
|
|
9223
|
+
* @returns Sorted keys array
|
|
9224
|
+
*/
|
|
9225
|
+
declare function sortParams(params: Record<string, unknown>): string[];
|
|
9226
|
+
/**
|
|
9227
|
+
* Create signature with just appId, appSecret, and optional business params
|
|
9228
|
+
* Convenience function that auto-generates timestamp
|
|
9229
|
+
*
|
|
9230
|
+
* @param appId PolyV App ID
|
|
9231
|
+
* @param appSecret PolyV App Secret
|
|
9232
|
+
* @param params Optional business parameters
|
|
9233
|
+
* @param method Signature method (default: MD5)
|
|
9234
|
+
* @returns Signature output
|
|
9235
|
+
*/
|
|
9236
|
+
declare function createSignature(appId: string, appSecret: string, params?: Record<string, unknown>, method?: SignatureMethod): SignatureOutput;
|
|
9237
|
+
|
|
9238
|
+
/**
|
|
9239
|
+
* Environment Detection Utilities
|
|
9240
|
+
*
|
|
9241
|
+
* Detects the runtime environment (Node.js or Browser) for proper
|
|
9242
|
+
* crypto implementation selection.
|
|
9243
|
+
*/
|
|
9244
|
+
/**
|
|
9245
|
+
* Check if running in Node.js environment
|
|
9246
|
+
*/
|
|
9247
|
+
declare const isNode: boolean;
|
|
9248
|
+
/**
|
|
9249
|
+
* Check if running in browser environment
|
|
9250
|
+
*/
|
|
9251
|
+
declare const isBrowser: boolean;
|
|
9252
|
+
/**
|
|
9253
|
+
* Check if running in Web Worker
|
|
9254
|
+
*/
|
|
9255
|
+
declare const isWebWorker: boolean;
|
|
9256
|
+
/**
|
|
9257
|
+
* Crypto source type
|
|
8549
9258
|
*/
|
|
8550
9259
|
type CryptoSource = 'node' | 'browser' | 'crypto-js' | 'none';
|
|
8551
9260
|
/**
|
|
@@ -8640,7 +9349,54 @@ declare function paginate<T>(fetcher: (opts: PaginationOptions) => Promise<Pagin
|
|
|
8640
9349
|
* console.log('Total items:', allItems.length);
|
|
8641
9350
|
* ```
|
|
8642
9351
|
*/
|
|
8643
|
-
declare function collectAll<T>(fetcher: (opts: PaginationOptions) => Promise<PaginationResponse<T>>, options?: PaginateOptions): Promise<T[]>;
|
|
9352
|
+
declare function collectAll<T>(fetcher: (opts: PaginationOptions) => Promise<PaginationResponse<T>>, options?: PaginateOptions): Promise<T[]>;
|
|
9353
|
+
|
|
9354
|
+
/**
|
|
9355
|
+
* Date Validation Utilities
|
|
9356
|
+
*
|
|
9357
|
+
* Shared validation functions for date handling across SDK and CLI.
|
|
9358
|
+
*
|
|
9359
|
+
* @module utils/date-validation
|
|
9360
|
+
*/
|
|
9361
|
+
/**
|
|
9362
|
+
* Maximum allowed date range in days for statistics queries
|
|
9363
|
+
*/
|
|
9364
|
+
declare const MAX_DATE_RANGE_DAYS = 60;
|
|
9365
|
+
/**
|
|
9366
|
+
* Check if a date string is in valid yyyy-MM-dd format
|
|
9367
|
+
*
|
|
9368
|
+
* @param dateStr - Date string to validate
|
|
9369
|
+
* @returns true if the date is valid, false otherwise
|
|
9370
|
+
*
|
|
9371
|
+
* @example
|
|
9372
|
+
* ```typescript
|
|
9373
|
+
* isValidDateFormat('2024-01-15'); // true
|
|
9374
|
+
* isValidDateFormat('2024/01/15'); // false
|
|
9375
|
+
* isValidDateFormat('2024-02-30'); // false (invalid date)
|
|
9376
|
+
* ```
|
|
9377
|
+
*/
|
|
9378
|
+
declare function isValidDateFormat(dateStr: string): boolean;
|
|
9379
|
+
/**
|
|
9380
|
+
* Validate that startDay is before or equal to endDay
|
|
9381
|
+
*
|
|
9382
|
+
* @param startDay - Start date string (yyyy-MM-dd)
|
|
9383
|
+
* @param endDay - End date string (yyyy-MM-dd)
|
|
9384
|
+
* @returns true if startDay <= endDay, false otherwise
|
|
9385
|
+
*/
|
|
9386
|
+
declare function isStartDateBeforeEndDate(startDay: string, endDay: string): boolean;
|
|
9387
|
+
/**
|
|
9388
|
+
* Validate date range does not exceed maximum allowed days
|
|
9389
|
+
*
|
|
9390
|
+
* @param startDay - Start date string (yyyy-MM-dd)
|
|
9391
|
+
* @param endDay - End date string (yyyy-MM-dd)
|
|
9392
|
+
* @param maxDays - Maximum allowed days (default: MAX_DATE_RANGE_DAYS)
|
|
9393
|
+
* @returns Object with validation result and error message if invalid
|
|
9394
|
+
*/
|
|
9395
|
+
declare function validateDateRange(startDay: string, endDay: string, maxDays?: number): {
|
|
9396
|
+
valid: boolean;
|
|
9397
|
+
error?: string;
|
|
9398
|
+
daysDiff?: number;
|
|
9399
|
+
};
|
|
8644
9400
|
|
|
8645
9401
|
/**
|
|
8646
9402
|
* ChannelService
|
|
@@ -9405,7 +10161,7 @@ declare class ChannelService {
|
|
|
9405
10161
|
* await channelService.setRecordDefault('ch123456', 'file123');
|
|
9406
10162
|
* ```
|
|
9407
10163
|
*/
|
|
9408
|
-
setRecordDefault(channelId: string, fileId: string): Promise<boolean>;
|
|
10164
|
+
setRecordDefault(channelId: string, fileId: string, listType?: 'playback' | 'vod'): Promise<boolean>;
|
|
9409
10165
|
/**
|
|
9410
10166
|
* Set record setting
|
|
9411
10167
|
*
|
|
@@ -9473,6 +10229,27 @@ declare class ChannelService {
|
|
|
9473
10229
|
* ```
|
|
9474
10230
|
*/
|
|
9475
10231
|
getPlaybackSetting(channelId: string): Promise<PlaybackSettingResponse>;
|
|
10232
|
+
/**
|
|
10233
|
+
* Set playback setting (Story 9.7)
|
|
10234
|
+
*
|
|
10235
|
+
* Sets the playback settings for a channel.
|
|
10236
|
+
* API: POST /live/v3/channel/playback/set-setting
|
|
10237
|
+
*
|
|
10238
|
+
* @param channelId - The channel ID
|
|
10239
|
+
* @param options - Playback setting options
|
|
10240
|
+
* @returns true if operation was successful
|
|
10241
|
+
* @throws PolyVValidationError if channelId is empty
|
|
10242
|
+
*
|
|
10243
|
+
* @example
|
|
10244
|
+
* ```typescript
|
|
10245
|
+
* await channelService.setPlaybackSetting('ch123456', {
|
|
10246
|
+
* playbackEnabled: 'Y',
|
|
10247
|
+
* type: 'single',
|
|
10248
|
+
* origin: 'playback',
|
|
10249
|
+
* });
|
|
10250
|
+
* ```
|
|
10251
|
+
*/
|
|
10252
|
+
setPlaybackSetting(channelId: string, options: SetPlaybackSettingRequest): Promise<boolean>;
|
|
9476
10253
|
/**
|
|
9477
10254
|
* Set playback sort
|
|
9478
10255
|
*
|
|
@@ -10571,240 +11348,118 @@ declare class ChannelService {
|
|
|
10571
11348
|
* coverImage: 'https://example.com/cover.jpg',
|
|
10572
11349
|
* coverHref: 'https://example.com/target',
|
|
10573
11350
|
* });
|
|
10574
|
-
* ```
|
|
10575
|
-
*/
|
|
10576
|
-
updateWarmupImage(options: UpdateWarmupImageRequest): Promise<string>;
|
|
10577
|
-
/**
|
|
10578
|
-
* Update warmup video (AC19)
|
|
10579
|
-
*
|
|
10580
|
-
* Updates the warmup video for a channel.
|
|
10581
|
-
*
|
|
10582
|
-
* @param options - Request options including channelId and warmUpFlv (both required)
|
|
10583
|
-
* @returns The API response
|
|
10584
|
-
* @throws PolyVValidationError if channelId or warmUpFlv is empty
|
|
10585
|
-
*
|
|
10586
|
-
* @example
|
|
10587
|
-
* ```typescript
|
|
10588
|
-
* const result = await channelService.updateWarmupVideo({
|
|
10589
|
-
* channelId: 'ch123456',
|
|
10590
|
-
* warmUpFlv: 'https://example.com/warmup.flv',
|
|
10591
|
-
* });
|
|
10592
|
-
* ```
|
|
10593
|
-
*/
|
|
10594
|
-
updateWarmupVideo(options: UpdateWarmupVideoRequest): Promise<string>;
|
|
10595
|
-
/**
|
|
10596
|
-
*
|
|
10597
|
-
*
|
|
10598
|
-
*
|
|
10599
|
-
*
|
|
10600
|
-
*
|
|
10601
|
-
*
|
|
10602
|
-
* @
|
|
10603
|
-
*
|
|
10604
|
-
* @
|
|
10605
|
-
*
|
|
10606
|
-
*
|
|
10607
|
-
*
|
|
10608
|
-
*
|
|
10609
|
-
*
|
|
10610
|
-
*
|
|
10611
|
-
*
|
|
10612
|
-
*
|
|
10613
|
-
|
|
10614
|
-
|
|
10615
|
-
|
|
10616
|
-
*
|
|
10617
|
-
*
|
|
10618
|
-
*
|
|
10619
|
-
|
|
10620
|
-
|
|
10621
|
-
|
|
10622
|
-
*
|
|
10623
|
-
*
|
|
10624
|
-
*
|
|
10625
|
-
*
|
|
10626
|
-
*
|
|
10627
|
-
*
|
|
10628
|
-
*
|
|
10629
|
-
*
|
|
10630
|
-
*
|
|
10631
|
-
*
|
|
10632
|
-
*
|
|
10633
|
-
*
|
|
10634
|
-
*
|
|
10635
|
-
*
|
|
10636
|
-
*
|
|
10637
|
-
*
|
|
10638
|
-
*
|
|
10639
|
-
|
|
10640
|
-
|
|
10641
|
-
|
|
10642
|
-
|
|
10643
|
-
|
|
10644
|
-
|
|
10645
|
-
*
|
|
10646
|
-
*
|
|
10647
|
-
*
|
|
10648
|
-
*
|
|
10649
|
-
*
|
|
10650
|
-
* @
|
|
10651
|
-
*
|
|
10652
|
-
* @
|
|
10653
|
-
*
|
|
10654
|
-
*
|
|
10655
|
-
*
|
|
10656
|
-
*
|
|
10657
|
-
*
|
|
10658
|
-
*
|
|
10659
|
-
*
|
|
10660
|
-
*
|
|
10661
|
-
*
|
|
10662
|
-
|
|
10663
|
-
|
|
10664
|
-
|
|
10665
|
-
|
|
10666
|
-
|
|
10667
|
-
|
|
10668
|
-
|
|
10669
|
-
|
|
10670
|
-
|
|
10671
|
-
|
|
10672
|
-
|
|
10673
|
-
|
|
10674
|
-
|
|
10675
|
-
|
|
10676
|
-
|
|
10677
|
-
|
|
10678
|
-
|
|
10679
|
-
|
|
10680
|
-
|
|
10681
|
-
|
|
10682
|
-
|
|
10683
|
-
|
|
10684
|
-
|
|
10685
|
-
|
|
10686
|
-
msg?: string;
|
|
10687
|
-
imgUrl?: string;
|
|
10688
|
-
pic?: string;
|
|
10689
|
-
nickName?: string;
|
|
10690
|
-
actor?: string;
|
|
10691
|
-
adminIndex?: number;
|
|
10692
|
-
freeReview?: boolean;
|
|
10693
|
-
apiVersion?: string;
|
|
10694
|
-
}
|
|
10695
|
-
interface sendChatParams {
|
|
10696
|
-
channelId: string;
|
|
10697
|
-
userId: string;
|
|
10698
|
-
content: string;
|
|
10699
|
-
imgUrl?: string;
|
|
10700
|
-
}
|
|
10701
|
-
interface sendHiddenByAdminParams {
|
|
10702
|
-
channelId: string;
|
|
10703
|
-
content: string;
|
|
10704
|
-
role: string;
|
|
10705
|
-
}
|
|
10706
|
-
interface delChatParams {
|
|
10707
|
-
channelId: string;
|
|
10708
|
-
id: string;
|
|
10709
|
-
}
|
|
10710
|
-
interface cleanChatParams {
|
|
10711
|
-
channelId: string;
|
|
10712
|
-
}
|
|
10713
|
-
interface messageAuditParams {
|
|
10714
|
-
channelId: string;
|
|
10715
|
-
messages: messageAuditItem[];
|
|
10716
|
-
}
|
|
10717
|
-
interface messageAuditItem {
|
|
10718
|
-
msgId: string;
|
|
10719
|
-
content: string;
|
|
10720
|
-
viewerId: string;
|
|
10721
|
-
nickName: string;
|
|
10722
|
-
avatar?: string;
|
|
10723
|
-
sessionId?: string;
|
|
10724
|
-
viewerType?: string;
|
|
10725
|
-
}
|
|
10726
|
-
interface alertToSpecialParams {
|
|
10727
|
-
channelId: string;
|
|
10728
|
-
message: string;
|
|
10729
|
-
title: string;
|
|
10730
|
-
}
|
|
10731
|
-
interface getSpeakListParams {
|
|
10732
|
-
startTime?: number;
|
|
10733
|
-
endTime?: number;
|
|
10734
|
-
cursor?: string;
|
|
10735
|
-
size?: number;
|
|
10736
|
-
}
|
|
10737
|
-
interface ChatMessage {
|
|
10738
|
-
id: string;
|
|
10739
|
-
content: string;
|
|
10740
|
-
msgType?: string;
|
|
10741
|
-
user?: {
|
|
10742
|
-
userId: string;
|
|
10743
|
-
nick: string;
|
|
10744
|
-
pic: string;
|
|
10745
|
-
userType: string;
|
|
10746
|
-
};
|
|
10747
|
-
time?: number;
|
|
10748
|
-
status?: string;
|
|
10749
|
-
image?: string;
|
|
10750
|
-
roomId?: string;
|
|
10751
|
-
sessionId?: string;
|
|
10752
|
-
accountId?: string;
|
|
10753
|
-
}
|
|
10754
|
-
interface ChatHistoryPageResponse {
|
|
10755
|
-
contents: ChatMessage[];
|
|
10756
|
-
total: number;
|
|
10757
|
-
pageSize: number;
|
|
10758
|
-
pageNumber: number;
|
|
10759
|
-
totalPages: number;
|
|
10760
|
-
}
|
|
10761
|
-
interface SendAdminMsgResponse {
|
|
10762
|
-
success: boolean;
|
|
10763
|
-
message: string;
|
|
10764
|
-
data?: string;
|
|
10765
|
-
}
|
|
10766
|
-
interface SendChatResponse {
|
|
10767
|
-
status: string;
|
|
10768
|
-
result?: string;
|
|
10769
|
-
}
|
|
10770
|
-
interface SendHiddenByAdminResponse {
|
|
10771
|
-
code?: number;
|
|
10772
|
-
status: string;
|
|
10773
|
-
message?: string;
|
|
10774
|
-
data?: string;
|
|
10775
|
-
}
|
|
10776
|
-
interface delChatResponse {
|
|
10777
|
-
success: boolean;
|
|
10778
|
-
message: string;
|
|
10779
|
-
data: string;
|
|
10780
|
-
}
|
|
10781
|
-
interface cleanChatResponse {
|
|
10782
|
-
success: boolean;
|
|
10783
|
-
data: boolean;
|
|
10784
|
-
}
|
|
10785
|
-
interface messageAuditResponse {
|
|
10786
|
-
code?: number;
|
|
10787
|
-
status?: string;
|
|
10788
|
-
requestId?: string;
|
|
10789
|
-
success?: boolean;
|
|
10790
|
-
data: {
|
|
10791
|
-
id: string;
|
|
10792
|
-
msgId: string;
|
|
10793
|
-
status: boolean;
|
|
10794
|
-
msg: string;
|
|
10795
|
-
}[];
|
|
10796
|
-
}
|
|
10797
|
-
interface alertToSpecialResponse {
|
|
10798
|
-
code?: number;
|
|
10799
|
-
status?: string;
|
|
10800
|
-
requestId?: string;
|
|
10801
|
-
success?: boolean;
|
|
10802
|
-
data: boolean;
|
|
10803
|
-
}
|
|
10804
|
-
interface SpeakListResponse {
|
|
10805
|
-
cursor: string;
|
|
10806
|
-
size: number;
|
|
10807
|
-
list: ChatMessage[];
|
|
11351
|
+
* ```
|
|
11352
|
+
*/
|
|
11353
|
+
updateWarmupImage(options: UpdateWarmupImageRequest): Promise<string>;
|
|
11354
|
+
/**
|
|
11355
|
+
* Update warmup video (AC19)
|
|
11356
|
+
*
|
|
11357
|
+
* Updates the warmup video for a channel.
|
|
11358
|
+
*
|
|
11359
|
+
* @param options - Request options including channelId and warmUpFlv (both required)
|
|
11360
|
+
* @returns The API response
|
|
11361
|
+
* @throws PolyVValidationError if channelId or warmUpFlv is empty
|
|
11362
|
+
*
|
|
11363
|
+
* @example
|
|
11364
|
+
* ```typescript
|
|
11365
|
+
* const result = await channelService.updateWarmupVideo({
|
|
11366
|
+
* channelId: 'ch123456',
|
|
11367
|
+
* warmUpFlv: 'https://example.com/warmup.flv',
|
|
11368
|
+
* });
|
|
11369
|
+
* ```
|
|
11370
|
+
*/
|
|
11371
|
+
updateWarmupVideo(options: UpdateWarmupVideoRequest): Promise<string>;
|
|
11372
|
+
/**
|
|
11373
|
+
* List channel products
|
|
11374
|
+
*
|
|
11375
|
+
* Lists products in a channel with pagination support.
|
|
11376
|
+
*
|
|
11377
|
+
* @param params - Query parameters including channelId (required)
|
|
11378
|
+
* @returns Paginated product list
|
|
11379
|
+
* @throws PolyVValidationError if channelId is missing
|
|
11380
|
+
*
|
|
11381
|
+
* @example
|
|
11382
|
+
* ```typescript
|
|
11383
|
+
* const result = await channelService.listChannelProducts({
|
|
11384
|
+
* channelId: 'ch123456',
|
|
11385
|
+
* pageNumber: 1,
|
|
11386
|
+
* pageSize: 20,
|
|
11387
|
+
* });
|
|
11388
|
+
* console.log(result.contents);
|
|
11389
|
+
* ```
|
|
11390
|
+
*/
|
|
11391
|
+
listChannelProducts(params: ListChannelProductsParams): Promise<ListChannelProductsResponse>;
|
|
11392
|
+
/**
|
|
11393
|
+
* Add channel product
|
|
11394
|
+
*
|
|
11395
|
+
* Adds a new product to the channel product library.
|
|
11396
|
+
* Note: Only (channelId, timestamp, appId) participate in signature,
|
|
11397
|
+
* body parameters do NOT participate in signature.
|
|
11398
|
+
*
|
|
11399
|
+
* @param params - Product parameters including channelId, name, status, linkType
|
|
11400
|
+
* @returns Created product information including productId
|
|
11401
|
+
* @throws PolyVValidationError if required parameters are missing
|
|
11402
|
+
*
|
|
11403
|
+
* @example
|
|
11404
|
+
* ```typescript
|
|
11405
|
+
* const product = await channelService.addChannelProduct({
|
|
11406
|
+
* channelId: 'ch123456',
|
|
11407
|
+
* name: 'My Product',
|
|
11408
|
+
* status: 1,
|
|
11409
|
+
* linkType: 10,
|
|
11410
|
+
* link: 'https://example.com/product',
|
|
11411
|
+
* cover: 'https://example.com/cover.jpg',
|
|
11412
|
+
* realPrice: 99.9,
|
|
11413
|
+
* });
|
|
11414
|
+
* console.log(product.productId);
|
|
11415
|
+
* ```
|
|
11416
|
+
*/
|
|
11417
|
+
addChannelProduct(params: AddChannelProductParams): Promise<AddChannelProductResponse>;
|
|
11418
|
+
/**
|
|
11419
|
+
* Update channel product
|
|
11420
|
+
*
|
|
11421
|
+
* Updates an existing product in the channel product library.
|
|
11422
|
+
* Note: Only (channelId, timestamp, appId) participate in signature,
|
|
11423
|
+
* body parameters do NOT participate in signature.
|
|
11424
|
+
*
|
|
11425
|
+
* @param params - Product parameters including channelId, productId, name, status, linkType
|
|
11426
|
+
* @returns true if update was successful
|
|
11427
|
+
* @throws PolyVValidationError if required parameters are missing
|
|
11428
|
+
*
|
|
11429
|
+
* @examples
|
|
11430
|
+
* ```typescript
|
|
11431
|
+
* await channelService.updateChannelProduct({
|
|
11432
|
+
* channelId: 'ch123456',
|
|
11433
|
+
* productId: 12345,
|
|
11434
|
+
* name: 'Updated Product Name',
|
|
11435
|
+
* status: 2,
|
|
11436
|
+
* linkType: 10,
|
|
11437
|
+
* });
|
|
11438
|
+
* ```
|
|
11439
|
+
*/
|
|
11440
|
+
updateChannelProduct(params: UpdateChannelProductParams): Promise<boolean>;
|
|
11441
|
+
/**
|
|
11442
|
+
* Delete channel product
|
|
11443
|
+
*
|
|
11444
|
+
* Deletes a product from the channel product library.
|
|
11445
|
+
* Note: All parameters (channelId, productId, appId, timestamp) participate in signature.
|
|
11446
|
+
*
|
|
11447
|
+
* @param params - Delete parameters including channelId and productId
|
|
11448
|
+
* @returns true if deletion was successful
|
|
11449
|
+
* @throws PolyVValidationError if required parameters are missing
|
|
11450
|
+
*
|
|
11451
|
+
* @example
|
|
11452
|
+
* ```typescript
|
|
11453
|
+
* const success = await channelService.deleteChannelProduct({
|
|
11454
|
+
* channelId: 'ch123456',
|
|
11455
|
+
* productId: 12345,
|
|
11456
|
+
* });
|
|
11457
|
+
* if (success) {
|
|
11458
|
+
* console.log('Product deleted');
|
|
11459
|
+
* }
|
|
11460
|
+
* ```
|
|
11461
|
+
*/
|
|
11462
|
+
deleteChannelProduct(params: DeleteChannelProductParams): Promise<boolean>;
|
|
10808
11463
|
}
|
|
10809
11464
|
|
|
10810
11465
|
/**
|
|
@@ -15434,6 +16089,43 @@ declare class PlayerService {
|
|
|
15434
16089
|
* Validate pagination parameters
|
|
15435
16090
|
*/
|
|
15436
16091
|
private validatePagination;
|
|
16092
|
+
/**
|
|
16093
|
+
* Get channel decorate settings
|
|
16094
|
+
* Query channel player decoration settings (watermark, warmup image, etc.)
|
|
16095
|
+
*
|
|
16096
|
+
* @param channelId - Channel ID
|
|
16097
|
+
* @returns Channel decorate settings
|
|
16098
|
+
*
|
|
16099
|
+
* @example
|
|
16100
|
+
* ```typescript
|
|
16101
|
+
* const decorate = await client.player.getChannelDecorate(123456);
|
|
16102
|
+
* console.log(decorate.player.watermarkEnabled);
|
|
16103
|
+
* ```
|
|
16104
|
+
*/
|
|
16105
|
+
getChannelDecorate(channelId: number): Promise<ChannelDecorateGetResponse>;
|
|
16106
|
+
/**
|
|
16107
|
+
* Update channel decorate settings
|
|
16108
|
+
* Update channel player decoration settings (watermark, warmup image, etc.)
|
|
16109
|
+
*
|
|
16110
|
+
* @param channelId - Channel ID
|
|
16111
|
+
* @param params - Channel decorate update parameters
|
|
16112
|
+
* @returns true on success
|
|
16113
|
+
*
|
|
16114
|
+
* @example
|
|
16115
|
+
* ```typescript
|
|
16116
|
+
* await client.player.updateChannelDecorate(123456, {
|
|
16117
|
+
* watermarkEnabled: 'Y',
|
|
16118
|
+
* iconUrl: 'http://example.com/logo.png',
|
|
16119
|
+
* iconPosition: 'br',
|
|
16120
|
+
* logoOpacity: 0.8,
|
|
16121
|
+
* });
|
|
16122
|
+
* ```
|
|
16123
|
+
*/
|
|
16124
|
+
updateChannelDecorate(channelId: number, params: ChannelDecorateUpdateParams): Promise<boolean>;
|
|
16125
|
+
/**
|
|
16126
|
+
* Validate decorate opacity (0-1)
|
|
16127
|
+
*/
|
|
16128
|
+
private validateDecorateOpacity;
|
|
15437
16129
|
}
|
|
15438
16130
|
|
|
15439
16131
|
/**
|
|
@@ -19170,6 +19862,215 @@ declare class V4WebAppService {
|
|
|
19170
19862
|
deleteRole(roleId: number): Promise<void>;
|
|
19171
19863
|
}
|
|
19172
19864
|
|
|
19865
|
+
/**
|
|
19866
|
+
* Statistics Service
|
|
19867
|
+
*
|
|
19868
|
+
* Service for managing PolyV V3 Statistics operations.
|
|
19869
|
+
* Provides methods for querying daily view statistics.
|
|
19870
|
+
*
|
|
19871
|
+
* @module services/statistics
|
|
19872
|
+
*/
|
|
19873
|
+
|
|
19874
|
+
/**
|
|
19875
|
+
* StatisticsService
|
|
19876
|
+
*
|
|
19877
|
+
* Provides methods to interact with PolyV V3 Statistics APIs.
|
|
19878
|
+
*
|
|
19879
|
+
* @example
|
|
19880
|
+
* ```typescript
|
|
19881
|
+
* const client = new PolyVClient({ appId: 'xxx', appSecret: 'yyy' });
|
|
19882
|
+
* const stats = await client.statistics.getDailyViewStatistics({
|
|
19883
|
+
* channelId: '123456',
|
|
19884
|
+
* startDay: '2024-01-01',
|
|
19885
|
+
* endDay: '2024-01-31',
|
|
19886
|
+
* });
|
|
19887
|
+
* ```
|
|
19888
|
+
*/
|
|
19889
|
+
declare class StatisticsService {
|
|
19890
|
+
private client;
|
|
19891
|
+
/**
|
|
19892
|
+
* Create a new StatisticsService instance
|
|
19893
|
+
*
|
|
19894
|
+
* @param client - The PolyVClient instance to use for API calls
|
|
19895
|
+
*/
|
|
19896
|
+
constructor(client: PolyVClient);
|
|
19897
|
+
/**
|
|
19898
|
+
* Get daily view statistics
|
|
19899
|
+
*
|
|
19900
|
+
* Query daily view statistics for a channel within a date range.
|
|
19901
|
+
* The date range cannot exceed 60 days.
|
|
19902
|
+
*
|
|
19903
|
+
* @param params - Query parameters
|
|
19904
|
+
* @returns Daily view statistics response
|
|
19905
|
+
* @throws {PolyVValidationError} When parameters are invalid
|
|
19906
|
+
*
|
|
19907
|
+
* @example
|
|
19908
|
+
* ```typescript
|
|
19909
|
+
* const result = await client.statistics.getDailyViewStatistics({
|
|
19910
|
+
* channelId: '123456',
|
|
19911
|
+
* startDay: '2024-01-01',
|
|
19912
|
+
* endDay: '2024-01-31',
|
|
19913
|
+
* });
|
|
19914
|
+
* console.log(result.contents);
|
|
19915
|
+
* ```
|
|
19916
|
+
*/
|
|
19917
|
+
getDailyViewStatistics(params: GetDailyViewStatisticsParams): Promise<GetDailyViewStatisticsResponse>;
|
|
19918
|
+
/**
|
|
19919
|
+
* Validate parameters for getDailyViewStatistics
|
|
19920
|
+
*/
|
|
19921
|
+
private validateGetDailyViewStatisticsParams;
|
|
19922
|
+
/**
|
|
19923
|
+
* Get historical concurrency data
|
|
19924
|
+
*
|
|
19925
|
+
* Query historical concurrency data for a channel within a date range.
|
|
19926
|
+
* The date range cannot exceed 60 days.
|
|
19927
|
+
*
|
|
19928
|
+
* @param params - Query parameters
|
|
19929
|
+
* @returns Concurrency data response
|
|
19930
|
+
* @throws {PolyVValidationError} When parameters are invalid
|
|
19931
|
+
*
|
|
19932
|
+
* @example
|
|
19933
|
+
* ```typescript
|
|
19934
|
+
* const result = await client.statistics.getConcurrencyData({
|
|
19935
|
+
* channelId: '123456',
|
|
19936
|
+
* startDate: '2024-01-01',
|
|
19937
|
+
* endDate: '2024-01-31',
|
|
19938
|
+
* });
|
|
19939
|
+
* console.log(result.contents);
|
|
19940
|
+
* ```
|
|
19941
|
+
*/
|
|
19942
|
+
getConcurrencyData(params: GetConcurrencyDataParams): Promise<GetConcurrencyDataResponse>;
|
|
19943
|
+
/**
|
|
19944
|
+
* Validate parameters for getConcurrencyData
|
|
19945
|
+
*/
|
|
19946
|
+
private validateGetConcurrencyDataParams;
|
|
19947
|
+
/**
|
|
19948
|
+
* Get maximum historical concurrent viewers
|
|
19949
|
+
*
|
|
19950
|
+
* Query the maximum concurrent viewers for a channel within a time range.
|
|
19951
|
+
* The time range cannot exceed 3 months.
|
|
19952
|
+
*
|
|
19953
|
+
* @param params - Query parameters
|
|
19954
|
+
* @returns Max concurrent response
|
|
19955
|
+
* @throws {PolyVValidationError} When parameters are invalid
|
|
19956
|
+
*
|
|
19957
|
+
* @example
|
|
19958
|
+
* ```typescript
|
|
19959
|
+
* const result = await client.statistics.getMaxConcurrent({
|
|
19960
|
+
* channelId: '123456',
|
|
19961
|
+
* startTime: 1704067200000,
|
|
19962
|
+
* endTime: 1735689600000,
|
|
19963
|
+
* });
|
|
19964
|
+
* console.log(result.contents);
|
|
19965
|
+
* ```
|
|
19966
|
+
*/
|
|
19967
|
+
getMaxConcurrent(params: GetMaxConcurrentParams): Promise<GetMaxConcurrentResponse>;
|
|
19968
|
+
/**
|
|
19969
|
+
* Validate parameters for getMaxConcurrent
|
|
19970
|
+
*/
|
|
19971
|
+
private validateGetMaxConcurrentParams;
|
|
19972
|
+
/**
|
|
19973
|
+
* Get region distribution
|
|
19974
|
+
*
|
|
19975
|
+
* Query the geographic distribution of viewers for a channel.
|
|
19976
|
+
* The time range cannot exceed 90 days.
|
|
19977
|
+
*
|
|
19978
|
+
* @param params - Query parameters
|
|
19979
|
+
* @returns Region distribution response
|
|
19980
|
+
* @throws {PolyVValidationError} When parameters are invalid
|
|
19981
|
+
*
|
|
19982
|
+
* @example
|
|
19983
|
+
* ```typescript
|
|
19984
|
+
* const result = await client.statistics.getRegionDistribution({
|
|
19985
|
+
* channelId: '123456',
|
|
19986
|
+
* startTime: 1648742400000,
|
|
19987
|
+
* endTime: 1651334399000,
|
|
19988
|
+
* type: 'province',
|
|
19989
|
+
* });
|
|
19990
|
+
* console.log(result.data);
|
|
19991
|
+
* ```
|
|
19992
|
+
*/
|
|
19993
|
+
getRegionDistribution(params: GetRegionDistributionParams): Promise<GetRegionDistributionResponse>;
|
|
19994
|
+
/**
|
|
19995
|
+
* Validate parameters for getRegionDistribution
|
|
19996
|
+
*/
|
|
19997
|
+
private validateGetRegionDistributionParams;
|
|
19998
|
+
/**
|
|
19999
|
+
* Get device distribution
|
|
20000
|
+
*
|
|
20001
|
+
* Query the browser/device distribution of viewers for a channel.
|
|
20002
|
+
* The time range cannot exceed 90 days.
|
|
20003
|
+
*
|
|
20004
|
+
* @param params - Query parameters
|
|
20005
|
+
* @returns Device distribution response
|
|
20006
|
+
* @throws {PolyVValidationError} When parameters are invalid
|
|
20007
|
+
*
|
|
20008
|
+
* @example
|
|
20009
|
+
* ```typescript
|
|
20010
|
+
* const result = await client.statistics.getDeviceDistribution({
|
|
20011
|
+
* channelId: '123456',
|
|
20012
|
+
* startTime: 1651386101000,
|
|
20013
|
+
* endTime: 1652336501462,
|
|
20014
|
+
* });
|
|
20015
|
+
* console.log(result.data);
|
|
20016
|
+
* ```
|
|
20017
|
+
*/
|
|
20018
|
+
getDeviceDistribution(params: GetDeviceDistributionParams): Promise<GetDeviceDistributionResponse>;
|
|
20019
|
+
/**
|
|
20020
|
+
* Validate parameters for getDeviceDistribution
|
|
20021
|
+
*/
|
|
20022
|
+
private validateGetDeviceDistributionParams;
|
|
20023
|
+
/**
|
|
20024
|
+
* Get viewlog (viewing log) data
|
|
20025
|
+
*
|
|
20026
|
+
* Query viewing log data for a channel within a date range.
|
|
20027
|
+
* The date range must be within the same month.
|
|
20028
|
+
*
|
|
20029
|
+
* @param params - Query parameters
|
|
20030
|
+
* @returns Viewlog response with pagination
|
|
20031
|
+
* @throws {PolyVValidationError} When parameters are invalid
|
|
20032
|
+
*
|
|
20033
|
+
* @example
|
|
20034
|
+
* ```typescript
|
|
20035
|
+
* const result = await client.statistics.getViewlog({
|
|
20036
|
+
* channelId: '3151318',
|
|
20037
|
+
* startDate: '2024-01-01 00:00:00',
|
|
20038
|
+
* endDate: '2024-01-31 23:59:59',
|
|
20039
|
+
* });
|
|
20040
|
+
* console.log(result.contents);
|
|
20041
|
+
* ```
|
|
20042
|
+
*/
|
|
20043
|
+
getViewlog(params: GetViewlogParams): Promise<GetViewlogResponse>;
|
|
20044
|
+
/**
|
|
20045
|
+
* Validate parameters for getViewlog
|
|
20046
|
+
*/
|
|
20047
|
+
private validateGetViewlogParams;
|
|
20048
|
+
/**
|
|
20049
|
+
* Export session statistics report
|
|
20050
|
+
*
|
|
20051
|
+
* Export the session statistics report for a specific session.
|
|
20052
|
+
* Returns a download URL for the report file.
|
|
20053
|
+
*
|
|
20054
|
+
* @param params - Query parameters
|
|
20055
|
+
* @returns Export response with download URL
|
|
20056
|
+
* @throws {PolyVValidationError} When parameters are invalid
|
|
20057
|
+
*
|
|
20058
|
+
* @example
|
|
20059
|
+
* ```typescript
|
|
20060
|
+
* const result = await client.statistics.exportSessionStats({
|
|
20061
|
+
* channelId: '3151318',
|
|
20062
|
+
* sessionId: 'fv3ma84e63',
|
|
20063
|
+
* });
|
|
20064
|
+
* console.log(result.downloadUrl);
|
|
20065
|
+
* ```
|
|
20066
|
+
*/
|
|
20067
|
+
exportSessionStats(params: ExportSessionStatsParams): Promise<ExportSessionStatsResponse>;
|
|
20068
|
+
/**
|
|
20069
|
+
* Validate parameters for exportSessionStats
|
|
20070
|
+
*/
|
|
20071
|
+
private validateExportSessionStatsParams;
|
|
20072
|
+
}
|
|
20073
|
+
|
|
19173
20074
|
/**
|
|
19174
20075
|
* PolyV Client
|
|
19175
20076
|
*
|
|
@@ -19208,6 +20109,10 @@ declare class PolyVClient {
|
|
|
19208
20109
|
* Channel service for managing live channels
|
|
19209
20110
|
*/
|
|
19210
20111
|
readonly channel: ChannelService;
|
|
20112
|
+
/**
|
|
20113
|
+
* Statistics service for managing statistics operations
|
|
20114
|
+
*/
|
|
20115
|
+
readonly statistics: StatisticsService;
|
|
19211
20116
|
/**
|
|
19212
20117
|
* Chat service for managing chat messages
|
|
19213
20118
|
*/
|
|
@@ -19498,4 +20403,4 @@ declare function getErrorCodeCategory(code: number): string;
|
|
|
19498
20403
|
*/
|
|
19499
20404
|
declare const VERSION = "1.0.0";
|
|
19500
20405
|
|
|
19501
|
-
export { type AccountViewerSettings, type AddAccountParams, type AddChannelLabelRefsParams, type AddChannelProductParams, type AddChannelProductResponse, type AddCustomFieldParams, type AddCustomFieldResponse, type AddCustomFieldValueParams, type AddInviteSaleParams, type AddInviteSaleResponse, type AddRobotModel, type AddViewerLabelParams, type AllocateLogType, type AllocateOrigin, type AllocationLogItem, type AnchorDetail, type AnchorItem, type AnchorRelationItem, type AntiRecordModelType, type AntiRecordSettingsParams, type AntiRecordSettingsResponse, type AntiRecordShowMode, type AntiRecordType, type ApiErrorDetail, type ApiErrorResponse, type ApiResponse, type ApiResponseStatus, type ApiSuccessResponse, type ApiVersion, type ArrayElement, type AudioModerationRecordItem, type AudioModerationSetting, type AudioModerationSettings, type AudioModerationStrategy, type AuthConfig, type AuthSetting$1 as AuthSetting, type BaseCallbackPayload, type BasicCreateChannelParams, type BatchCheckinItem, type BatchCheckinParams, type BatchCreateChannelsParams, type BatchCreateChannelsResponse, type BatchCreatePopularizationParams, type BatchCreateVideoProducesItem, type BatchCreateVideoProducesParams, type BatchCreateVideoProducesResponse, type BatchDeleteRobotsParams, type BatchPublishSubtitleParams, type BatchSaveRobotsParams, type BatchSaveRobotsResponse, type BatchUpdateOrderStatusParams, type BillUseDetailItem, type BillingDailyItem, type BlacklistAddParams, type BlacklistDeleteParams, type BlacklistItem, type BlacklistPageParams, type BroadcastType, type BrowsersSummary, type BrowsersSummaryParams, type Bulletin, type CallbackOriginType, type CallbackPayload, type CallbackSettings, type CancelCardPushParams, type CardPushItem, type Category, type ChannelBasicInfo, type ChannelBasicListItem, type ChannelDetail$2 as ChannelDetail, type ChannelDetailListItem, type ChannelDetailParams, type ChannelDetailResponse, type ChannelIdParam, type ChannelModel, type ChannelScene$1 as ChannelScene, ChannelService, type ChannelSimpleListItem, type ChannelStreamType, type ChannelsParams, type ChannelsResponse, type ChildAccount, type ChildAccountRole, type ChildAccountStatus, type CleanNoticesParams, type ContentGroupItem, type ContentGroupType, type ContentGroupTypeExtended, type Coupon, type CouponRule, type CouponViewer, type CreateAnchorParams, type CreateCardPushParams, type CreateCardPushResponse, type CreateCategoryParams, type CreateCategoryResponse, type CreateChannelParams, type CreateChannelRequest, type CreateChannelResponse, type CreateChildAccountParams, type CreateCouponParams, type CreateDistributeBatchParams, type CreateGroupUserParams, type CreateGroupUserResponse, type CreateLabelParams, type CreateLabelResponse, type CreateLotteryActivityParams, type CreateLotteryActivityResponse, type CreateMrChannelParams, type CreateMrChannelResponse, type CreateOrganizationParams, type CreateOrganizationResponse, type CreateProductParams, type CreateProductResponse, type CreateProductTagParams$1 as CreateProductTagParams, type CreateProductTagResponse$1 as CreateProductTagResponse, type CreateRoleParams, type CreateSessionParams, type CreateSessionResponse, type CreateTaskRewardParams, type CreateTaskRewardResponse, type CreateViewerLabelParams, type CreateViewerLabelResponse, type CreateViewerNameGroupParams, type CreateViewerRecordParams, type CreateWaitLotteryParams, type CreateWaitLotteryResponse, type CryptoSource, type CustomField, type DecorateSettings, type DeepPartial, type DeleteAccountsParams, type DeleteCardPushParams, type DeleteCategoryParams, type DeleteCategoryResponse, type DeleteChannelProductParams, type DeleteChildAccountsParams, type DeleteCouponsBatchParams, type DeleteDistributeBatchParams, type DeleteLabelParams, type DeleteLotteryActivityParams, type DeleteMaterialsParams, type DeleteMaterialsResult, type DeleteOrganizationParams, type DeleteProductParams, type DeleteProductTagParams$1 as DeleteProductTagParams, type DeleteSessionParams, type DeleteTaskRewardParams, type DeleteVideoProduceParams, type DeleteViewerLabelParams, type DeleteViewerLabelRefParams, type DeleteViewerRecordParams, type DigitalHuman, type DigitalHumanInfo, type DigitalHumanOrganization, type DirectAuthViewerParams, type DiskVideoScriptDeleteParams, type DiskVideoScriptInfo, type DiskVideoScriptQueryParams, type DiskVideoScriptUploadParams, type DiskVideoScriptUploadResponse, type DistributeItem, type DistributeListResponse, type DistributeStatistic, type DonateSettings, type DonateTemplate, type DoubleTeacherType, ERROR_CATEGORIES, ERROR_MESSAGES, type EnvironmentInfo, type ErrorCategory, type ErrorCategoryName, type ExternalViewerItem, type FollowViewer, type FullReduceRule, type GeoSummary, type GeoSummaryParams, type GetAccountViewerParams, type GetBillUseDetailListParams, type GetBillUseDetailListResponse, type GetByRoleParams, type GetBySaleParams, type GetCardPushParams, type GetCategoryListResponse, type GetChildAccountParams, type GetDecorateParams, type GetDistributeStatisticParams, type GetDonateParams, type GetIncomeDetailParams, type GetIncomeDetailResponse, type GetInviteRankParams, type GetInviteStatsParams, type GetLiveSessionParams, type GetLotteryActivityParams, type GetMicDurationParams, type GetProductOrderParams, type GetProductSettingParams, type GetProductTagParams, type GetRelevanceParams, type GetRobotSettingParams, type GetRobotStatsParams, type GetRoleResponse, type GetSessionParams, type GetSessionStatsSummaryListParams, type GetSessionStatsSummaryListResponse, type GetShareParams, type GetSimpleChannelListParams, type GetSimpleChannelListResponse, type GetSubtitleParams, type GetTaskRewardParams, type GetTaskRewardStatsParams, type GetUserDurationsParams, type GetUserDurationsResponse, type GetUserInfoResponse, type GetVideoProduceParams, type GetVideoProducePptParams, type GetViewerDetailParams, type GetViewerRecordParams, type GetViewerUnionDetailParams, type GetWatchLogDetailParams, type GetWatchLogListParams, type GetWatchLogListResponse, type GiftItem, type GiftPageParams, type GlobalFooterSettings, type GlobalSwitchSettings, type GroupAddParams, type GroupAllocateLogContent, type GroupDeleteParams, type GroupInfo, type GroupListParams, type GroupPaginatedResponse, type GroupPaginationParams, type GroupResponse, type GroupUpdateParams, type GroupUserPackage, type GroupViewerAddParams, type GroupViewerDeleteParams, type GroupViewerInfo, type GroupViewerListParams, type HeadAdvertParams, type HeadAdvertType, HttpMethod, type IllegalNotifySettings, type ImageFrequency, type ImportExternalViewerParams, type InfoField$1 as InfoField, type InteractionCallbackPayload, type InteractionEventDeleteParams, type InteractionEventSaveParams, type InteractionType, type InviteRankItem, type InviteSale, type InviteStats, type InviterCreateParams, type JsonArray, type JsonObject, type JsonValue, type Label, type LanguageInfo, type LikeItem, type LikePageParams, type ListAllocateLogParams, type ListAllocateLogResponse, type ListAllocationLogsParams, type ListAllocationLogsResponse, type ListAnchorRelationsParams, type ListAnchorsParams, type ListAnchorsResponse, type ListAudioModerationRecordsParams, type ListAudioModerationRecordsResponse, type ListBillingDailyParams, type ListBillingDailyResponse, type ListBulletinsParams, type ListBulletinsResponse, type ListChannelBasicParams, type ListChildAccountsParams, type ListChildAccountsResponse, type ListContentGroupsParams, type ListCustomFieldsResponse, type ListDigitalHumansParams, type ListDigitalHumansResponse, type ListDistributeParams, type ListFollowViewersParams, type ListFollowViewersResponse, type ListGroupUserPackagesParams, type ListGroupUserPackagesResponse, type ListInviteSalesResponse, type ListLabelsResponse, type ListLotteryActivitiesParams, type ListMaterialCategoriesParams, type ListMaterialCategoriesResponse, type ListMaterialsParams, type ListMaterialsResponse, type ListOrganizationsParams, type ListOrganizationsResponse, type ListProductOrdersParams, type ListProductOrdersResponse, type ListProductTagsParams, type ListProductTagsResponse, type ListProductsParams, type ListProductsResponse, type ListQaParams, type ListQaResponse, type ListRobotsParams, type ListRobotsResponse, type ListRolesParams, type ListRolesResponse, type ListSessionsParams, type ListSessionsResponse, type ListVideoModerationResultsParams, type ListVideoModerationResultsResponse, type ListVideoProducePptsParams, type ListVideoProducePptsResponse, type ListVideoProducesParams, type ListVideoProducesResponse, type ListViewerLabelsResponse, type ListViewerRecordsParams, type ListViewerRecordsResponse, type LiveSessionInfo, type LiveStatusCallbackPayload, type LiveStatusItem, type LiveStatusType, type LiveSummary, type LiveSummaryParams, type LogoParams, type LogoPosition, type LotteryActivity, type LotteryListParams, type LotteryStatistics, type MarqueeTemplate, type MarqueeUrlParams, type Material, type MaterialCategory, type MaterialExtData, type MaterialInfo, type MaterialPaginatedResponse, type MaterialPaginationParams, type MemberStatusCallbackPayload, type MemberStatusType, type MicDurationParams, type MicDurationResponse$1 as MicDurationResponse, type ModerationLabel, type ModerationResultType, type MonitorStreamInfo, type MrConcurrencyDetailResponse, type Mutable, type NewScene, type NonNullable, type OptionalKeys, type Organization, type PageMRecordParams, type PageMRecordResponse, type PageSetting, type PaginationOptions, type PaginationResponse, type PauseRobotParams, type Permission, type PlaybackCallbackPayload, type PlaybackItem, type PlaybackListParams, type PlaybackListResponse, type PlaybackSetting, type PlaybackVideoInfo, PolyVAPIError, type PolyVAPIErrorOptions, type PolyVAPIErrorResponse, PolyVClient, type PolyVClientConfig, PolyVError, PolyVErrorCode, type PolyVErrorOptions, PolyVValidationError, type PopularizationInfo, type PopularizationItem, type PopularizationListParams, PptStatus, type Primitive, type PrivacyParam, type Product, type ProductLinkType, type ProductOrder, type ProductPriceType, type ProductSetting, type ProductStatsItem, type ProductStatsPageParams, type ProductStatus, type ProductTag$1 as ProductTag, type ProductType, type PushCardParams, type PvShowEnableSettings, type Qa, type QaAnswer, type QueryPlaybackVideoInfoParams, type QueryWinnerViewerParams, type ReceiveListParams, type ReceiveListResponse, type RecordCallbackPayload, type RecordedFileItem, type RemoveInviteSaleParams, type RequestOptions, type RequireKeys, type ResolvedClientConfig, type Robot, type RobotSetting, type RobotStats, type Role, type RoleConfig, type RoleConfigTemplate, type RoleDetail, type RolePermission, type SaveRobotItem, type SearchCouponViewersParams, type SearchCouponViewersResponse, type SearchCouponsParams, type SearchCouponsResponse, type SendCustomMessageEncodeParams, type SendCustomMessageParams, type SendSmsParams, type SessionInfo, type SessionRelevanceInfo, type SessionStatsSummary, type SetConcurrencesParams, type SetFlowParams, type SetLiveDurationsParams, type SetOrganizationsItem, type SetOrganizationsParams, type SetPlaybackCallbackParams, type SetPlaybackCallbackResponse, type SetPullBitrateParams, type SetRecordCallbackParams, type SetRecordCallbackResponse, type SetSpaceParams, type SetStreamCallbackParams, type SetStreamCallbackResponse, type SetUserChildrenLoginTokenParams, type SetUserChildrenLoginTokenResponse, type SetUserLoginTokenParams, type SetUserLoginTokenResponse, type SexType, type ShareSettings, type SignParams, type SignatureConfig, type SignatureInput, SignatureMethod, type SignatureOutput, type SignatureResult, type SortChannelProductParams, type SortOptions, type SsoConfigParams, type SsoConfigResponse, type SsoLoginParams, type SsoLoginResponse, type StatisticsCallbackPayload, type StopAdvertParams, type StopTaskRewardParams, type SubmitAcceptInfoParams, type SubtitleInfo$1 as SubtitleInfo, type SwitchGetResponse, type SwitchUpdateParams, type SwitchUpdateResponse, type TaskReward, type TaskRewardPageParams, type TaskRewardStats, type TaskRewardViewerDetail, type Template, type TtsVoice, type TtsVoiceInfo, TtsVoiceTag, type UnconditionalRule, type UpdateAccountParams, type UpdateAccountViewerParams, type UpdateAnchorParams, type UpdateAnchorStatusParams, type UpdateAudioModerationSettingParams, type UpdateAudioModerationSettingsParams, type UpdateAuthParams, type UpdateByRoleParams, type UpdateCallbackParams, type UpdateCardPushParams, type UpdateCategoryNameParams, type UpdateCategoryNameResponse, type UpdateCategoryRankParams, type UpdateCategoryRankResponse, type UpdateChannelParams, type UpdateChannelProductParams, type UpdateChannelRequest, type UpdateChannelSubtitleParams, type UpdateChannelTemplateParams, type UpdateChatEnabledParams, type UpdateChildAccountParams, type UpdateCouponParams, type UpdateCouponsStatusBatchParams, type UpdateDecorateParams, type UpdateDistributeBatchParams, type UpdateDonateParams, type UpdateDonateTemplateParams, type UpdateGlobalFooterParams, type UpdateGlobalSwitchParams, type UpdateGroupUserPackageParams, type UpdateInviteSaleParams, type UpdateLabelParams, type UpdateLotteryActivityParams, type UpdateMarqueeTemplateParams, type UpdateMasterSwitchParams, type UpdatePageSettingParams, type UpdatePlaybackSettingParams, type UpdateProductParams, type UpdateProductSettingParams, type UpdateProductTagParams$1 as UpdateProductTagParams, type UpdatePvShowEnableParams, type UpdateRobotSettingParams, type UpdateRoleConfigTemplateParams, type UpdateRoleParams, type UpdateSessionParams, type UpdateShareParams, type UpdateSkinParams, type UpdateSubtitleParams, type UpdateSwitchParams, type UpdateTaskRewardParams, type UpdateVideoModerationSettingParams, type UpdateVideoModerationSettingsParams, type UpdateViewerLabelParams, type UpdateViewerRecordParams, type UploadOptions, type UploadProgress, type UploadVideoProducePptParams, type UploadVideoProducePptResponse, type UserChannelBasicListParams, type UserChannelBasicListResponse, type CreateProductTagParams as UserCreateProductTagParams, type CreateProductTagResponse as UserCreateProductTagResponse, type DeleteProductTagParams as UserDeleteProductTagParams, type MicDurationResponse as UserMicDurationResponse, type UserPaginatedResponse, type UserPaginationParams, type UserPlaybackListParams, type UserPlaybackListResponse, type ProductTag as UserProductTag, type UpdateProductTagParams as UserUpdateProductTagParams, type ChannelDetail as V4ChannelDetail, type SubtitleInfo as V4ChannelSubtitleInfo, type V4PaginatedResponse, type V4PaginationParams, VERSION, type ValidationConstraints, type VersionConfig, type VideoModerationResultItem, type VideoModerationSetting, type VideoModerationSettings, type VideoModerationStrategy, type VideoProducePpt, VideoProduceStatus, type VideoProduceTask, type ViewerLabel, type ViewerLogoutParams, type ViewerLotteryWinParams, type ViewerLotteryWinResponse, type ViewerRecord, type ViewerSource, type WatchFeedbackItem, type WatchFeedbackListParams, type WatchFeedbackListResponse, type WatchLogDetailResponse, type WatchLogItem, type WatchType, type WatermarkFontSize, type WeixinBookingStats, type WeixinBookingStatsParams, type WinnerViewerInfo, type YNEnabled, type YNFlag$1 as YNFlag, collectAll, createSignature, generateSignature, generateTimestamp, getEnvironmentInfo, getErrorCodeCategory, getErrorMessage, getErrorMessageByCode, isBrowser, isNode, isPolyVAPIError, isPolyVError, isPolyVErrorCode, isPolyVValidationError, isWebWorker, paginate, sortParams };
|
|
20406
|
+
export { type AccountViewerSettings, type AddAccountParams, type AddChannelLabelRefsParams, type AddChannelProductParams, type AddChannelProductResponse, type AddCustomFieldParams, type AddCustomFieldResponse, type AddCustomFieldValueParams, type AddInviteSaleParams, type AddInviteSaleResponse, type AddRobotModel, type AddViewerLabelParams, type AllocateLogType, type AllocateOrigin, type AllocationLogItem, type AnchorDetail, type AnchorItem, type AnchorRelationItem, type AntiRecordModelType, type AntiRecordSettingsParams, type AntiRecordSettingsResponse, type AntiRecordShowMode, type AntiRecordType, type ApiErrorDetail, type ApiErrorResponse, type ApiResponse, type ApiResponseStatus, type ApiSuccessResponse, type ApiVersion, type ArrayElement, type AudioModerationRecordItem, type AudioModerationSetting, type AudioModerationSettings, type AudioModerationStrategy, type AuthConfig, type AuthSetting$1 as AuthSetting, type BaseCallbackPayload, type BasicCreateChannelParams, type BatchCheckinItem, type BatchCheckinParams, type BatchCreateChannelsParams, type BatchCreateChannelsResponse, type BatchCreatePopularizationParams, type BatchCreateVideoProducesItem, type BatchCreateVideoProducesParams, type BatchCreateVideoProducesResponse, type BatchDeleteRobotsParams, type BatchPublishSubtitleParams, type BatchSaveRobotsParams, type BatchSaveRobotsResponse, type BatchUpdateOrderStatusParams, type BillUseDetailItem, type BillingDailyItem, type BlacklistAddParams, type BlacklistDeleteParams, type BlacklistItem, type BlacklistPageParams, type BroadcastType, type BrowsersSummary, type BrowsersSummaryParams, type Bulletin, type CallbackOriginType, type CallbackPayload, type CallbackSettings, type CancelCardPushParams, type CardPushItem, type Category, type ChannelBasicInfo, type ChannelBasicListItem, type ChannelDetail$2 as ChannelDetail, type ChannelDetailListItem, type ChannelDetailParams, type ChannelDetailResponse, type ChannelIdParam, type ChannelModel, type ChannelScene$1 as ChannelScene, ChannelService, type ChannelSimpleListItem, type ChannelStreamType, type ChannelsParams, type ChannelsResponse, type ChatHistoryPageResponse, type ChatMessage, type ChildAccount, type ChildAccountRole, type ChildAccountStatus, type CleanNoticesParams, type ContentGroupItem, type ContentGroupType, type ContentGroupTypeExtended, type Coupon, type CouponRule, type CouponViewer, type CreateAnchorParams, type CreateCardPushParams, type CreateCardPushResponse, type CreateCategoryParams, type CreateCategoryResponse, type CreateChannelParams, type CreateChannelRequest, type CreateChannelResponse, type CreateChildAccountParams, type CreateCouponParams, type CreateDistributeBatchParams, type CreateGroupUserParams, type CreateGroupUserResponse, type CreateLabelParams, type CreateLabelResponse, type CreateLotteryActivityParams, type CreateLotteryActivityResponse, type CreateMrChannelParams, type CreateMrChannelResponse, type CreateOrganizationParams, type CreateOrganizationResponse, type CreateProductParams, type CreateProductResponse, type CreateProductTagParams$1 as CreateProductTagParams, type CreateProductTagResponse$1 as CreateProductTagResponse, type CreateRoleParams, type CreateSessionParams, type CreateSessionResponse, type CreateTaskRewardParams, type CreateTaskRewardResponse, type CreateViewerLabelParams, type CreateViewerLabelResponse, type CreateViewerNameGroupParams, type CreateViewerRecordParams, type CreateWaitLotteryParams, type CreateWaitLotteryResponse, type CryptoSource, type CustomField, type DailyViewStatistics, type DecorateSettings, type DeepPartial, type DeleteAccountsParams, type DeleteCardPushParams, type DeleteCategoryParams, type DeleteCategoryResponse, type DeleteChannelProductParams, type DeleteChildAccountsParams, type DeleteCouponsBatchParams, type DeleteDistributeBatchParams, type DeleteLabelParams, type DeleteLotteryActivityParams, type DeleteMaterialsParams, type DeleteMaterialsResult, type DeleteOrganizationParams, type DeleteProductParams, type DeleteProductTagParams$1 as DeleteProductTagParams, type DeleteSessionParams, type DeleteTaskRewardParams, type DeleteVideoProduceParams, type DeleteViewerLabelParams, type DeleteViewerLabelRefParams, type DeleteViewerRecordParams, type DigitalHuman, type DigitalHumanInfo, type DigitalHumanOrganization, type DirectAuthViewerParams, type DiskVideoScriptDeleteParams, type DiskVideoScriptInfo, type DiskVideoScriptQueryParams, type DiskVideoScriptUploadParams, type DiskVideoScriptUploadResponse, type DistributeItem, type DistributeListResponse, type DistributeStatistic, type DocConvertStatusItem, type DocConvertType, type DocListResponse, type DocModel, type DocStatus, type DocType, type DonateSettings, type DonateTemplate, type DoubleTeacherType, ERROR_CATEGORIES, ERROR_MESSAGES, type EnvironmentInfo, type ErrorCategory, type ErrorCategoryName, ExportSessionStatsParams, ExportSessionStatsResponse, type ExternalViewerItem, type FollowViewer, type FullReduceRule, type GeoSummary, type GeoSummaryParams, type GetAccountViewerParams, type GetBillUseDetailListParams, type GetBillUseDetailListResponse, type GetByRoleParams, type GetBySaleParams, type GetCardPushParams, type GetCategoryListResponse, type GetChildAccountParams, type GetDailyViewStatisticsParams, type GetDailyViewStatisticsResponse, type GetDecorateParams, type GetDistributeStatisticParams, type GetDocListRequest, type GetDonateParams, type GetIncomeDetailParams, type GetIncomeDetailResponse, type GetInviteRankParams, type GetInviteStatsParams, type GetLiveSessionParams, type GetLotteryActivityParams, type GetMicDurationParams, type GetProductOrderParams, type GetProductSettingParams, type GetProductTagParams, type GetRelevanceParams, type GetRobotSettingParams, type GetRobotStatsParams, type GetRoleResponse, type GetSessionParams, type GetSessionStatsSummaryListParams, type GetSessionStatsSummaryListResponse, type GetShareParams, type GetSimpleChannelListParams, type GetSimpleChannelListResponse, type GetSubtitleParams, type GetTaskRewardParams, type GetTaskRewardStatsParams, type GetUserDurationsParams, type GetUserDurationsResponse, type GetUserInfoResponse, type GetVideoProduceParams, type GetVideoProducePptParams, type GetViewerDetailParams, type GetViewerRecordParams, type GetViewerUnionDetailParams, GetViewlogParams, GetViewlogResponse, type GetWatchLogDetailParams, type GetWatchLogListParams, type GetWatchLogListResponse, type GiftItem, type GiftPageParams, type GlobalFooterSettings, type GlobalSwitchSettings, type GroupAddParams, type GroupAllocateLogContent, type GroupDeleteParams, type GroupInfo, type GroupListParams, type GroupPaginatedResponse, type GroupPaginationParams, type GroupResponse, type GroupUpdateParams, type GroupUserPackage, type GroupViewerAddParams, type GroupViewerDeleteParams, type GroupViewerInfo, type GroupViewerListParams, type HeadAdvertParams, type HeadAdvertType, HttpMethod, type IllegalNotifySettings, type ImageFrequency, type ImportExternalViewerParams, type InfoField$1 as InfoField, type InteractionCallbackPayload, type InteractionEventDeleteParams, type InteractionEventSaveParams, type InteractionType, type InviteRankItem, type InviteSale, type InviteStats, type InviterCreateParams, type JsonArray, type JsonObject, type JsonValue, type Label, type LanguageInfo, type LikeItem, type LikePageParams, type ListAllocateLogParams, type ListAllocateLogResponse, type ListAllocationLogsParams, type ListAllocationLogsResponse, type ListAnchorRelationsParams, type ListAnchorsParams, type ListAnchorsResponse, type ListAudioModerationRecordsParams, type ListAudioModerationRecordsResponse, type ListBillingDailyParams, type ListBillingDailyResponse, type ListBulletinsParams, type ListBulletinsResponse, type ListChannelBasicParams, type ListChildAccountsParams, type ListChildAccountsResponse, type ListContentGroupsParams, type ListCustomFieldsResponse, type ListDigitalHumansParams, type ListDigitalHumansResponse, type ListDistributeParams, type ListFollowViewersParams, type ListFollowViewersResponse, type ListGroupUserPackagesParams, type ListGroupUserPackagesResponse, type ListInviteSalesResponse, type ListLabelsResponse, type ListLotteryActivitiesParams, type ListMaterialCategoriesParams, type ListMaterialCategoriesResponse, type ListMaterialsParams, type ListMaterialsResponse, type ListOrganizationsParams, type ListOrganizationsResponse, type ListProductOrdersParams, type ListProductOrdersResponse, type ListProductTagsParams, type ListProductTagsResponse, type ListProductsParams, type ListProductsResponse, type ListQaParams, type ListQaResponse, type ListRobotsParams, type ListRobotsResponse, type ListRolesParams, type ListRolesResponse, type ListSessionsParams, type ListSessionsResponse, type ListVideoModerationResultsParams, type ListVideoModerationResultsResponse, type ListVideoProducePptsParams, type ListVideoProducePptsResponse, type ListVideoProducesParams, type ListVideoProducesResponse, type ListViewerLabelsResponse, type ListViewerRecordsParams, type ListViewerRecordsResponse, type LiveSessionInfo, type LiveStatusCallbackPayload, type LiveStatusItem, type LiveStatusType, type LiveSummary, type LiveSummaryParams, type LogoParams, type LogoPosition, type LotteryActivity, type LotteryListParams, type LotteryStatistics, MAX_DATE_RANGE_DAYS, type MarqueeTemplate, type MarqueeUrlParams, type Material, type MaterialCategory, type MaterialExtData, type MaterialInfo, type MaterialPaginatedResponse, type MaterialPaginationParams, type MemberStatusCallbackPayload, type MemberStatusType, type MicDurationParams, type MicDurationResponse$1 as MicDurationResponse, type ModerationLabel, type ModerationResultType, type MonitorStreamInfo, type MrConcurrencyDetailResponse, type Mutable, type NewScene, type NonNullable, type OptionalKeys, type Organization, type PageMRecordParams, type PageMRecordResponse, type PageSetting, type PaginationOptions, type PaginationResponse, type PauseRobotParams, type Permission, type PlaybackCallbackPayload, type PlaybackItem, type PlaybackListParams, type PlaybackListResponse, type PlaybackSetting, type PlaybackVideoInfo, PolyVAPIError, type PolyVAPIErrorOptions, type PolyVAPIErrorResponse, PolyVClient, type PolyVClientConfig, PolyVError, PolyVErrorCode, type PolyVErrorOptions, PolyVValidationError, type PopularizationInfo, type PopularizationItem, type PopularizationListParams, PptStatus, type Primitive, type PrivacyParam, type Product, type ProductLinkType, type ProductOrder, type ProductPriceType, type ProductSetting, type ProductStatsItem, type ProductStatsPageParams, type ProductStatus, type ProductTag$1 as ProductTag, type ProductType, type PushCardParams, type PvShowEnableSettings, type Qa, type QaAnswer, type QueryPlaybackVideoInfoParams, type QueryWinnerViewerParams, type ReceiveListParams, type ReceiveListResponse, type RecordCallbackPayload, type RecordedFileItem, type RemoveInviteSaleParams, type RequestOptions, type RequireKeys, type ResolvedClientConfig, type Robot, type RobotSetting, type RobotStats, type Role, type RoleConfig, type RoleConfigTemplate, type RoleDetail, type RolePermission, type SaveRobotItem, type SearchCouponViewersParams, type SearchCouponViewersResponse, type SearchCouponsParams, type SearchCouponsResponse, type SendAdminMsgResponse, type SendCustomMessageEncodeParams, type SendCustomMessageParams, type SendSmsParams, type SessionInfo, type SessionRelevanceInfo, type SessionStatsSummary, type SetConcurrencesParams, type SetFlowParams, type SetLiveDurationsParams, type SetOrganizationsItem, type SetOrganizationsParams, type SetPlaybackCallbackParams, type SetPlaybackCallbackResponse, type SetPullBitrateParams, type SetRecordCallbackParams, type SetRecordCallbackResponse, type SetSpaceParams, type SetStreamCallbackParams, type SetStreamCallbackResponse, type SetUserChildrenLoginTokenParams, type SetUserChildrenLoginTokenResponse, type SetUserLoginTokenParams, type SetUserLoginTokenResponse, type SexType, type ShareSettings, type SignParams, type SignatureConfig, type SignatureInput, SignatureMethod, type SignatureOutput, type SignatureResult, type SortChannelProductParams, type SortOptions, type SsoConfigParams, type SsoConfigResponse, type SsoLoginParams, type SsoLoginResponse, type StatisticsCallbackPayload, type StopAdvertParams, type StopTaskRewardParams, type SubmitAcceptInfoParams, type SubtitleInfo$1 as SubtitleInfo, type SwitchGetResponse, type SwitchUpdateParams, type SwitchUpdateResponse, type TaskReward, type TaskRewardPageParams, type TaskRewardStats, type TaskRewardViewerDetail, type Template, type TtsVoice, type TtsVoiceInfo, TtsVoiceTag, type UnconditionalRule, type UpdateAccountParams, type UpdateAccountViewerParams, type UpdateAnchorParams, type UpdateAnchorStatusParams, type UpdateAudioModerationSettingParams, type UpdateAudioModerationSettingsParams, type UpdateAuthParams, type UpdateByRoleParams, type UpdateCallbackParams, type UpdateCardPushParams, type UpdateCategoryNameParams, type UpdateCategoryNameResponse, type UpdateCategoryRankParams, type UpdateCategoryRankResponse, type UpdateChannelParams, type UpdateChannelProductParams, type UpdateChannelRequest, type UpdateChannelSubtitleParams, type UpdateChannelTemplateParams, type UpdateChatEnabledParams, type UpdateChildAccountParams, type UpdateCouponParams, type UpdateCouponsStatusBatchParams, type UpdateDecorateParams, type UpdateDistributeBatchParams, type UpdateDonateParams, type UpdateDonateTemplateParams, type UpdateGlobalFooterParams, type UpdateGlobalSwitchParams, type UpdateGroupUserPackageParams, type UpdateInviteSaleParams, type UpdateLabelParams, type UpdateLotteryActivityParams, type UpdateMarqueeTemplateParams, type UpdateMasterSwitchParams, type UpdatePageSettingParams, type UpdatePlaybackSettingParams, type UpdateProductParams, type UpdateProductSettingParams, type UpdateProductTagParams$1 as UpdateProductTagParams, type UpdatePvShowEnableParams, type UpdateRobotSettingParams, type UpdateRoleConfigTemplateParams, type UpdateRoleParams, type UpdateSessionParams, type UpdateShareParams, type UpdateSkinParams, type UpdateSubtitleParams, type UpdateSwitchParams, type UpdateTaskRewardParams, type UpdateVideoModerationSettingParams, type UpdateVideoModerationSettingsParams, type UpdateViewerLabelParams, type UpdateViewerRecordParams, type UploadDocRequest, type UploadDocResponse, type UploadOptions, type UploadProgress, type UploadVideoProducePptParams, type UploadVideoProducePptResponse, type UserChannelBasicListParams, type UserChannelBasicListResponse, type CreateProductTagParams as UserCreateProductTagParams, type CreateProductTagResponse as UserCreateProductTagResponse, type DeleteProductTagParams as UserDeleteProductTagParams, type MicDurationResponse as UserMicDurationResponse, type UserPaginatedResponse, type UserPaginationParams, type UserPlaybackListParams, type UserPlaybackListResponse, type ProductTag as UserProductTag, type UpdateProductTagParams as UserUpdateProductTagParams, type ChannelDetail as V4ChannelDetail, type SubtitleInfo as V4ChannelSubtitleInfo, type V4PaginatedResponse, type V4PaginationParams, VERSION, type ValidationConstraints, type VersionConfig, type VideoModerationResultItem, type VideoModerationSetting, type VideoModerationSettings, type VideoModerationStrategy, type VideoProducePpt, VideoProduceStatus, type VideoProduceTask, type ViewerLabel, type ViewerLogoutParams, type ViewerLotteryWinParams, type ViewerLotteryWinResponse, type ViewerRecord, type ViewerSource, ViewlogItem, type WatchFeedbackItem, type WatchFeedbackListParams, type WatchFeedbackListResponse, type WatchLogDetailResponse, type WatchLogItem, type WatchType, type WatermarkFontSize, type WeixinBookingStats, type WeixinBookingStatsParams, type WinnerViewerInfo, type YNEnabled, type YNFlag$1 as YNFlag, type cleanChatParams, collectAll, createSignature, type delChatParams, generateSignature, generateTimestamp, getEnvironmentInfo, getErrorCodeCategory, getErrorMessage, getErrorMessageByCode, type getHistoryPageParams, isBrowser, isNode, isPolyVAPIError, isPolyVError, isPolyVErrorCode, isPolyVValidationError, isStartDateBeforeEndDate, isValidDateFormat, isWebWorker, paginate, type sendAdminMsgParams, sortParams, validateDateRange };
|