polyv-live-api-sdk 1.0.13 → 1.0.14
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/README.md +21 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/index.cjs +8747 -5683
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +12589 -9410
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +8727 -5684
- package/dist/index.js.map +1 -1
- package/dist/services/account.service.d.ts +34 -26
- package/dist/services/account.service.d.ts.map +1 -1
- package/dist/services/channel.service.d.ts +373 -8
- package/dist/services/channel.service.d.ts.map +1 -1
- package/dist/services/chat.service.d.ts +12 -1
- package/dist/services/chat.service.d.ts.map +1 -1
- package/dist/services/finance.service.d.ts +16 -1
- package/dist/services/finance.service.d.ts.map +1 -1
- package/dist/services/index.d.ts +1 -0
- package/dist/services/index.d.ts.map +1 -1
- package/dist/services/live-interaction.service.d.ts +66 -385
- package/dist/services/live-interaction.service.d.ts.map +1 -1
- package/dist/services/v4/ai.service.d.ts +14 -2
- package/dist/services/v4/ai.service.d.ts.map +1 -1
- package/dist/services/v4/channel.service.d.ts +323 -23
- package/dist/services/v4/channel.service.d.ts.map +1 -1
- package/dist/services/v4/chat.service.d.ts +25 -4
- package/dist/services/v4/chat.service.d.ts.map +1 -1
- package/dist/services/v4/group.service.d.ts +14 -1
- package/dist/services/v4/group.service.d.ts.map +1 -1
- package/dist/services/v4/material.service.d.ts +37 -1
- package/dist/services/v4/material.service.d.ts.map +1 -1
- package/dist/services/v4/user.service.d.ts +113 -68
- package/dist/services/v4/user.service.d.ts.map +1 -1
- package/dist/services/web.service.d.ts +5 -5
- package/dist/services/web.service.d.ts.map +1 -1
- package/dist/types/account.d.ts +205 -86
- package/dist/types/account.d.ts.map +1 -1
- package/dist/types/channel.d.ts +874 -18
- package/dist/types/channel.d.ts.map +1 -1
- package/dist/types/chat.d.ts +3 -0
- package/dist/types/chat.d.ts.map +1 -1
- package/dist/types/client.d.ts +6 -2
- package/dist/types/client.d.ts.map +1 -1
- package/dist/types/finance.d.ts +69 -0
- package/dist/types/finance.d.ts.map +1 -1
- package/dist/types/index.d.ts +20 -19
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/live-interaction.d.ts +170 -171
- package/dist/types/live-interaction.d.ts.map +1 -1
- package/dist/types/v4-ai.d.ts +39 -0
- package/dist/types/v4-ai.d.ts.map +1 -1
- package/dist/types/v4-channel.d.ts +900 -82
- package/dist/types/v4-channel.d.ts.map +1 -1
- package/dist/types/v4-chat.d.ts +15 -4
- package/dist/types/v4-chat.d.ts.map +1 -1
- package/dist/types/v4-group.d.ts +41 -0
- package/dist/types/v4-group.d.ts.map +1 -1
- package/dist/types/v4-material.d.ts +46 -0
- package/dist/types/v4-material.d.ts.map +1 -1
- package/dist/types/v4-robot.d.ts +28 -0
- package/dist/types/v4-robot.d.ts.map +1 -1
- package/dist/types/v4-user.d.ts +816 -207
- package/dist/types/v4-user.d.ts.map +1 -1
- package/dist/types/web.d.ts +55 -39
- package/dist/types/web.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* @module services/account
|
|
8
8
|
*/
|
|
9
9
|
import type { PolyVClient } from '../client.js';
|
|
10
|
-
import type { GetCategoryListResponse, CreateCategoryParams, CreateCategoryResponse, DeleteCategoryParams, DeleteCategoryResponse, UpdateCategoryNameParams, UpdateCategoryNameResponse, UpdateCategoryRankParams, UpdateCategoryRankResponse, GetUserInfoResponse, ChannelsParams, ChannelsResponse, ChannelDetailParams, ChannelDetailResponse, GetSimpleChannelListParams, GetSimpleChannelListResponse, UserChannelBasicListParams, UserChannelBasicListResponse, UserPlaybackListParams, UserPlaybackListResponse, ReceiveListParams, ReceiveListResponse, GetIncomeDetailParams, GetIncomeDetailResponse, GetUserDurationsParams, GetUserDurationsResponse, MicDurationParams, MicDurationResponse, SwitchGetParams, SwitchGetResponse, SwitchUpdateParams, SwitchUpdateResponse, SetStreamCallbackParams, SetStreamCallbackResponse, SetRecordCallbackParams, SetRecordCallbackResponse, SetPlaybackCallbackParams, SetPlaybackCallbackResponse, SetUserLoginTokenParams, SetUserLoginTokenResponse, SetUserChildrenLoginTokenParams, SetUserChildrenLoginTokenResponse, SsoLoginParams, SsoLoginResponse, SsoConfigParams, SsoConfigResponse } from '../types/account.js';
|
|
10
|
+
import type { GetCategoryListResponse, CreateCategoryParams, CreateCategoryResponse, DeleteCategoryParams, DeleteCategoryResponse, UpdateCategoryNameParams, UpdateCategoryNameResponse, UpdateCategoryRankParams, UpdateCategoryRankResponse, GetUserInfoResponse, ChannelsParams, ChannelsResponse, ChannelDetailParams, ChannelDetailResponse, ChannelDetailListParams, ChannelDetailListResponse, GetSimpleChannelListParams, GetSimpleChannelListResponse, UserChannelBasicListParams, UserChannelBasicListResponse, UserPlaybackListParams, UserPlaybackListResponse, ReceiveListParams, ReceiveListResponse, GetIncomeDetailParams, GetIncomeDetailResponse, GetUserDurationsParams, GetUserDurationsResponse, MicDurationParams, MicDurationResponse, SwitchGetParams, SwitchGetResponse, SwitchUpdateParams, SwitchUpdateResponse, SetStreamCallbackParams, SetStreamCallbackResponse, SetRecordCallbackParams, SetRecordCallbackResponse, SetPlaybackCallbackParams, SetPlaybackCallbackResponse, SetUserLoginTokenParams, SetUserLoginTokenResponse, SetUserChildrenLoginTokenParams, SetUserChildrenLoginTokenResponse, SsoLoginParams, SsoLoginResponse, SsoConfigParams, SsoConfigResponse } from '../types/account.js';
|
|
11
11
|
/**
|
|
12
12
|
* AccountService
|
|
13
13
|
*
|
|
@@ -28,7 +28,13 @@ export declare class AccountService {
|
|
|
28
28
|
*/
|
|
29
29
|
constructor(client: PolyVClient);
|
|
30
30
|
private compactParams;
|
|
31
|
+
private validateRequiredString;
|
|
32
|
+
private validatePositiveInteger;
|
|
33
|
+
private validatePageParams;
|
|
34
|
+
private validateDate;
|
|
35
|
+
private validateCallbackUrl;
|
|
31
36
|
private normalizeEnabled;
|
|
37
|
+
private successResponse;
|
|
32
38
|
/**
|
|
33
39
|
* Get category list
|
|
34
40
|
* Query all live categories for the account
|
|
@@ -117,19 +123,18 @@ export declare class AccountService {
|
|
|
117
123
|
*/
|
|
118
124
|
getUserInfo(): Promise<GetUserInfoResponse>;
|
|
119
125
|
/**
|
|
120
|
-
* Get channel list
|
|
126
|
+
* Get channel ID list
|
|
121
127
|
*
|
|
122
128
|
* @param params - Query parameters
|
|
123
|
-
* @returns
|
|
129
|
+
* @returns Channel ID list
|
|
124
130
|
*
|
|
125
131
|
* @example
|
|
126
132
|
* ```typescript
|
|
127
133
|
* const result = await client.account.channels({
|
|
128
|
-
* page: 1,
|
|
129
|
-
* pageSize: 10,
|
|
130
134
|
* categoryId: 123,
|
|
135
|
+
* keyword: 'demo',
|
|
131
136
|
* });
|
|
132
|
-
* console.log(result.
|
|
137
|
+
* console.log(result.channels);
|
|
133
138
|
* ```
|
|
134
139
|
*/
|
|
135
140
|
channels(params?: ChannelsParams): Promise<ChannelsResponse>;
|
|
@@ -148,6 +153,13 @@ export declare class AccountService {
|
|
|
148
153
|
* ```
|
|
149
154
|
*/
|
|
150
155
|
channelDetail(params: ChannelDetailParams): Promise<ChannelDetailResponse>;
|
|
156
|
+
/**
|
|
157
|
+
* Get channel detail list
|
|
158
|
+
*
|
|
159
|
+
* @param params - Query parameters
|
|
160
|
+
* @returns Paginated channel detail list
|
|
161
|
+
*/
|
|
162
|
+
channelDetailList(params?: ChannelDetailListParams): Promise<ChannelDetailListResponse>;
|
|
151
163
|
/**
|
|
152
164
|
* Get simple channel list (lightweight)
|
|
153
165
|
*
|
|
@@ -175,7 +187,8 @@ export declare class AccountService {
|
|
|
175
187
|
* ```typescript
|
|
176
188
|
* const result = await client.account.userChannelBasicList({
|
|
177
189
|
* page: 1,
|
|
178
|
-
* pageSize:
|
|
190
|
+
* pageSize: 20,
|
|
191
|
+
* categoryIds: '340019,345134',
|
|
179
192
|
* });
|
|
180
193
|
* console.log(result.contents);
|
|
181
194
|
* ```
|
|
@@ -200,7 +213,7 @@ export declare class AccountService {
|
|
|
200
213
|
*/
|
|
201
214
|
userPlaybackList(params?: UserPlaybackListParams): Promise<UserPlaybackListResponse>;
|
|
202
215
|
/**
|
|
203
|
-
* Get receive
|
|
216
|
+
* Get channels that can receive a transmission
|
|
204
217
|
*
|
|
205
218
|
* @param params - Query parameters
|
|
206
219
|
* @returns Receive list
|
|
@@ -208,10 +221,9 @@ export declare class AccountService {
|
|
|
208
221
|
* @example
|
|
209
222
|
* ```typescript
|
|
210
223
|
* const result = await client.account.receiveList({
|
|
224
|
+
* channelId: '2788479',
|
|
211
225
|
* page: 1,
|
|
212
226
|
* pageSize: 10,
|
|
213
|
-
* startDate: '2024-01-01',
|
|
214
|
-
* endDate: '2024-01-31',
|
|
215
227
|
* });
|
|
216
228
|
* console.log(result.contents);
|
|
217
229
|
* ```
|
|
@@ -226,40 +238,35 @@ export declare class AccountService {
|
|
|
226
238
|
* @example
|
|
227
239
|
* ```typescript
|
|
228
240
|
* const result = await client.account.getIncomeDetail({
|
|
241
|
+
* userId: '1b448be323',
|
|
229
242
|
* startDate: '2024-01-01',
|
|
230
243
|
* endDate: '2024-01-31',
|
|
231
244
|
* });
|
|
232
|
-
* console.log(result.
|
|
245
|
+
* console.log(result.contents);
|
|
233
246
|
* ```
|
|
234
247
|
*/
|
|
235
248
|
getIncomeDetail(params?: GetIncomeDetailParams): Promise<GetIncomeDetailResponse>;
|
|
236
249
|
/**
|
|
237
|
-
* Get
|
|
250
|
+
* Get account live duration balance
|
|
238
251
|
*
|
|
239
|
-
* @param params - Query parameters
|
|
240
252
|
* @returns User durations
|
|
241
253
|
*
|
|
242
254
|
* @example
|
|
243
255
|
* ```typescript
|
|
244
|
-
* const result = await client.account.getUserDurations(
|
|
245
|
-
*
|
|
246
|
-
* });
|
|
247
|
-
* console.log(result.durations);
|
|
256
|
+
* const result = await client.account.getUserDurations();
|
|
257
|
+
* console.log(result.available, result.used);
|
|
248
258
|
* ```
|
|
249
259
|
*/
|
|
250
260
|
getUserDurations(params?: GetUserDurationsParams): Promise<GetUserDurationsResponse>;
|
|
251
261
|
/**
|
|
252
|
-
* Get mic
|
|
262
|
+
* Get account mic duration statistics
|
|
253
263
|
*
|
|
254
|
-
* @param params - Query parameters
|
|
255
264
|
* @returns Mic duration
|
|
256
265
|
*
|
|
257
266
|
* @example
|
|
258
267
|
* ```typescript
|
|
259
|
-
* const result = await client.account.micDuration(
|
|
260
|
-
*
|
|
261
|
-
* });
|
|
262
|
-
* console.log(result.micDuration);
|
|
268
|
+
* const result = await client.account.micDuration();
|
|
269
|
+
* console.log(result.available, result.history);
|
|
263
270
|
* ```
|
|
264
271
|
*/
|
|
265
272
|
micDuration(params?: MicDurationParams): Promise<MicDurationResponse>;
|
|
@@ -270,8 +277,8 @@ export declare class AccountService {
|
|
|
270
277
|
*
|
|
271
278
|
* @example
|
|
272
279
|
* ```typescript
|
|
273
|
-
* const result = await client.account.switchGet();
|
|
274
|
-
* console.log(result
|
|
280
|
+
* const result = await client.account.switchGet({ channelId: '123456' });
|
|
281
|
+
* console.log(result[0]);
|
|
275
282
|
* ```
|
|
276
283
|
*/
|
|
277
284
|
switchGet(params?: SwitchGetParams): Promise<SwitchGetResponse>;
|
|
@@ -284,7 +291,8 @@ export declare class AccountService {
|
|
|
284
291
|
* @example
|
|
285
292
|
* ```typescript
|
|
286
293
|
* const result = await client.account.switchUpdate({
|
|
287
|
-
*
|
|
294
|
+
* channelId: '123456',
|
|
295
|
+
* type: 'mobileWatch',
|
|
288
296
|
* enabled: 'Y',
|
|
289
297
|
* });
|
|
290
298
|
* console.log(result.success);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"account.service.d.ts","sourceRoot":"","sources":["../../src/services/account.service.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,KAAK,EAEV,uBAAuB,EACvB,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACnB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,0BAA0B,EAC1B,4BAA4B,EAC5B,0BAA0B,EAC1B,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,wBAAwB,EACxB,iBAAiB,EACjB,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,yBAAyB,EACzB,yBAAyB,EACzB,2BAA2B,EAC3B,uBAAuB,EACvB,yBAAyB,EACzB,+BAA+B,EAC/B,iCAAiC,EACjC,cAAc,EACd,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EAClB,MAAM,qBAAqB,CAAC;AAG7B;;;;;;;;;;GAUG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAc;IAE5B;;;;OAIG;gBACS,MAAM,EAAE,WAAW;IAI/B,OAAO,CAAC,aAAa;IAQrB,OAAO,CAAC,gBAAgB;
|
|
1
|
+
{"version":3,"file":"account.service.d.ts","sourceRoot":"","sources":["../../src/services/account.service.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,KAAK,EAEV,uBAAuB,EACvB,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACxB,0BAA0B,EAC1B,mBAAmB,EACnB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,4BAA4B,EAC5B,0BAA0B,EAC1B,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACxB,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,wBAAwB,EACxB,iBAAiB,EACjB,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,yBAAyB,EACzB,yBAAyB,EACzB,2BAA2B,EAC3B,uBAAuB,EACvB,yBAAyB,EACzB,+BAA+B,EAC/B,iCAAiC,EACjC,cAAc,EACd,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EAClB,MAAM,qBAAqB,CAAC;AAG7B;;;;;;;;;;GAUG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAc;IAE5B;;;;OAIG;gBACS,MAAM,EAAE,WAAW;IAI/B,OAAO,CAAC,aAAa;IAQrB,OAAO,CAAC,sBAAsB;IAQ9B,OAAO,CAAC,uBAAuB;IAO/B,OAAO,CAAC,kBAAkB;IAK1B,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,mBAAmB;IAa3B,OAAO,CAAC,gBAAgB;IAYxB,OAAO,CAAC,eAAe;IAQvB;;;;;;;;;;;OAWG;IACG,eAAe,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAOzD;;;;;;;;;;;;;OAaG;IACG,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAanF;;;;;;;;;;;;;OAaG;IACG,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAanF;;;;;;;;;;;;;;OAcG;IACG,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAgB/F;;;;;;;;;;;;;;OAcG;IACG,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAoB/F;;;;;;;;;;OAUG;IACG,WAAW,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAWjD;;;;;;;;;;;;;;OAcG;IACG,QAAQ,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAQlE;;;;;;;;;;;;;OAaG;IACG,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAYhF;;;;;OAKG;IACG,iBAAiB,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAW7F;;;;;;;;;;;;;;;OAeG;IACG,oBAAoB,CAAC,MAAM,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAUtG;;;;;;;;;;;;;;;OAeG;IACG,oBAAoB,CAAC,MAAM,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAkBtG;;;;;;;;;;;;;;;;OAgBG;IACG,gBAAgB,CAAC,MAAM,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAY1F;;;;;;;;;;;;;;;OAeG;IACG,WAAW,CAAC,MAAM,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAW3E;;;;;;;;;;;;;;;OAeG;IACG,eAAe,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAkBvF;;;;;;;;;;OAUG;IACG,gBAAgB,CAAC,MAAM,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAS1F;;;;;;;;;;OAUG;IACG,WAAW,CAAC,MAAM,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAY3E;;;;;;;;;;OAUG;IACG,SAAS,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAQrE;;;;;;;;;;;;;;;OAeG;IACG,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAwB7E;;;;;;;;;;;;;OAaG;IACG,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAY5F;;;;;;;;;;;;;OAaG;IACG,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAY5F;;;;;;;;;;;;;OAaG;IACG,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAgBlG;;;;;;;;;;;;;OAaG;IACG,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAa5F;;;;;;;;;;;;;;OAcG;IACG,yBAAyB,CAAC,MAAM,EAAE,+BAA+B,GAAG,OAAO,CAAC,iCAAiC,CAAC;IAqBpH;;;;;;;;;;;;;;OAcG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYjE;;;;;;;;;;;;;;;OAeG;IACG,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAgBrE"}
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
* @module services/channel
|
|
8
8
|
*/
|
|
9
9
|
import type { PolyVClient } from '../client.js';
|
|
10
|
-
import type { ChannelModel, ChannelDetail, CreateChannelRequest, CreateChannelV4Request, CreateChannelV4Response, UpdateChannelRequest, UpdateWatchConditionRequest, ChannelApiTokenResponse, GetChannelApiTokenRequest, GetTestModeTokenRequest, GetDocListRequest, DocListResponse, UploadDocRequest, UploadDocResponse, DocConvertStatusItem, MultimediaResourceVidListResponse, MultimediaResourceDetailResponse, PaginationParams, UserMultimediaResourceResponse, DocType, PlaybackListResponse, PlaybackListRequest, PlaybackSettingResponse, AddVodPlaybackRequest, ClipRecordFileRequest, RecordAddBreakpointRequest, PlayerLogoSettings, PlayerHeadSettings, PlayerStopSettings, GetProductClickStatsRequest, GetProductClickStatsResponse, GetProductListStatsRequest, GetProductListStatsResponse, GetRedpackStatsRequest, GetRedpackStatsResponse, ChannelSummaryItem, DailySummaryItem, ChannelPlaySummaryItem, ConcurrencyDataItem, RealtimeViewerDataItem, RealtimeViewerV1Item, SessionStatsResponse, GetViewlogPageResponse, UserViewlogItem, GetUserViewlogResponse, GetMicDetailListResponse, GetLinkMicDetailListResponse, ChannelStatisticData, RealviewersDataItem, ViewlogV2Item, GetViewlogPageV3Response, SetDiyUrlMarqueeRequest, GetSessionDataListRequest, GetSessionDataListResponse, ExportSessionStatsRequest, GetSessionByExternalRequest, GetSessionByExternalResponse, ListFileIdByExternalRequest, FileIdByExternalItem, RelevanceSessionRequest, LiveStatus, LiveStatusItem, GetStreamInfoResponse, GetStreamsItem, ListDiskVideoRequest, ListDiskVideoResponse, SetStatusRequest, BanPushRequest, EndDiskPushRequest, UpdateWarmupSwitchRequest, UpdateWarmupImageRequest, UpdateWarmupVideoRequest, AddChannelProductParams, AddChannelProductResponse, UpdateChannelProductParams, DeleteChannelProductParams, UpdateChannelProductEnabledParams, UpdateChannelConfigParams, ListChannelProductsParams, ListChannelProductsResponse } from '../types/channel.js';
|
|
10
|
+
import type { ChannelModel, ChannelDetail, CreateChannelRequest, CreateChannelV4Request, CreateChannelV4Response, UpdateChannelRequest, UpdateWatchConditionRequest, ChannelApiTokenResponse, GetChannelApiTokenRequest, GetTestModeTokenRequest, GetDocListRequest, DocListResponse, UploadDocRequest, UploadDocResponse, DocConvertStatusItem, MultimediaResourceVidListResponse, MultimediaResourceDetailResponse, PaginationParams, UserMultimediaResourceResponse, DocType, PlaybackListResponse, PlaybackListRequest, ChannelSessionsResponse, PlaybackSettingResponse, AddVodPlaybackRequest, ClipRecordFileRequest, RecordAddBreakpointRequest, ListChannelSessionsParams, ListRecordFilesParams, ListRecordFilesResponse, MergeRecordFilesParams, MergeRecordFilesResponse, AddVodPlaybackToLibraryParams, AddVodPlaybackToLibraryResponse, DeleteRecordFileParams, ConvertRecordFileToVodParams, ConvertRecordFileToVodResponse, SetUserPlaybackEnabledParams, SetUserPlaybackEnabledResponse, MovePlaybackVideoParams, SetDefaultPlaybackVideoParams, SortPlaybackVideosParams, PlayerLogoSettings, PlayerHeadSettings, PlayerStopSettings, GetProductClickStatsRequest, GetProductClickStatsResponse, GetProductListStatsRequest, GetProductListStatsResponse, GetRedpackStatsRequest, GetRedpackStatsResponse, ChannelSummaryItem, DailySummaryItem, ChannelPlaySummaryItem, ConcurrencyDataItem, RealtimeViewerDataItem, RealtimeViewerV1Item, SessionStatsResponse, GetViewlogPageResponse, UserViewlogItem, GetUserViewlogResponse, GetMicDetailListResponse, GetLinkMicDetailListResponse, ChannelStatisticData, RealviewersDataItem, ViewlogV2Item, GetViewlogPageV3Response, SetDiyUrlMarqueeRequest, GetSessionDataListRequest, GetSessionDataListResponse, ExportSessionStatsRequest, GetSessionByExternalRequest, GetSessionByExternalResponse, ListFileIdByExternalRequest, FileIdByExternalItem, RelevanceSessionRequest, LiveStatus, LiveStatusItem, GetStreamInfoResponse, GetStreamsItem, ListDiskVideoRequest, ListDiskVideoResponse, SetStatusRequest, BanPushRequest, EndDiskPushRequest, UpdateWarmupSwitchRequest, UpdateWarmupImageRequest, UpdateWarmupVideoRequest, ChannelAdvert, ChannelProductEnabledResponse, PptRecordSettingResponse, ListPptRecordTasksParams, ListPptRecordTasksResponse, GetTransmitAssociationsParams, TransmitAssociation, GetUserChildrenChannelsParams, GetUserChildrenChannelsResponse, ListChannelsFollowParams, ListChannelsFollowResponse, AddPptRecordTaskParams, PptRecordMutationResponse, UpdatePptRecordSettingParams, DeletePptRecordParams, ViewerApiTokenParams, ViewerApiTokenResponse, ChatTokenParams, ChatTokenResponse, TokenLoginUrlParams, TokenLoginUrlResponse, BatchAddTransmitParams, BatchAddTransmitResponse, BatchAddSubmeetingParams, BatchAddSubmeetingResponse, AssociationReceiveChannelsParams, AssociationReceiveChannelsResponse, RemoveChatContentsParams, BatchDeleteChannelProductParams, BatchAddChannelProductsParams, BatchAddChannelProductsResponse, BatchShelfChannelProductParams, ProductIdParams, ShelfChannelProductParams, PushChannelProductParams, SortChannelProductOrderParams, ReferenceProductParams, ReferenceProductResponse, DeleteDiskVideosParams, AddDiskVideosParams, SetChannelTokenParams, StopQuestionnaireParams, StopQuestionnaireResponse, BatchUpdateDanmuParams, UpdateChannelsFollowParams, UpdateStreamTypeParams, AddChannelProductParams, AddChannelProductResponse, UpdateChannelProductParams, DeleteChannelProductParams, UpdateChannelProductEnabledParams, UpdateChannelConfigParams, ListChannelProductsParams, ListChannelProductsResponse, ListChannelViewerGroupsParams, ListChannelViewerGroupsResponse, CreateChannelViewerGroupParams, UpdateChannelViewerGroupParams, DeleteChannelViewerGroupParams, ChannelViewerGroup, GetChannelViewerGroupSettingParams, UpdateChannelViewerGroupSettingParams, ChannelViewerGroupSetting, ListChannelViewersParams, ListChannelViewersResponse, ExportChannelViewersParams, ExportChannelViewersResponse, AddChannelViewersParams, DeleteChannelViewersParams, TransferChannelViewersParams, ImportChannelViewersParams, ImportChannelViewersResponse, ListUnrelatedChannelViewersParams, ListUnrelatedChannelViewersResponse } from '../types/channel.js';
|
|
11
11
|
/**
|
|
12
12
|
* ChannelService
|
|
13
13
|
*
|
|
@@ -31,6 +31,24 @@ export declare class ChannelService {
|
|
|
31
31
|
* @param client - The PolyVClient instance to use for API calls
|
|
32
32
|
*/
|
|
33
33
|
constructor(client: PolyVClient);
|
|
34
|
+
private validateChannelViewerScope;
|
|
35
|
+
private buildLiveBgConfig;
|
|
36
|
+
private validateRequiredValue;
|
|
37
|
+
private validateRequiredText;
|
|
38
|
+
private validateOptionalText;
|
|
39
|
+
private validateOptionalYn;
|
|
40
|
+
private validateOptionalPage;
|
|
41
|
+
private validatePositiveInteger;
|
|
42
|
+
private normalizeCommaSeparatedValues;
|
|
43
|
+
private normalizeOptionalCommaSeparatedValues;
|
|
44
|
+
private validateRequiredYn;
|
|
45
|
+
private validateStringArray;
|
|
46
|
+
private validateNumberArray;
|
|
47
|
+
private validateProductStatus;
|
|
48
|
+
private validateViewerIds;
|
|
49
|
+
private normalizeCommaSeparated;
|
|
50
|
+
private validateChannelViewerListParams;
|
|
51
|
+
private validateUnrelatedChannelViewerParams;
|
|
34
52
|
/**
|
|
35
53
|
* Validate create channel request parameters (V2 API - deprecated)
|
|
36
54
|
*/
|
|
@@ -655,6 +673,46 @@ export declare class ChannelService {
|
|
|
655
673
|
* ```
|
|
656
674
|
*/
|
|
657
675
|
batchCreateAccounts(channelId: string, accounts: import('../types/channel.js').BatchCreateAccountItem[]): Promise<import('../types/channel.js').AccountModel[]>;
|
|
676
|
+
/**
|
|
677
|
+
* List channel live sessions using the historical playback API.
|
|
678
|
+
*/
|
|
679
|
+
listChannelSessions(params: ListChannelSessionsParams): Promise<ChannelSessionsResponse>;
|
|
680
|
+
/**
|
|
681
|
+
* List historical recording files for a channel.
|
|
682
|
+
*/
|
|
683
|
+
listRecordFiles(params: ListRecordFilesParams): Promise<ListRecordFilesResponse>;
|
|
684
|
+
/**
|
|
685
|
+
* Merge historical recording files by URL or file ID.
|
|
686
|
+
*/
|
|
687
|
+
mergeRecordFiles(params: MergeRecordFilesParams): Promise<MergeRecordFilesResponse>;
|
|
688
|
+
/**
|
|
689
|
+
* Add a VOD video to a channel playback library.
|
|
690
|
+
*/
|
|
691
|
+
addVodPlaybackToLibrary(params: AddVodPlaybackToLibraryParams): Promise<AddVodPlaybackToLibraryResponse>;
|
|
692
|
+
/**
|
|
693
|
+
* Delete historical recording files by session ID or start time.
|
|
694
|
+
*/
|
|
695
|
+
deleteRecordFile(params: DeleteRecordFileParams): Promise<void>;
|
|
696
|
+
/**
|
|
697
|
+
* Convert a historical recording file to VOD synchronously.
|
|
698
|
+
*/
|
|
699
|
+
convertRecordFileToVod(params: ConvertRecordFileToVodParams): Promise<ConvertRecordFileToVodResponse>;
|
|
700
|
+
/**
|
|
701
|
+
* Set playback enabled by user scope.
|
|
702
|
+
*/
|
|
703
|
+
setUserPlaybackEnabled(params: SetUserPlaybackEnabledParams): Promise<SetUserPlaybackEnabledResponse>;
|
|
704
|
+
/**
|
|
705
|
+
* Move a playback or VOD video up/down.
|
|
706
|
+
*/
|
|
707
|
+
movePlaybackVideo(params: MovePlaybackVideoParams): Promise<void>;
|
|
708
|
+
/**
|
|
709
|
+
* Set the default playback or VOD video.
|
|
710
|
+
*/
|
|
711
|
+
setDefaultPlaybackVideo(params: SetDefaultPlaybackVideoParams): Promise<string>;
|
|
712
|
+
/**
|
|
713
|
+
* Sort playback or VOD videos with a complete ordered video ID list.
|
|
714
|
+
*/
|
|
715
|
+
sortPlaybackVideos(params: SortPlaybackVideosParams): Promise<void>;
|
|
658
716
|
/**
|
|
659
717
|
* Get playback list
|
|
660
718
|
*
|
|
@@ -709,20 +767,20 @@ export declare class ChannelService {
|
|
|
709
767
|
/**
|
|
710
768
|
* Get record file
|
|
711
769
|
*
|
|
712
|
-
* Retrieves
|
|
770
|
+
* Retrieves information about a specific temporary record file.
|
|
713
771
|
*
|
|
714
772
|
* @param channelId - The channel ID
|
|
715
|
-
* @param
|
|
716
|
-
* @returns
|
|
717
|
-
* @throws PolyVValidationError if channelId is empty
|
|
773
|
+
* @param fileId - The temporary record file ID
|
|
774
|
+
* @returns Record file detail
|
|
775
|
+
* @throws PolyVValidationError if channelId or fileId is empty
|
|
718
776
|
*
|
|
719
777
|
* @example
|
|
720
778
|
* ```typescript
|
|
721
|
-
* const result = await channelService.getRecordFile('ch123456',
|
|
722
|
-
* console.log(result.
|
|
779
|
+
* const result = await channelService.getRecordFile('ch123456', 'file123');
|
|
780
|
+
* console.log(result.fileId);
|
|
723
781
|
* ```
|
|
724
782
|
*/
|
|
725
|
-
getRecordFile(channelId: string,
|
|
783
|
+
getRecordFile(channelId: string, fileId: string): Promise<import('../types/channel.js').RecordFileResponse>;
|
|
726
784
|
/**
|
|
727
785
|
* Get record info
|
|
728
786
|
*
|
|
@@ -1730,6 +1788,58 @@ export declare class ChannelService {
|
|
|
1730
1788
|
* ```
|
|
1731
1789
|
*/
|
|
1732
1790
|
relevanceSession(options: RelevanceSessionRequest): Promise<string>;
|
|
1791
|
+
/**
|
|
1792
|
+
* List channel viewer groups.
|
|
1793
|
+
*/
|
|
1794
|
+
listChannelViewerGroups(params: ListChannelViewerGroupsParams): Promise<ListChannelViewerGroupsResponse>;
|
|
1795
|
+
/**
|
|
1796
|
+
* Create a channel viewer group.
|
|
1797
|
+
*/
|
|
1798
|
+
createChannelViewerGroup(params: CreateChannelViewerGroupParams): Promise<ChannelViewerGroup>;
|
|
1799
|
+
/**
|
|
1800
|
+
* Update a channel viewer group.
|
|
1801
|
+
*/
|
|
1802
|
+
updateChannelViewerGroup(params: UpdateChannelViewerGroupParams): Promise<void>;
|
|
1803
|
+
/**
|
|
1804
|
+
* Delete a channel viewer group.
|
|
1805
|
+
*/
|
|
1806
|
+
deleteChannelViewerGroup(params: DeleteChannelViewerGroupParams): Promise<void>;
|
|
1807
|
+
/**
|
|
1808
|
+
* Get channel viewer group setting.
|
|
1809
|
+
*/
|
|
1810
|
+
getChannelViewerGroupSetting(params: GetChannelViewerGroupSettingParams): Promise<ChannelViewerGroupSetting>;
|
|
1811
|
+
/**
|
|
1812
|
+
* Update channel viewer group setting.
|
|
1813
|
+
*/
|
|
1814
|
+
updateChannelViewerGroupSetting(params: UpdateChannelViewerGroupSettingParams): Promise<void>;
|
|
1815
|
+
/**
|
|
1816
|
+
* List viewers belonging to a channel.
|
|
1817
|
+
*/
|
|
1818
|
+
listChannelViewers(params: ListChannelViewersParams): Promise<ListChannelViewersResponse>;
|
|
1819
|
+
/**
|
|
1820
|
+
* Export viewers belonging to a channel.
|
|
1821
|
+
*/
|
|
1822
|
+
exportChannelViewers(params: ExportChannelViewersParams): Promise<ExportChannelViewersResponse>;
|
|
1823
|
+
/**
|
|
1824
|
+
* Add viewers to a channel, optionally assigning a group.
|
|
1825
|
+
*/
|
|
1826
|
+
addChannelViewers(params: AddChannelViewersParams): Promise<void>;
|
|
1827
|
+
/**
|
|
1828
|
+
* Delete viewers from a channel.
|
|
1829
|
+
*/
|
|
1830
|
+
deleteChannelViewers(params: DeleteChannelViewersParams): Promise<void>;
|
|
1831
|
+
/**
|
|
1832
|
+
* Transfer channel viewers to a target group.
|
|
1833
|
+
*/
|
|
1834
|
+
transferChannelViewers(params: TransferChannelViewersParams): Promise<void>;
|
|
1835
|
+
/**
|
|
1836
|
+
* Import channel viewers from an Excel file.
|
|
1837
|
+
*/
|
|
1838
|
+
importChannelViewers(params: ImportChannelViewersParams): Promise<ImportChannelViewersResponse>;
|
|
1839
|
+
/**
|
|
1840
|
+
* List viewers that have not joined any channel group.
|
|
1841
|
+
*/
|
|
1842
|
+
listUnrelatedChannelViewers(params: ListUnrelatedChannelViewersParams): Promise<ListUnrelatedChannelViewersResponse>;
|
|
1733
1843
|
/**
|
|
1734
1844
|
* Get live status (AC7)
|
|
1735
1845
|
*
|
|
@@ -1979,6 +2089,261 @@ export declare class ChannelService {
|
|
|
1979
2089
|
* ```
|
|
1980
2090
|
*/
|
|
1981
2091
|
updateWarmupVideo(options: UpdateWarmupVideoRequest): Promise<string>;
|
|
2092
|
+
/**
|
|
2093
|
+
* Get channel advert list.
|
|
2094
|
+
*
|
|
2095
|
+
* @param channelId - The channel ID
|
|
2096
|
+
* @returns Channel advert settings. If channel advert uses global settings, the global adverts are returned.
|
|
2097
|
+
*/
|
|
2098
|
+
getChannelAdverts(channelId: string): Promise<ChannelAdvert[]>;
|
|
2099
|
+
/**
|
|
2100
|
+
* Get channel product library enabled status.
|
|
2101
|
+
*
|
|
2102
|
+
* @param channelId - The channel ID
|
|
2103
|
+
* @returns Product library enabled status
|
|
2104
|
+
*/
|
|
2105
|
+
getChannelProductEnabled(channelId: string): Promise<ChannelProductEnabledResponse>;
|
|
2106
|
+
/**
|
|
2107
|
+
* Get PPT record setting.
|
|
2108
|
+
*
|
|
2109
|
+
* @param channelId - The channel ID
|
|
2110
|
+
* @returns PPT record setting
|
|
2111
|
+
*/
|
|
2112
|
+
getPptRecordSetting(channelId: string): Promise<PptRecordSettingResponse>;
|
|
2113
|
+
/**
|
|
2114
|
+
* List PPT record tasks.
|
|
2115
|
+
*
|
|
2116
|
+
* @param params - Query parameters including channelId
|
|
2117
|
+
* @returns Paginated PPT record task list
|
|
2118
|
+
*/
|
|
2119
|
+
listPptRecordTasks(params: ListPptRecordTasksParams): Promise<ListPptRecordTasksResponse>;
|
|
2120
|
+
/**
|
|
2121
|
+
* Get transmit channel associations for the account or one source channel.
|
|
2122
|
+
*
|
|
2123
|
+
* @param params - Optional source channel filter
|
|
2124
|
+
* @returns Transmit association list
|
|
2125
|
+
*/
|
|
2126
|
+
getTransmitAssociations(params?: GetTransmitAssociationsParams): Promise<TransmitAssociation[]>;
|
|
2127
|
+
/**
|
|
2128
|
+
* Get channels owned by a child account.
|
|
2129
|
+
*
|
|
2130
|
+
* @param params - Query parameters including childUserId and pagination
|
|
2131
|
+
* @returns Paginated child-account channel list
|
|
2132
|
+
*/
|
|
2133
|
+
getUserChildrenChannels(params: GetUserChildrenChannelsParams): Promise<GetUserChildrenChannelsResponse>;
|
|
2134
|
+
/**
|
|
2135
|
+
* List follow-public-account settings for one or more channels.
|
|
2136
|
+
*
|
|
2137
|
+
* @param params - Channel IDs as an array or comma-separated string
|
|
2138
|
+
* @returns Follow-public-account settings
|
|
2139
|
+
*/
|
|
2140
|
+
listChannelsFollow(params: ListChannelsFollowParams): Promise<ListChannelsFollowResponse>;
|
|
2141
|
+
/**
|
|
2142
|
+
* Capture the current live stream image.
|
|
2143
|
+
*
|
|
2144
|
+
* @param channelId - The channel ID
|
|
2145
|
+
* @returns Screenshot image URL
|
|
2146
|
+
*/
|
|
2147
|
+
getCaptureImage(channelId: string): Promise<string>;
|
|
2148
|
+
/**
|
|
2149
|
+
* Create a PPT record remaking task.
|
|
2150
|
+
*
|
|
2151
|
+
* @param params - Task parameters including channelId and playback videoId
|
|
2152
|
+
* @returns true if task creation succeeded
|
|
2153
|
+
*/
|
|
2154
|
+
addPptRecordTask(params: AddPptRecordTaskParams): Promise<boolean>;
|
|
2155
|
+
/**
|
|
2156
|
+
* Update PPT record settings.
|
|
2157
|
+
*
|
|
2158
|
+
* @param params - PPT record setting fields
|
|
2159
|
+
* @returns Mutation result
|
|
2160
|
+
*/
|
|
2161
|
+
updatePptRecordSetting(params: UpdatePptRecordSettingParams): Promise<PptRecordMutationResponse>;
|
|
2162
|
+
/**
|
|
2163
|
+
* Get watch-page SDK API token.
|
|
2164
|
+
*
|
|
2165
|
+
* @param params - Viewer token parameters
|
|
2166
|
+
* @returns Viewer API token
|
|
2167
|
+
*/
|
|
2168
|
+
getWatchApiToken(params: ViewerApiTokenParams): Promise<ViewerApiTokenResponse>;
|
|
2169
|
+
/**
|
|
2170
|
+
* Get viewer API token.
|
|
2171
|
+
*
|
|
2172
|
+
* @param params - Viewer token parameters
|
|
2173
|
+
* @returns Viewer API token
|
|
2174
|
+
*/
|
|
2175
|
+
getApiToken(params: ViewerApiTokenParams): Promise<ViewerApiTokenResponse>;
|
|
2176
|
+
/**
|
|
2177
|
+
* Get channel chat-room online count.
|
|
2178
|
+
*
|
|
2179
|
+
* The historical channel operate doc lists this endpoint as POST, while
|
|
2180
|
+
* newer docs and some production environments only accept GET.
|
|
2181
|
+
*
|
|
2182
|
+
* @param channelId - The channel ID
|
|
2183
|
+
* @returns Online user count
|
|
2184
|
+
*/
|
|
2185
|
+
getChatOnlineCount(channelId: string): Promise<number>;
|
|
2186
|
+
/**
|
|
2187
|
+
* Get password-free login URL for teacher/admin roles.
|
|
2188
|
+
*
|
|
2189
|
+
* @param params - Channel and optional role account ID
|
|
2190
|
+
* @returns Login URL or token wrapper returned by the API
|
|
2191
|
+
*/
|
|
2192
|
+
getTokenLoginUrl(params: TokenLoginUrlParams): Promise<TokenLoginUrlResponse>;
|
|
2193
|
+
/**
|
|
2194
|
+
* Get authorization and link-mic chat token.
|
|
2195
|
+
*
|
|
2196
|
+
* @param params - Chat token parameters
|
|
2197
|
+
* @returns Chat token detail
|
|
2198
|
+
*/
|
|
2199
|
+
getChatToken(params: ChatTokenParams): Promise<ChatTokenResponse>;
|
|
2200
|
+
/**
|
|
2201
|
+
* Batch create channels that receive a transmit stream.
|
|
2202
|
+
*
|
|
2203
|
+
* @param params - Source channel and receiver channel names
|
|
2204
|
+
* @returns Created receiver channels
|
|
2205
|
+
*/
|
|
2206
|
+
batchAddTransmit(params: BatchAddTransmitParams): Promise<BatchAddTransmitResponse>;
|
|
2207
|
+
/**
|
|
2208
|
+
* Batch associate submeeting channels.
|
|
2209
|
+
*
|
|
2210
|
+
* @param params - Main channel and submeeting list
|
|
2211
|
+
* @returns Associated submeeting channel IDs
|
|
2212
|
+
*/
|
|
2213
|
+
batchAddSubmeeting(params: BatchAddSubmeetingParams): Promise<BatchAddSubmeetingResponse>;
|
|
2214
|
+
/**
|
|
2215
|
+
* Associate or cancel receiver channels for a transmit channel.
|
|
2216
|
+
*
|
|
2217
|
+
* @param params - Transmit association parameters
|
|
2218
|
+
* @returns Receiver channel IDs returned by the API
|
|
2219
|
+
*/
|
|
2220
|
+
associationReceiveChannels(params: AssociationReceiveChannelsParams): Promise<AssociationReceiveChannelsResponse>;
|
|
2221
|
+
/**
|
|
2222
|
+
* Batch remove chat records from a channel.
|
|
2223
|
+
*
|
|
2224
|
+
* @param params - Channel and chat message IDs
|
|
2225
|
+
* @returns Success message
|
|
2226
|
+
*/
|
|
2227
|
+
removeChatContents(params: RemoveChatContentsParams): Promise<string>;
|
|
2228
|
+
/**
|
|
2229
|
+
* Batch delete channel products.
|
|
2230
|
+
*
|
|
2231
|
+
* @param params - Channel and product IDs
|
|
2232
|
+
* @returns Success message
|
|
2233
|
+
*/
|
|
2234
|
+
batchDeleteChannelProducts(params: BatchDeleteChannelProductParams): Promise<string>;
|
|
2235
|
+
/**
|
|
2236
|
+
* Batch add channel products.
|
|
2237
|
+
*
|
|
2238
|
+
* @param params - Channel and product list
|
|
2239
|
+
* @returns Created products
|
|
2240
|
+
*/
|
|
2241
|
+
batchAddChannelProducts(params: BatchAddChannelProductsParams): Promise<BatchAddChannelProductsResponse>;
|
|
2242
|
+
/**
|
|
2243
|
+
* Batch update channel product shelf status.
|
|
2244
|
+
*
|
|
2245
|
+
* @param params - Channel, product IDs, and shelf status
|
|
2246
|
+
* @returns Success message
|
|
2247
|
+
*/
|
|
2248
|
+
batchShelfChannelProducts(params: BatchShelfChannelProductParams): Promise<string>;
|
|
2249
|
+
/**
|
|
2250
|
+
* Cancel a pushed channel product.
|
|
2251
|
+
*
|
|
2252
|
+
* @param params - Channel and product ID
|
|
2253
|
+
* @returns API result
|
|
2254
|
+
*/
|
|
2255
|
+
cancelPushChannelProduct(params: ProductIdParams): Promise<null | string>;
|
|
2256
|
+
/**
|
|
2257
|
+
* Push a channel product to viewers.
|
|
2258
|
+
*
|
|
2259
|
+
* @param params - Channel, product ID, and optional card type
|
|
2260
|
+
* @returns API result
|
|
2261
|
+
*/
|
|
2262
|
+
pushChannelProduct(params: PushChannelProductParams): Promise<null | string>;
|
|
2263
|
+
/**
|
|
2264
|
+
* Update one channel product shelf status.
|
|
2265
|
+
*
|
|
2266
|
+
* @param params - Channel, product ID, and shelf status
|
|
2267
|
+
* @returns Success message
|
|
2268
|
+
*/
|
|
2269
|
+
shelfChannelProduct(params: ShelfChannelProductParams): Promise<string>;
|
|
2270
|
+
/**
|
|
2271
|
+
* Sort a channel product by moving it up, down, or to a rank.
|
|
2272
|
+
*
|
|
2273
|
+
* @param params - Sort parameters
|
|
2274
|
+
* @returns Success message
|
|
2275
|
+
*/
|
|
2276
|
+
sortChannelProduct(params: SortChannelProductOrderParams): Promise<string>;
|
|
2277
|
+
/**
|
|
2278
|
+
* Reference a platform product into a channel product library.
|
|
2279
|
+
*
|
|
2280
|
+
* @param params - Channel and platform product fields
|
|
2281
|
+
* @returns Referenced channel product
|
|
2282
|
+
*/
|
|
2283
|
+
referenceProduct(params: ReferenceProductParams): Promise<ReferenceProductResponse>;
|
|
2284
|
+
/**
|
|
2285
|
+
* Delete pseudo-live disk videos.
|
|
2286
|
+
*
|
|
2287
|
+
* @param params - Channel and VOD/material or disk video IDs
|
|
2288
|
+
* @returns API result
|
|
2289
|
+
*/
|
|
2290
|
+
deleteDiskVideos(params: DeleteDiskVideosParams): Promise<string>;
|
|
2291
|
+
/**
|
|
2292
|
+
* Delete PPT record remaking tasks.
|
|
2293
|
+
*
|
|
2294
|
+
* @param params - Channel and task IDs
|
|
2295
|
+
* @returns Mutation result
|
|
2296
|
+
*/
|
|
2297
|
+
deletePptRecord(params: DeletePptRecordParams): Promise<PptRecordMutationResponse>;
|
|
2298
|
+
/**
|
|
2299
|
+
* Set one-time login token for a channel.
|
|
2300
|
+
*
|
|
2301
|
+
* @param params - Channel and token
|
|
2302
|
+
* @returns Success message
|
|
2303
|
+
*/
|
|
2304
|
+
setChannelToken(params: SetChannelTokenParams): Promise<string>;
|
|
2305
|
+
/**
|
|
2306
|
+
* Set one-time login token for a sub-account channel.
|
|
2307
|
+
*
|
|
2308
|
+
* @param params - Channel and token
|
|
2309
|
+
* @returns Success message
|
|
2310
|
+
*/
|
|
2311
|
+
setAccountToken(params: SetChannelTokenParams): Promise<string>;
|
|
2312
|
+
/**
|
|
2313
|
+
* Manually stop questionnaires for one or more channels.
|
|
2314
|
+
*
|
|
2315
|
+
* @param params - Channel IDs
|
|
2316
|
+
* @returns Mutation result
|
|
2317
|
+
*/
|
|
2318
|
+
channelsStopQuestionnaire(params: StopQuestionnaireParams): Promise<StopQuestionnaireResponse>;
|
|
2319
|
+
/**
|
|
2320
|
+
* Batch update channel danmu switches.
|
|
2321
|
+
*
|
|
2322
|
+
* @param params - Channel IDs and switch values
|
|
2323
|
+
* @returns Success message
|
|
2324
|
+
*/
|
|
2325
|
+
batchUpdateDanmu(params: BatchUpdateDanmuParams): Promise<string>;
|
|
2326
|
+
/**
|
|
2327
|
+
* Update follow-public-account settings for one or more channels.
|
|
2328
|
+
*
|
|
2329
|
+
* @param params - Channel IDs and follow settings
|
|
2330
|
+
* @returns API result
|
|
2331
|
+
*/
|
|
2332
|
+
updateChannelsFollow(params: UpdateChannelsFollowParams): Promise<null | string>;
|
|
2333
|
+
/**
|
|
2334
|
+
* Update channel stream type.
|
|
2335
|
+
*
|
|
2336
|
+
* @param params - Stream type parameters
|
|
2337
|
+
* @returns API result
|
|
2338
|
+
*/
|
|
2339
|
+
updateStreamType(params: UpdateStreamTypeParams): Promise<string>;
|
|
2340
|
+
/**
|
|
2341
|
+
* Configure pseudo-live disk videos.
|
|
2342
|
+
*
|
|
2343
|
+
* @param params - Channel and disk video source
|
|
2344
|
+
* @returns API result
|
|
2345
|
+
*/
|
|
2346
|
+
addDiskVideos(params: AddDiskVideosParams): Promise<string>;
|
|
1982
2347
|
/**
|
|
1983
2348
|
* List channel products
|
|
1984
2349
|
*
|