polyv-live-api-sdk 1.0.0
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/dist/auth/index.d.ts +9 -0
- package/dist/auth/index.d.ts.map +1 -0
- package/dist/auth/signature.d.ts +67 -0
- package/dist/auth/signature.d.ts.map +1 -0
- package/dist/client.d.ts +209 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/constants/error-codes.d.ts +134 -0
- package/dist/constants/error-codes.d.ts.map +1 -0
- package/dist/constants/index.d.ts +8 -0
- package/dist/constants/index.d.ts.map +1 -0
- package/dist/errors/index.d.ts +11 -0
- package/dist/errors/index.d.ts.map +1 -0
- package/dist/errors/polyv-api-error.d.ts +71 -0
- package/dist/errors/polyv-api-error.d.ts.map +1 -0
- package/dist/errors/polyv-error.d.ts +31 -0
- package/dist/errors/polyv-error.d.ts.map +1 -0
- package/dist/errors/polyv-validation-error.d.ts +72 -0
- package/dist/errors/polyv-validation-error.d.ts.map +1 -0
- package/dist/errors/type-guards.d.ts +19 -0
- package/dist/errors/type-guards.d.ts.map +1 -0
- package/dist/errors/types.d.ts +13 -0
- package/dist/errors/types.d.ts.map +1 -0
- package/dist/index.cjs +15295 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +19501 -0
- package/dist/index.d.ts +18 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +15258 -0
- package/dist/index.js.map +1 -0
- package/dist/services/account.service.d.ts +402 -0
- package/dist/services/account.service.d.ts.map +1 -0
- package/dist/services/channel.service.d.ts +2033 -0
- package/dist/services/channel.service.d.ts.map +1 -0
- package/dist/services/chat.service.d.ts +592 -0
- package/dist/services/chat.service.d.ts.map +1 -0
- package/dist/services/finance.service.d.ts +160 -0
- package/dist/services/finance.service.d.ts.map +1 -0
- package/dist/services/group.service.d.ts +191 -0
- package/dist/services/group.service.d.ts.map +1 -0
- package/dist/services/index.d.ts +27 -0
- package/dist/services/index.d.ts.map +1 -0
- package/dist/services/live-interaction.service.d.ts +474 -0
- package/dist/services/live-interaction.service.d.ts.map +1 -0
- package/dist/services/other.service.d.ts +687 -0
- package/dist/services/other.service.d.ts.map +1 -0
- package/dist/services/platform.service.d.ts +190 -0
- package/dist/services/platform.service.d.ts.map +1 -0
- package/dist/services/player.service.d.ts +195 -0
- package/dist/services/player.service.d.ts.map +1 -0
- package/dist/services/v4/ai.service.d.ts +205 -0
- package/dist/services/v4/ai.service.d.ts.map +1 -0
- package/dist/services/v4/channel.service.d.ts +854 -0
- package/dist/services/v4/channel.service.d.ts.map +1 -0
- package/dist/services/v4/chat.service.d.ts +199 -0
- package/dist/services/v4/chat.service.d.ts.map +1 -0
- package/dist/services/v4/global.service.d.ts +86 -0
- package/dist/services/v4/global.service.d.ts.map +1 -0
- package/dist/services/v4/group.service.d.ts +132 -0
- package/dist/services/v4/group.service.d.ts.map +1 -0
- package/dist/services/v4/material.service.d.ts +85 -0
- package/dist/services/v4/material.service.d.ts.map +1 -0
- package/dist/services/v4/platform.service.d.ts +148 -0
- package/dist/services/v4/platform.service.d.ts.map +1 -0
- package/dist/services/v4/robot.service.d.ts +144 -0
- package/dist/services/v4/robot.service.d.ts.map +1 -0
- package/dist/services/v4/statistics.service.d.ts +61 -0
- package/dist/services/v4/statistics.service.d.ts.map +1 -0
- package/dist/services/v4/user.service.d.ts +1014 -0
- package/dist/services/v4/user.service.d.ts.map +1 -0
- package/dist/services/v4/webapp.service.d.ts +131 -0
- package/dist/services/v4/webapp.service.d.ts.map +1 -0
- package/dist/services/web.service.d.ts +758 -0
- package/dist/services/web.service.d.ts.map +1 -0
- package/dist/types/account.d.ts +287 -0
- package/dist/types/account.d.ts.map +1 -0
- package/dist/types/auth.d.ts +31 -0
- package/dist/types/auth.d.ts.map +1 -0
- package/dist/types/callback.d.ts +156 -0
- package/dist/types/callback.d.ts.map +1 -0
- package/dist/types/channel.d.ts +2263 -0
- package/dist/types/channel.d.ts.map +1 -0
- package/dist/types/chat-banned.d.ts +366 -0
- package/dist/types/chat-banned.d.ts.map +1 -0
- package/dist/types/chat-censor-role.d.ts +190 -0
- package/dist/types/chat-censor-role.d.ts.map +1 -0
- package/dist/types/chat.d.ts +142 -0
- package/dist/types/chat.d.ts.map +1 -0
- package/dist/types/client.d.ts +43 -0
- package/dist/types/client.d.ts.map +1 -0
- package/dist/types/common.d.ts +52 -0
- package/dist/types/common.d.ts.map +1 -0
- package/dist/types/finance.d.ts +252 -0
- package/dist/types/finance.d.ts.map +1 -0
- package/dist/types/group.d.ts +129 -0
- package/dist/types/group.d.ts.map +1 -0
- package/dist/types/index.d.ts +50 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/live-interaction.d.ts +301 -0
- package/dist/types/live-interaction.d.ts.map +1 -0
- package/dist/types/pagination.d.ts +37 -0
- package/dist/types/pagination.d.ts.map +1 -0
- package/dist/types/platform.d.ts +178 -0
- package/dist/types/platform.d.ts.map +1 -0
- package/dist/types/player.d.ts +177 -0
- package/dist/types/player.d.ts.map +1 -0
- package/dist/types/request.d.ts +45 -0
- package/dist/types/request.d.ts.map +1 -0
- package/dist/types/response.d.ts +58 -0
- package/dist/types/response.d.ts.map +1 -0
- package/dist/types/signature.d.ts +50 -0
- package/dist/types/signature.d.ts.map +1 -0
- package/dist/types/upload.d.ts +32 -0
- package/dist/types/upload.d.ts.map +1 -0
- package/dist/types/v4-ai.d.ts +379 -0
- package/dist/types/v4-ai.d.ts.map +1 -0
- package/dist/types/v4-channel.d.ts +2400 -0
- package/dist/types/v4-channel.d.ts.map +1 -0
- package/dist/types/v4-chat.d.ts +190 -0
- package/dist/types/v4-chat.d.ts.map +1 -0
- package/dist/types/v4-global.d.ts +150 -0
- package/dist/types/v4-global.d.ts.map +1 -0
- package/dist/types/v4-group.d.ts +212 -0
- package/dist/types/v4-group.d.ts.map +1 -0
- package/dist/types/v4-material.d.ts +141 -0
- package/dist/types/v4-material.d.ts.map +1 -0
- package/dist/types/v4-platform.d.ts +223 -0
- package/dist/types/v4-platform.d.ts.map +1 -0
- package/dist/types/v4-robot.d.ts +149 -0
- package/dist/types/v4-robot.d.ts.map +1 -0
- package/dist/types/v4-statistics.d.ts +87 -0
- package/dist/types/v4-statistics.d.ts.map +1 -0
- package/dist/types/v4-user.d.ts +1021 -0
- package/dist/types/v4-user.d.ts.map +1 -0
- package/dist/types/v4-webapp.d.ts +161 -0
- package/dist/types/v4-webapp.d.ts.map +1 -0
- package/dist/types/version.d.ts +21 -0
- package/dist/types/version.d.ts.map +1 -0
- package/dist/types/web.d.ts +868 -0
- package/dist/types/web.d.ts.map +1 -0
- package/dist/utils/env.d.ts +54 -0
- package/dist/utils/env.d.ts.map +1 -0
- package/dist/utils/index.d.ts +11 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/pagination.d.ts +62 -0
- package/dist/utils/pagination.d.ts.map +1 -0
- package/dist/utils/signature.d.ts +67 -0
- package/dist/utils/signature.d.ts.map +1 -0
- package/package.json +76 -0
|
@@ -0,0 +1,2400 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* V4 Channel Types
|
|
3
|
+
*
|
|
4
|
+
* Type definitions for V4 Channel management APIs.
|
|
5
|
+
*
|
|
6
|
+
* @module types/v4-channel
|
|
7
|
+
*/
|
|
8
|
+
/**
|
|
9
|
+
* Channel scene types
|
|
10
|
+
*/
|
|
11
|
+
export type ChannelScene = 'topclass' | 'double' | 'train' | 'alone' | 'seminar' | 'guide';
|
|
12
|
+
/**
|
|
13
|
+
* Channel template types
|
|
14
|
+
*/
|
|
15
|
+
export type ChannelTemplate = 'ppt' | 'portrait_ppt' | 'alone' | 'portrait_alone' | 'topclass' | 'portrait_topclass' | 'seminar';
|
|
16
|
+
/**
|
|
17
|
+
* Y/N flag type
|
|
18
|
+
*/
|
|
19
|
+
export type YNFlag = 'Y' | 'N';
|
|
20
|
+
/**
|
|
21
|
+
* Parameters for creating a channel
|
|
22
|
+
*/
|
|
23
|
+
export interface CreateChannelParams {
|
|
24
|
+
/** Channel name, max 100 chars */
|
|
25
|
+
name: string;
|
|
26
|
+
/** Channel scene */
|
|
27
|
+
newScene: ChannelScene;
|
|
28
|
+
/** Channel template */
|
|
29
|
+
template: ChannelTemplate;
|
|
30
|
+
/** Channel password (6-16 chars) */
|
|
31
|
+
channelPasswd?: string;
|
|
32
|
+
/** Seminar host password (6-16 chars) */
|
|
33
|
+
seminarHostPassword?: string;
|
|
34
|
+
/** Seminar attendee password (6-16 chars) */
|
|
35
|
+
seminarAttendeePassword?: string;
|
|
36
|
+
/** Pure RTC enabled */
|
|
37
|
+
pureRtcEnabled?: YNFlag;
|
|
38
|
+
/** Transmit type */
|
|
39
|
+
type?: 'normal' | 'transmit' | 'receive';
|
|
40
|
+
/** Double teacher type */
|
|
41
|
+
doubleTeacherType?: 'normal' | 'transmit' | 'receive';
|
|
42
|
+
/** CN and EN live enabled */
|
|
43
|
+
cnAndEnLiveEnabled?: YNFlag;
|
|
44
|
+
/** Splash image URL */
|
|
45
|
+
splashImg?: string;
|
|
46
|
+
/** Link mic limit (max 16) */
|
|
47
|
+
linkMicLimit?: number;
|
|
48
|
+
/** Category ID */
|
|
49
|
+
categoryId?: number;
|
|
50
|
+
/** Start time (timestamp) */
|
|
51
|
+
startTime?: number;
|
|
52
|
+
/** End time (timestamp) */
|
|
53
|
+
endTime?: number;
|
|
54
|
+
/** Sub account email */
|
|
55
|
+
subAccount?: string;
|
|
56
|
+
/** Custom teacher ID */
|
|
57
|
+
customTeacherId?: string;
|
|
58
|
+
/** Label IDs */
|
|
59
|
+
labelData?: number[];
|
|
60
|
+
/** Client alone template background URL */
|
|
61
|
+
clientAloneTemplateBackgroundUrl?: string;
|
|
62
|
+
/** Live CDN background URL */
|
|
63
|
+
liveCdnBackgroundUrl?: string;
|
|
64
|
+
/** H5 low latency FLV enabled */
|
|
65
|
+
h5LowLatencyFlvEnabled?: YNFlag;
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Response for creating a channel
|
|
69
|
+
*/
|
|
70
|
+
export interface CreateChannelResponse {
|
|
71
|
+
/** Channel ID */
|
|
72
|
+
channelId: number;
|
|
73
|
+
/** User ID */
|
|
74
|
+
userId: string;
|
|
75
|
+
/** Channel password */
|
|
76
|
+
channelPasswd: string | null;
|
|
77
|
+
/** Seminar host password */
|
|
78
|
+
seminarHostPassword: string | null;
|
|
79
|
+
/** Seminar attendee password */
|
|
80
|
+
seminarAttendeePassword: string | null;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Parameters for batch creating channels
|
|
84
|
+
*/
|
|
85
|
+
export interface CreateBatchChannelsParams {
|
|
86
|
+
/** Channels to create */
|
|
87
|
+
channels: CreateChannelParams[];
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* Response for batch creating channels
|
|
91
|
+
*/
|
|
92
|
+
export interface CreateBatchChannelsResponse {
|
|
93
|
+
/** Created channels */
|
|
94
|
+
channels: CreateChannelResponse[];
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Parameters for creating MR channel
|
|
98
|
+
*/
|
|
99
|
+
export interface CreateMrChannelParams {
|
|
100
|
+
/** Channel name */
|
|
101
|
+
name: string;
|
|
102
|
+
/** Category ID */
|
|
103
|
+
categoryId?: number;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Response for creating MR channel
|
|
107
|
+
*/
|
|
108
|
+
export interface CreateMrChannelResponse {
|
|
109
|
+
/** Channel ID */
|
|
110
|
+
channelId: number;
|
|
111
|
+
/** User ID */
|
|
112
|
+
userId: string;
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* Parameters for basic channel creation
|
|
116
|
+
*/
|
|
117
|
+
export interface BasicCreateChannelParams {
|
|
118
|
+
/** Channel name */
|
|
119
|
+
name: string;
|
|
120
|
+
/** Channel password */
|
|
121
|
+
channelPasswd?: string;
|
|
122
|
+
/** Scene */
|
|
123
|
+
scene?: string;
|
|
124
|
+
/** Publisher */
|
|
125
|
+
publisher?: string;
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Response for basic channel creation
|
|
129
|
+
*/
|
|
130
|
+
export interface BasicCreateChannelResponse {
|
|
131
|
+
/** Channel ID */
|
|
132
|
+
channelId: number;
|
|
133
|
+
/** User ID */
|
|
134
|
+
userId: string;
|
|
135
|
+
}
|
|
136
|
+
/**
|
|
137
|
+
* Parameters for updating a channel
|
|
138
|
+
*/
|
|
139
|
+
export interface UpdateChannelParams {
|
|
140
|
+
/** Channel ID */
|
|
141
|
+
channelId: string;
|
|
142
|
+
/** Channel name */
|
|
143
|
+
name?: string;
|
|
144
|
+
/** Publisher */
|
|
145
|
+
publisher?: string;
|
|
146
|
+
/** Channel password */
|
|
147
|
+
channelPasswd?: string;
|
|
148
|
+
/** Start time */
|
|
149
|
+
startTime?: number;
|
|
150
|
+
/** End time */
|
|
151
|
+
endTime?: number;
|
|
152
|
+
/** Cover image URL */
|
|
153
|
+
coverImg?: string;
|
|
154
|
+
/** Splash image URL */
|
|
155
|
+
splashImg?: string;
|
|
156
|
+
/** Description */
|
|
157
|
+
desc?: string;
|
|
158
|
+
/** Publishing region */
|
|
159
|
+
publishingRegion?: string;
|
|
160
|
+
}
|
|
161
|
+
/**
|
|
162
|
+
* Response for updating a channel
|
|
163
|
+
*/
|
|
164
|
+
export interface UpdateChannelResponse {
|
|
165
|
+
/** Success flag */
|
|
166
|
+
success: boolean;
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
* Parameters for updating chat enabled status
|
|
170
|
+
*/
|
|
171
|
+
export interface UpdateChatEnabledParams {
|
|
172
|
+
/** Channel ID */
|
|
173
|
+
channelId: string;
|
|
174
|
+
/** Chat enabled status */
|
|
175
|
+
chatEnabled: YNFlag;
|
|
176
|
+
}
|
|
177
|
+
/**
|
|
178
|
+
* Watch status type
|
|
179
|
+
*/
|
|
180
|
+
export type WatchStatus = 'live' | 'end' | 'playback' | 'waiting' | 'unStart';
|
|
181
|
+
/**
|
|
182
|
+
* Channel basic info
|
|
183
|
+
*/
|
|
184
|
+
export interface ChannelBasicInfo {
|
|
185
|
+
/** Channel ID */
|
|
186
|
+
channelId: string;
|
|
187
|
+
/** Channel name */
|
|
188
|
+
name: string;
|
|
189
|
+
/** Publisher name */
|
|
190
|
+
publisher: string;
|
|
191
|
+
/** Start time */
|
|
192
|
+
startTime: number;
|
|
193
|
+
/** Page views */
|
|
194
|
+
pageView: number;
|
|
195
|
+
/** Likes count */
|
|
196
|
+
likes: number;
|
|
197
|
+
/** Cover image URL */
|
|
198
|
+
coverImg: string;
|
|
199
|
+
/** Splash image URL */
|
|
200
|
+
splashImg: string;
|
|
201
|
+
/** Splash enabled */
|
|
202
|
+
splashEnabled: YNFlag;
|
|
203
|
+
/** Description */
|
|
204
|
+
desc: string;
|
|
205
|
+
/** Max viewers */
|
|
206
|
+
maxViewer: number;
|
|
207
|
+
/** Watch status */
|
|
208
|
+
watchStatus: WatchStatus;
|
|
209
|
+
/** Watch status text */
|
|
210
|
+
watchStatusText: string;
|
|
211
|
+
/** Online count */
|
|
212
|
+
onlineNum: number;
|
|
213
|
+
/** Background image URL */
|
|
214
|
+
bgImg: string | null;
|
|
215
|
+
/** Video list */
|
|
216
|
+
videoList: Array<{
|
|
217
|
+
videoId: string;
|
|
218
|
+
videoPoolId: string;
|
|
219
|
+
}> | null;
|
|
220
|
+
/** Category ID */
|
|
221
|
+
categoryId: number;
|
|
222
|
+
}
|
|
223
|
+
/**
|
|
224
|
+
* Parameters for getting channel info
|
|
225
|
+
*/
|
|
226
|
+
export interface GetChannelParams {
|
|
227
|
+
/** Channel ID */
|
|
228
|
+
channelId: string;
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* Channel auth setting
|
|
232
|
+
*/
|
|
233
|
+
export interface ChannelAuthSetting {
|
|
234
|
+
/** Channel ID */
|
|
235
|
+
channelId: string;
|
|
236
|
+
/** Rank */
|
|
237
|
+
rank: number;
|
|
238
|
+
/** User ID */
|
|
239
|
+
userId: string;
|
|
240
|
+
/** Global setting enabled */
|
|
241
|
+
globalSettingEnabled: YNFlag;
|
|
242
|
+
/** Auth enabled */
|
|
243
|
+
enabled: YNFlag;
|
|
244
|
+
/** Auth type */
|
|
245
|
+
authType: string;
|
|
246
|
+
/** Auth tips */
|
|
247
|
+
authTips: string;
|
|
248
|
+
/** Pay auth tips */
|
|
249
|
+
payAuthTips: string;
|
|
250
|
+
/** Code auth tips */
|
|
251
|
+
codeAuthTips: string;
|
|
252
|
+
/** Info auth tips */
|
|
253
|
+
infoAuthTips: string;
|
|
254
|
+
}
|
|
255
|
+
/**
|
|
256
|
+
* Channel category info
|
|
257
|
+
*/
|
|
258
|
+
export interface ChannelCategory {
|
|
259
|
+
/** Category ID */
|
|
260
|
+
categoryId: number;
|
|
261
|
+
/** Category name */
|
|
262
|
+
categoryName: string;
|
|
263
|
+
/** User ID */
|
|
264
|
+
userId: string;
|
|
265
|
+
/** Rank */
|
|
266
|
+
rank: number;
|
|
267
|
+
}
|
|
268
|
+
/**
|
|
269
|
+
* Channel detail info
|
|
270
|
+
*/
|
|
271
|
+
export interface ChannelDetailInfo extends ChannelBasicInfo {
|
|
272
|
+
/** Scene */
|
|
273
|
+
scene: string;
|
|
274
|
+
/** New scene */
|
|
275
|
+
newScene: string;
|
|
276
|
+
/** Template */
|
|
277
|
+
template: string;
|
|
278
|
+
/** Channel password */
|
|
279
|
+
channelPasswd: string;
|
|
280
|
+
/** Consulting menu enabled */
|
|
281
|
+
consultingMenuEnabled: YNFlag;
|
|
282
|
+
/** Max viewer restrict */
|
|
283
|
+
maxViewerRestrict: YNFlag;
|
|
284
|
+
/** User category */
|
|
285
|
+
userCategory: ChannelCategory;
|
|
286
|
+
/** Auth settings */
|
|
287
|
+
authSettings: ChannelAuthSetting[];
|
|
288
|
+
}
|
|
289
|
+
/**
|
|
290
|
+
* Parameters for getting channel detail
|
|
291
|
+
*/
|
|
292
|
+
export interface GetChannelDetailParams {
|
|
293
|
+
/** Channel ID */
|
|
294
|
+
channelId: string;
|
|
295
|
+
}
|
|
296
|
+
/**
|
|
297
|
+
* Parameters for listing basic channels
|
|
298
|
+
*/
|
|
299
|
+
export interface ListChannelBasicParams {
|
|
300
|
+
/** Page number (>= 1) */
|
|
301
|
+
pageNumber?: number;
|
|
302
|
+
/** Page size (1-1000) */
|
|
303
|
+
pageSize?: number;
|
|
304
|
+
/** Category IDs (comma separated) */
|
|
305
|
+
categoryIds?: string;
|
|
306
|
+
}
|
|
307
|
+
/**
|
|
308
|
+
* Paginated response for channels
|
|
309
|
+
*/
|
|
310
|
+
export interface PaginatedChannelsResponse<T> {
|
|
311
|
+
/** Page number */
|
|
312
|
+
pageNumber: number;
|
|
313
|
+
/** Page size */
|
|
314
|
+
pageSize: number;
|
|
315
|
+
/** Total pages */
|
|
316
|
+
totalPages: number;
|
|
317
|
+
/** Total items */
|
|
318
|
+
totalItems: number;
|
|
319
|
+
/** Contents */
|
|
320
|
+
contents: T[];
|
|
321
|
+
}
|
|
322
|
+
/**
|
|
323
|
+
* Parameters for listing basic channel info
|
|
324
|
+
*/
|
|
325
|
+
export interface ListChannelBasicInfoParams {
|
|
326
|
+
/** Page number (>= 1) */
|
|
327
|
+
pageNumber?: number;
|
|
328
|
+
/** Page size (1-1000) */
|
|
329
|
+
pageSize?: number;
|
|
330
|
+
}
|
|
331
|
+
/**
|
|
332
|
+
* Parameters for channel basic list
|
|
333
|
+
*/
|
|
334
|
+
export interface ChannelBasicListParams {
|
|
335
|
+
/** Category IDs (comma separated) */
|
|
336
|
+
categoryIds?: string;
|
|
337
|
+
/** Page number */
|
|
338
|
+
page?: number;
|
|
339
|
+
/** Page size */
|
|
340
|
+
pageSize?: number;
|
|
341
|
+
}
|
|
342
|
+
/**
|
|
343
|
+
* Parameters for channel simple list
|
|
344
|
+
*/
|
|
345
|
+
export interface ChannelSimpleListParams {
|
|
346
|
+
/** Page number (>= 1) */
|
|
347
|
+
pageNumber?: number;
|
|
348
|
+
/** Page size (1-1000) */
|
|
349
|
+
pageSize?: number;
|
|
350
|
+
}
|
|
351
|
+
/**
|
|
352
|
+
* Channel simple info
|
|
353
|
+
*/
|
|
354
|
+
export interface ChannelSimpleInfo {
|
|
355
|
+
/** Channel ID */
|
|
356
|
+
channelId: string;
|
|
357
|
+
/** Channel name */
|
|
358
|
+
name: string;
|
|
359
|
+
}
|
|
360
|
+
/**
|
|
361
|
+
* Parameters for channel detail list
|
|
362
|
+
*/
|
|
363
|
+
export interface ChannelDetailListParams {
|
|
364
|
+
/** Page number (>= 1) */
|
|
365
|
+
pageNumber?: number;
|
|
366
|
+
/** Page size (1-1000) */
|
|
367
|
+
pageSize?: number;
|
|
368
|
+
/** Category ID */
|
|
369
|
+
categoryId?: number;
|
|
370
|
+
}
|
|
371
|
+
/**
|
|
372
|
+
* Parameters for updating channel template
|
|
373
|
+
*/
|
|
374
|
+
export interface UpdateChannelTemplateParams {
|
|
375
|
+
/** Channel ID */
|
|
376
|
+
channelId: string;
|
|
377
|
+
/** Template */
|
|
378
|
+
template: string;
|
|
379
|
+
}
|
|
380
|
+
/**
|
|
381
|
+
* Parameters for setting pull bitrate
|
|
382
|
+
*/
|
|
383
|
+
export interface SetPullBitrateParams {
|
|
384
|
+
/** Channel ID */
|
|
385
|
+
channelId: string;
|
|
386
|
+
/** Bitrate */
|
|
387
|
+
bitrate: number;
|
|
388
|
+
}
|
|
389
|
+
/**
|
|
390
|
+
* Account info
|
|
391
|
+
*/
|
|
392
|
+
export interface ChannelAccount {
|
|
393
|
+
/** Account ID */
|
|
394
|
+
id: number;
|
|
395
|
+
/** Account */
|
|
396
|
+
account: string;
|
|
397
|
+
/** Nickname */
|
|
398
|
+
nickname: string;
|
|
399
|
+
/** Avatar */
|
|
400
|
+
avatar: string;
|
|
401
|
+
/** Status */
|
|
402
|
+
status: YNFlag;
|
|
403
|
+
}
|
|
404
|
+
/**
|
|
405
|
+
* Parameters for adding account
|
|
406
|
+
*/
|
|
407
|
+
export interface AddAccountParams {
|
|
408
|
+
/** Channel ID */
|
|
409
|
+
channelId: string;
|
|
410
|
+
/** Account */
|
|
411
|
+
account: string;
|
|
412
|
+
/** Nickname */
|
|
413
|
+
nickname: string;
|
|
414
|
+
/** Password */
|
|
415
|
+
password: string;
|
|
416
|
+
}
|
|
417
|
+
/**
|
|
418
|
+
* Parameters for updating account
|
|
419
|
+
*/
|
|
420
|
+
export interface UpdateAccountParams {
|
|
421
|
+
/** Channel ID */
|
|
422
|
+
channelId: string;
|
|
423
|
+
/** Account ID */
|
|
424
|
+
id: number;
|
|
425
|
+
/** Nickname */
|
|
426
|
+
nickname?: string;
|
|
427
|
+
/** Password */
|
|
428
|
+
password?: string;
|
|
429
|
+
/** Status */
|
|
430
|
+
status?: YNFlag;
|
|
431
|
+
}
|
|
432
|
+
/**
|
|
433
|
+
* Parameters for deleting accounts
|
|
434
|
+
*/
|
|
435
|
+
export interface DeleteAccountsParams {
|
|
436
|
+
/** Channel ID */
|
|
437
|
+
channelId: string;
|
|
438
|
+
/** Account IDs to delete */
|
|
439
|
+
accountIds: string[];
|
|
440
|
+
}
|
|
441
|
+
/**
|
|
442
|
+
* Parameters for getting account viewer
|
|
443
|
+
*/
|
|
444
|
+
export interface GetAccountViewerParams {
|
|
445
|
+
/** Channel ID */
|
|
446
|
+
channelId: string;
|
|
447
|
+
}
|
|
448
|
+
/**
|
|
449
|
+
* Account viewer settings
|
|
450
|
+
*/
|
|
451
|
+
export interface AccountViewerSettings {
|
|
452
|
+
/** Channel ID */
|
|
453
|
+
channelId: string;
|
|
454
|
+
/** Viewer enabled */
|
|
455
|
+
viewerEnabled: YNFlag;
|
|
456
|
+
/** Max viewers */
|
|
457
|
+
maxViewers: number;
|
|
458
|
+
}
|
|
459
|
+
/**
|
|
460
|
+
* Parameters for updating account viewer
|
|
461
|
+
*/
|
|
462
|
+
export interface UpdateAccountViewerParams {
|
|
463
|
+
/** Channel ID */
|
|
464
|
+
channelId: string;
|
|
465
|
+
/** Viewer enabled */
|
|
466
|
+
viewerEnabled: YNFlag;
|
|
467
|
+
/** Max viewers */
|
|
468
|
+
maxViewers?: number;
|
|
469
|
+
}
|
|
470
|
+
/**
|
|
471
|
+
* Playback info
|
|
472
|
+
*/
|
|
473
|
+
export interface PlaybackInfo {
|
|
474
|
+
/** Video ID */
|
|
475
|
+
videoId: string;
|
|
476
|
+
/** Video pool ID */
|
|
477
|
+
videoPoolId: string;
|
|
478
|
+
/** Duration */
|
|
479
|
+
duration: number;
|
|
480
|
+
/** File size */
|
|
481
|
+
fileSize: number;
|
|
482
|
+
/** Start time */
|
|
483
|
+
startTime: number;
|
|
484
|
+
/** End time */
|
|
485
|
+
endTime: number;
|
|
486
|
+
/** Status */
|
|
487
|
+
status: string;
|
|
488
|
+
/** Title */
|
|
489
|
+
title: string;
|
|
490
|
+
}
|
|
491
|
+
/**
|
|
492
|
+
* Parameters for listing playbacks
|
|
493
|
+
*/
|
|
494
|
+
export interface PlaybackListParams {
|
|
495
|
+
/** Channel ID */
|
|
496
|
+
channelId: string;
|
|
497
|
+
/** Page number (>= 1) */
|
|
498
|
+
pageNumber?: number;
|
|
499
|
+
/** Page size (1-1000) */
|
|
500
|
+
pageSize?: number;
|
|
501
|
+
}
|
|
502
|
+
/**
|
|
503
|
+
* Response for listing playbacks
|
|
504
|
+
*/
|
|
505
|
+
export interface PlaybackListResponse {
|
|
506
|
+
/** Page number */
|
|
507
|
+
pageNumber: number;
|
|
508
|
+
/** Page size */
|
|
509
|
+
pageSize: number;
|
|
510
|
+
/** Total pages */
|
|
511
|
+
totalPages: number;
|
|
512
|
+
/** Total items */
|
|
513
|
+
totalItems: number;
|
|
514
|
+
/** Contents */
|
|
515
|
+
contents: PlaybackInfo[];
|
|
516
|
+
}
|
|
517
|
+
/**
|
|
518
|
+
* Parameters for querying playback video info
|
|
519
|
+
*/
|
|
520
|
+
export interface QueryPlaybackVideoInfoParams {
|
|
521
|
+
/** Channel ID */
|
|
522
|
+
channelId: string;
|
|
523
|
+
/** Video ID */
|
|
524
|
+
videoId: string;
|
|
525
|
+
}
|
|
526
|
+
/**
|
|
527
|
+
* Playback video info
|
|
528
|
+
*/
|
|
529
|
+
export interface PlaybackVideoInfo {
|
|
530
|
+
/** Video ID */
|
|
531
|
+
videoId: string;
|
|
532
|
+
/** Video pool ID */
|
|
533
|
+
videoPoolId: string;
|
|
534
|
+
/** Duration */
|
|
535
|
+
duration: number;
|
|
536
|
+
/** File size */
|
|
537
|
+
fileSize: number;
|
|
538
|
+
/** Start time */
|
|
539
|
+
startTime: number;
|
|
540
|
+
/** End time */
|
|
541
|
+
endTime: number;
|
|
542
|
+
/** Status */
|
|
543
|
+
status: string;
|
|
544
|
+
/** Title */
|
|
545
|
+
title: string;
|
|
546
|
+
/** URL */
|
|
547
|
+
url: string;
|
|
548
|
+
/** Image URL */
|
|
549
|
+
imageUrl: string;
|
|
550
|
+
}
|
|
551
|
+
/**
|
|
552
|
+
* Parameters for updating channel subtitle
|
|
553
|
+
*/
|
|
554
|
+
export interface UpdateChannelSubtitleParams {
|
|
555
|
+
/** Channel ID */
|
|
556
|
+
channelId: string;
|
|
557
|
+
/** Video ID */
|
|
558
|
+
videoId: string;
|
|
559
|
+
/** Subtitle URL */
|
|
560
|
+
subtitleUrl: string;
|
|
561
|
+
}
|
|
562
|
+
/**
|
|
563
|
+
* Recorded file info
|
|
564
|
+
*/
|
|
565
|
+
export interface RecordedFileInfo {
|
|
566
|
+
/** File ID */
|
|
567
|
+
fileId: string;
|
|
568
|
+
/** File name */
|
|
569
|
+
fileName: string;
|
|
570
|
+
/** File size */
|
|
571
|
+
fileSize: number;
|
|
572
|
+
/** Duration */
|
|
573
|
+
duration: number;
|
|
574
|
+
/** Start time */
|
|
575
|
+
startTime: number;
|
|
576
|
+
/** End time */
|
|
577
|
+
endTime: number;
|
|
578
|
+
/** Status */
|
|
579
|
+
status: string;
|
|
580
|
+
/** URL */
|
|
581
|
+
url: string;
|
|
582
|
+
}
|
|
583
|
+
/**
|
|
584
|
+
* Parameters for paging recorded files
|
|
585
|
+
*/
|
|
586
|
+
export interface PageMRecordParams {
|
|
587
|
+
/** Channel ID */
|
|
588
|
+
channelId: string;
|
|
589
|
+
/** Page number (>= 1) */
|
|
590
|
+
pageNumber?: number;
|
|
591
|
+
/** Page size (1-1000) */
|
|
592
|
+
pageSize?: number;
|
|
593
|
+
/** Start time */
|
|
594
|
+
startTime?: number;
|
|
595
|
+
/** End time */
|
|
596
|
+
endTime?: number;
|
|
597
|
+
}
|
|
598
|
+
/**
|
|
599
|
+
* Response for paging recorded files
|
|
600
|
+
*/
|
|
601
|
+
export interface PageMRecordResponse {
|
|
602
|
+
/** Page number */
|
|
603
|
+
pageNumber: number;
|
|
604
|
+
/** Page size */
|
|
605
|
+
pageSize: number;
|
|
606
|
+
/** Total pages */
|
|
607
|
+
totalPages: number;
|
|
608
|
+
/** Total items */
|
|
609
|
+
totalItems: number;
|
|
610
|
+
/** Contents */
|
|
611
|
+
contents: RecordedFileInfo[];
|
|
612
|
+
}
|
|
613
|
+
/**
|
|
614
|
+
* Parameters for batch publishing subtitle
|
|
615
|
+
*/
|
|
616
|
+
export interface BatchPublishSubtitleParams {
|
|
617
|
+
/** Channel ID */
|
|
618
|
+
channelId: string;
|
|
619
|
+
/** Subtitles */
|
|
620
|
+
subtitles: Array<{
|
|
621
|
+
videoId: string;
|
|
622
|
+
subtitleUrl: string;
|
|
623
|
+
}>;
|
|
624
|
+
}
|
|
625
|
+
/**
|
|
626
|
+
* Session info
|
|
627
|
+
*/
|
|
628
|
+
export interface SessionInfo {
|
|
629
|
+
/** Session ID */
|
|
630
|
+
sessionId: string;
|
|
631
|
+
/** Channel ID */
|
|
632
|
+
channelId: number;
|
|
633
|
+
/** Session name */
|
|
634
|
+
name: string;
|
|
635
|
+
/** Status */
|
|
636
|
+
status: 'unStart' | 'live' | 'end' | 'playback' | 'expired';
|
|
637
|
+
/** Start time */
|
|
638
|
+
startTime: number;
|
|
639
|
+
/** End time */
|
|
640
|
+
endTime: number;
|
|
641
|
+
/** Created time */
|
|
642
|
+
createdTime: number;
|
|
643
|
+
/** Plan start time */
|
|
644
|
+
planStartTime: number;
|
|
645
|
+
/** Plan end time */
|
|
646
|
+
planEndTime: number;
|
|
647
|
+
/** Stream type */
|
|
648
|
+
streamType: string;
|
|
649
|
+
/** Push client */
|
|
650
|
+
pushClient: string;
|
|
651
|
+
/** Splash image */
|
|
652
|
+
splashImg: string;
|
|
653
|
+
/** Splash large image */
|
|
654
|
+
splashLargeImg: string;
|
|
655
|
+
/** Watch URL */
|
|
656
|
+
watchUrl: string;
|
|
657
|
+
/** User ID */
|
|
658
|
+
userId: string;
|
|
659
|
+
}
|
|
660
|
+
/**
|
|
661
|
+
* Parameters for getting session relevance
|
|
662
|
+
*/
|
|
663
|
+
export interface GetRelevanceParams {
|
|
664
|
+
/** Channel ID */
|
|
665
|
+
channelId: string;
|
|
666
|
+
/** Session ID */
|
|
667
|
+
sessionId: string;
|
|
668
|
+
}
|
|
669
|
+
/**
|
|
670
|
+
* Session relevance info
|
|
671
|
+
*/
|
|
672
|
+
export interface SessionRelevanceInfo {
|
|
673
|
+
/** Session ID */
|
|
674
|
+
sessionId: string;
|
|
675
|
+
/** Channel ID */
|
|
676
|
+
channelId: string;
|
|
677
|
+
/** Relevance data */
|
|
678
|
+
relevance: Record<string, unknown>;
|
|
679
|
+
}
|
|
680
|
+
/**
|
|
681
|
+
* Parameters for creating session
|
|
682
|
+
*/
|
|
683
|
+
export interface CreateSessionParams {
|
|
684
|
+
/** Channel ID */
|
|
685
|
+
channelId: string;
|
|
686
|
+
/** Session name */
|
|
687
|
+
name: string;
|
|
688
|
+
/** Plan start time */
|
|
689
|
+
planStartTime?: number;
|
|
690
|
+
/** Plan end time */
|
|
691
|
+
planEndTime?: number;
|
|
692
|
+
/** Splash image */
|
|
693
|
+
splashImg?: string;
|
|
694
|
+
}
|
|
695
|
+
/**
|
|
696
|
+
* Response for creating session
|
|
697
|
+
*/
|
|
698
|
+
export interface CreateSessionResponse {
|
|
699
|
+
/** Session ID */
|
|
700
|
+
sessionId: string;
|
|
701
|
+
}
|
|
702
|
+
/**
|
|
703
|
+
* Parameters for getting session
|
|
704
|
+
*/
|
|
705
|
+
export interface GetSessionParams {
|
|
706
|
+
/** Channel ID */
|
|
707
|
+
channelId: string;
|
|
708
|
+
/** Session ID */
|
|
709
|
+
sessionId: string;
|
|
710
|
+
}
|
|
711
|
+
/**
|
|
712
|
+
* Parameters for listing sessions
|
|
713
|
+
*/
|
|
714
|
+
export interface ListSessionsParams {
|
|
715
|
+
/** Channel ID */
|
|
716
|
+
channelId: string;
|
|
717
|
+
/** Page number (>= 1) */
|
|
718
|
+
pageNumber?: number;
|
|
719
|
+
/** Page size (1-1000) */
|
|
720
|
+
pageSize?: number;
|
|
721
|
+
}
|
|
722
|
+
/**
|
|
723
|
+
* Response for listing sessions
|
|
724
|
+
*/
|
|
725
|
+
export interface ListSessionsResponse {
|
|
726
|
+
/** Page number */
|
|
727
|
+
pageNumber: number;
|
|
728
|
+
/** Page size */
|
|
729
|
+
pageSize: number;
|
|
730
|
+
/** Total pages */
|
|
731
|
+
totalPages: number;
|
|
732
|
+
/** Total items */
|
|
733
|
+
totalItems: number;
|
|
734
|
+
/** Contents */
|
|
735
|
+
contents: SessionInfo[];
|
|
736
|
+
}
|
|
737
|
+
/**
|
|
738
|
+
* Parameters for updating session
|
|
739
|
+
*/
|
|
740
|
+
export interface UpdateSessionParams {
|
|
741
|
+
/** Channel ID */
|
|
742
|
+
channelId: string;
|
|
743
|
+
/** Session ID */
|
|
744
|
+
sessionId: string;
|
|
745
|
+
/** Session name */
|
|
746
|
+
name?: string;
|
|
747
|
+
/** Plan start time */
|
|
748
|
+
planStartTime?: number;
|
|
749
|
+
/** Plan end time */
|
|
750
|
+
planEndTime?: number;
|
|
751
|
+
/** Splash image */
|
|
752
|
+
splashImg?: string;
|
|
753
|
+
}
|
|
754
|
+
/**
|
|
755
|
+
* Parameters for deleting session
|
|
756
|
+
*/
|
|
757
|
+
export interface DeleteSessionParams {
|
|
758
|
+
/** Channel ID */
|
|
759
|
+
channelId: string;
|
|
760
|
+
/** Session ID */
|
|
761
|
+
sessionId: string;
|
|
762
|
+
}
|
|
763
|
+
/**
|
|
764
|
+
* Decorate settings
|
|
765
|
+
*/
|
|
766
|
+
export interface DecorateSettings {
|
|
767
|
+
/** Channel ID */
|
|
768
|
+
channelId: string;
|
|
769
|
+
/** Background image URL */
|
|
770
|
+
bgImg: string;
|
|
771
|
+
/** Cover image URL */
|
|
772
|
+
coverImg: string;
|
|
773
|
+
/** Splash image URL */
|
|
774
|
+
splashImg: string;
|
|
775
|
+
/** Theme color */
|
|
776
|
+
themeColor: string;
|
|
777
|
+
/** Custom CSS */
|
|
778
|
+
customCss: string;
|
|
779
|
+
}
|
|
780
|
+
/**
|
|
781
|
+
* Parameters for getting decorate settings
|
|
782
|
+
*/
|
|
783
|
+
export interface GetDecorateParams {
|
|
784
|
+
/** Channel ID */
|
|
785
|
+
channelId: string;
|
|
786
|
+
}
|
|
787
|
+
/**
|
|
788
|
+
* Parameters for updating decorate settings
|
|
789
|
+
*/
|
|
790
|
+
export interface UpdateDecorateParams {
|
|
791
|
+
/** Channel ID */
|
|
792
|
+
channelId: string;
|
|
793
|
+
/** Background image URL */
|
|
794
|
+
bgImg?: string;
|
|
795
|
+
/** Cover image URL */
|
|
796
|
+
coverImg?: string;
|
|
797
|
+
/** Splash image URL */
|
|
798
|
+
splashImg?: string;
|
|
799
|
+
/** Theme color */
|
|
800
|
+
themeColor?: string;
|
|
801
|
+
/** Custom CSS */
|
|
802
|
+
customCss?: string;
|
|
803
|
+
}
|
|
804
|
+
/**
|
|
805
|
+
* Parameters for updating skin
|
|
806
|
+
*/
|
|
807
|
+
export interface UpdateSkinParams {
|
|
808
|
+
/** Channel ID */
|
|
809
|
+
channelId: string;
|
|
810
|
+
/** Skin ID */
|
|
811
|
+
skinId: string;
|
|
812
|
+
}
|
|
813
|
+
/**
|
|
814
|
+
* Donate settings
|
|
815
|
+
*/
|
|
816
|
+
export interface DonateSettings {
|
|
817
|
+
/** Channel ID */
|
|
818
|
+
channelId: string;
|
|
819
|
+
/** Donate enabled */
|
|
820
|
+
donateEnabled: YNFlag;
|
|
821
|
+
/** Donate tips */
|
|
822
|
+
donateTips: string;
|
|
823
|
+
/** Donate amounts */
|
|
824
|
+
donateAmounts: number[];
|
|
825
|
+
}
|
|
826
|
+
/**
|
|
827
|
+
* Parameters for getting donate settings
|
|
828
|
+
*/
|
|
829
|
+
export interface GetDonateParams {
|
|
830
|
+
/** Channel ID */
|
|
831
|
+
channelId: string;
|
|
832
|
+
}
|
|
833
|
+
/**
|
|
834
|
+
* Parameters for updating donate settings
|
|
835
|
+
*/
|
|
836
|
+
export interface UpdateDonateParams {
|
|
837
|
+
/** Channel ID */
|
|
838
|
+
channelId: string;
|
|
839
|
+
/** Donate enabled */
|
|
840
|
+
donateEnabled?: YNFlag;
|
|
841
|
+
/** Donate tips */
|
|
842
|
+
donateTips?: string;
|
|
843
|
+
/** Donate amounts */
|
|
844
|
+
donateAmounts?: number[];
|
|
845
|
+
}
|
|
846
|
+
/**
|
|
847
|
+
* Distribute info
|
|
848
|
+
*/
|
|
849
|
+
export interface DistributeInfo {
|
|
850
|
+
/** Distribute ID */
|
|
851
|
+
id: number;
|
|
852
|
+
/** Channel ID */
|
|
853
|
+
channelId: number;
|
|
854
|
+
/** Name */
|
|
855
|
+
name: string;
|
|
856
|
+
/** Distribute URL */
|
|
857
|
+
distributeUrl: string;
|
|
858
|
+
/** Distribute live code */
|
|
859
|
+
distributeLiveCode: string;
|
|
860
|
+
/** Status */
|
|
861
|
+
status: YNFlag;
|
|
862
|
+
/** Connection status */
|
|
863
|
+
connectionStatus: 'completed' | 'processing' | 'waiting' | 'error';
|
|
864
|
+
}
|
|
865
|
+
/**
|
|
866
|
+
* Parameters for listing distributes
|
|
867
|
+
*/
|
|
868
|
+
export interface DistributeListParams {
|
|
869
|
+
/** Channel ID */
|
|
870
|
+
channelId: string;
|
|
871
|
+
/** Distribute IDs (comma separated) */
|
|
872
|
+
distributeIds?: string;
|
|
873
|
+
}
|
|
874
|
+
/**
|
|
875
|
+
* Response for listing distributes
|
|
876
|
+
*/
|
|
877
|
+
export interface DistributeListResponse {
|
|
878
|
+
/** Distribute enable */
|
|
879
|
+
distributeEnable: YNFlag;
|
|
880
|
+
/** Result */
|
|
881
|
+
result: DistributeInfo[];
|
|
882
|
+
}
|
|
883
|
+
/**
|
|
884
|
+
* Parameters for batch creating distributes
|
|
885
|
+
*/
|
|
886
|
+
export interface DistributeCreateBatchParams {
|
|
887
|
+
/** Channel ID */
|
|
888
|
+
channelId: string;
|
|
889
|
+
/** Distributes to create */
|
|
890
|
+
distributes: Array<{
|
|
891
|
+
name: string;
|
|
892
|
+
distributeUrl: string;
|
|
893
|
+
distributeLiveCode?: string;
|
|
894
|
+
}>;
|
|
895
|
+
}
|
|
896
|
+
/**
|
|
897
|
+
* Response for batch creating distributes
|
|
898
|
+
*/
|
|
899
|
+
export interface DistributeCreateBatchResponse {
|
|
900
|
+
/** Created distributes */
|
|
901
|
+
distributes: DistributeInfo[];
|
|
902
|
+
}
|
|
903
|
+
/**
|
|
904
|
+
* Parameters for batch updating distributes
|
|
905
|
+
*/
|
|
906
|
+
export interface DistributeUpdateBatchParams {
|
|
907
|
+
/** Channel ID */
|
|
908
|
+
channelId: string;
|
|
909
|
+
/** Distributes to update */
|
|
910
|
+
distributes: Array<{
|
|
911
|
+
id: number;
|
|
912
|
+
name?: string;
|
|
913
|
+
distributeUrl?: string;
|
|
914
|
+
distributeLiveCode?: string;
|
|
915
|
+
status?: YNFlag;
|
|
916
|
+
}>;
|
|
917
|
+
}
|
|
918
|
+
/**
|
|
919
|
+
* Parameters for batch deleting distributes
|
|
920
|
+
*/
|
|
921
|
+
export interface DistributeDeleteBatchParams {
|
|
922
|
+
/** Channel ID */
|
|
923
|
+
channelId: string;
|
|
924
|
+
/** Distribute IDs */
|
|
925
|
+
ids: number[];
|
|
926
|
+
}
|
|
927
|
+
/**
|
|
928
|
+
* Parameters for getting distribute statistics
|
|
929
|
+
*/
|
|
930
|
+
export interface DistributeStatisticParams {
|
|
931
|
+
/** Channel ID */
|
|
932
|
+
channelId: string;
|
|
933
|
+
/** Distribute ID */
|
|
934
|
+
distributeId: number;
|
|
935
|
+
}
|
|
936
|
+
/**
|
|
937
|
+
* Distribute statistics
|
|
938
|
+
*/
|
|
939
|
+
export interface DistributeStatistic {
|
|
940
|
+
/** Distribute ID */
|
|
941
|
+
distributeId: number;
|
|
942
|
+
/** Channel ID */
|
|
943
|
+
channelId: string;
|
|
944
|
+
/** Total views */
|
|
945
|
+
totalViews: number;
|
|
946
|
+
/** Total duration */
|
|
947
|
+
totalDuration: number;
|
|
948
|
+
/** Connection count */
|
|
949
|
+
connectionCount: number;
|
|
950
|
+
}
|
|
951
|
+
/**
|
|
952
|
+
* Parameters for updating master switch
|
|
953
|
+
*/
|
|
954
|
+
export interface UpdateMasterSwitchParams {
|
|
955
|
+
/** Channel ID */
|
|
956
|
+
channelId: string;
|
|
957
|
+
/** Enabled */
|
|
958
|
+
enabled: YNFlag;
|
|
959
|
+
}
|
|
960
|
+
/**
|
|
961
|
+
* Parameters for updating switch
|
|
962
|
+
*/
|
|
963
|
+
export interface UpdateSwitchParams {
|
|
964
|
+
/** Channel ID */
|
|
965
|
+
channelId: string;
|
|
966
|
+
/** Distribute ID */
|
|
967
|
+
distributeId: number;
|
|
968
|
+
/** Enabled */
|
|
969
|
+
enabled: YNFlag;
|
|
970
|
+
}
|
|
971
|
+
/**
|
|
972
|
+
* Parameters for creating wait lottery
|
|
973
|
+
*/
|
|
974
|
+
export interface CreateWaitLotteryParams {
|
|
975
|
+
/** Channel ID */
|
|
976
|
+
channelId: string;
|
|
977
|
+
/** Session ID */
|
|
978
|
+
sessionId: string;
|
|
979
|
+
/** Lottery name */
|
|
980
|
+
name: string;
|
|
981
|
+
/** Max winners */
|
|
982
|
+
maxWinners: number;
|
|
983
|
+
}
|
|
984
|
+
/**
|
|
985
|
+
* Response for creating wait lottery
|
|
986
|
+
*/
|
|
987
|
+
export interface CreateWaitLotteryResponse {
|
|
988
|
+
/** Lottery ID */
|
|
989
|
+
lotteryId: string;
|
|
990
|
+
}
|
|
991
|
+
/**
|
|
992
|
+
* Parameters for querying winner viewer
|
|
993
|
+
*/
|
|
994
|
+
export interface QueryWinnerViewerParams {
|
|
995
|
+
/** Channel ID */
|
|
996
|
+
channelId: string;
|
|
997
|
+
/** Lottery ID */
|
|
998
|
+
lotteryId: string;
|
|
999
|
+
/** Page number */
|
|
1000
|
+
pageNumber?: number;
|
|
1001
|
+
/** Page size */
|
|
1002
|
+
pageSize?: number;
|
|
1003
|
+
}
|
|
1004
|
+
/**
|
|
1005
|
+
* Winner viewer info
|
|
1006
|
+
*/
|
|
1007
|
+
export interface WinnerViewerInfo {
|
|
1008
|
+
/** Viewer ID */
|
|
1009
|
+
viewerId: string;
|
|
1010
|
+
/** Viewer name */
|
|
1011
|
+
viewerName: string;
|
|
1012
|
+
/** Prize */
|
|
1013
|
+
prize: string;
|
|
1014
|
+
/** Win time */
|
|
1015
|
+
winTime: number;
|
|
1016
|
+
}
|
|
1017
|
+
/**
|
|
1018
|
+
* Response for querying winner viewer
|
|
1019
|
+
*/
|
|
1020
|
+
export interface QueryWinnerViewerResponse {
|
|
1021
|
+
/** Page number */
|
|
1022
|
+
pageNumber: number;
|
|
1023
|
+
/** Page size */
|
|
1024
|
+
pageSize: number;
|
|
1025
|
+
/** Total items */
|
|
1026
|
+
totalItems: number;
|
|
1027
|
+
/** Contents */
|
|
1028
|
+
contents: WinnerViewerInfo[];
|
|
1029
|
+
}
|
|
1030
|
+
/**
|
|
1031
|
+
* Lottery activity info
|
|
1032
|
+
*/
|
|
1033
|
+
export interface LotteryActivity {
|
|
1034
|
+
/** Activity ID */
|
|
1035
|
+
activityId: string;
|
|
1036
|
+
/** Channel ID */
|
|
1037
|
+
channelId: string;
|
|
1038
|
+
/** Activity name */
|
|
1039
|
+
name: string;
|
|
1040
|
+
/** Activity type */
|
|
1041
|
+
type: string;
|
|
1042
|
+
/** Status */
|
|
1043
|
+
status: YNFlag;
|
|
1044
|
+
/** Start time */
|
|
1045
|
+
startTime: number;
|
|
1046
|
+
/** End time */
|
|
1047
|
+
endTime: number;
|
|
1048
|
+
/** Created time */
|
|
1049
|
+
createdTime: number;
|
|
1050
|
+
}
|
|
1051
|
+
/**
|
|
1052
|
+
* Parameters for creating lottery activity
|
|
1053
|
+
*/
|
|
1054
|
+
export interface LotteryActivityCreateParams {
|
|
1055
|
+
/** Channel ID */
|
|
1056
|
+
channelId: string;
|
|
1057
|
+
/** Activity name */
|
|
1058
|
+
name: string;
|
|
1059
|
+
/** Activity type */
|
|
1060
|
+
type: string;
|
|
1061
|
+
/** Start time */
|
|
1062
|
+
startTime?: number;
|
|
1063
|
+
/** End time */
|
|
1064
|
+
endTime?: number;
|
|
1065
|
+
}
|
|
1066
|
+
/**
|
|
1067
|
+
* Response for creating lottery activity
|
|
1068
|
+
*/
|
|
1069
|
+
export interface LotteryActivityCreateResponse {
|
|
1070
|
+
/** Activity ID */
|
|
1071
|
+
activityId: string;
|
|
1072
|
+
}
|
|
1073
|
+
/**
|
|
1074
|
+
* Parameters for getting lottery activity
|
|
1075
|
+
*/
|
|
1076
|
+
export interface LotteryActivityGetParams {
|
|
1077
|
+
/** Channel ID */
|
|
1078
|
+
channelId: string;
|
|
1079
|
+
/** Activity ID */
|
|
1080
|
+
activityId: string;
|
|
1081
|
+
}
|
|
1082
|
+
/**
|
|
1083
|
+
* Parameters for listing lottery activities
|
|
1084
|
+
*/
|
|
1085
|
+
export interface LotteryActivityListParams {
|
|
1086
|
+
/** Channel ID */
|
|
1087
|
+
channelId: string;
|
|
1088
|
+
/** Page number */
|
|
1089
|
+
pageNumber?: number;
|
|
1090
|
+
/** Page size */
|
|
1091
|
+
pageSize?: number;
|
|
1092
|
+
}
|
|
1093
|
+
/**
|
|
1094
|
+
* Response for listing lottery activities
|
|
1095
|
+
*/
|
|
1096
|
+
export interface LotteryActivityListResponse {
|
|
1097
|
+
/** Page number */
|
|
1098
|
+
pageNumber: number;
|
|
1099
|
+
/** Page size */
|
|
1100
|
+
pageSize: number;
|
|
1101
|
+
/** Total items */
|
|
1102
|
+
totalItems: number;
|
|
1103
|
+
/** Contents */
|
|
1104
|
+
contents: LotteryActivity[];
|
|
1105
|
+
}
|
|
1106
|
+
/**
|
|
1107
|
+
* Parameters for updating lottery activity
|
|
1108
|
+
*/
|
|
1109
|
+
export interface LotteryActivityUpdateParams {
|
|
1110
|
+
/** Channel ID */
|
|
1111
|
+
channelId: string;
|
|
1112
|
+
/** Activity ID */
|
|
1113
|
+
activityId: string;
|
|
1114
|
+
/** Activity name */
|
|
1115
|
+
name?: string;
|
|
1116
|
+
/** Start time */
|
|
1117
|
+
startTime?: number;
|
|
1118
|
+
/** End time */
|
|
1119
|
+
endTime?: number;
|
|
1120
|
+
/** Status */
|
|
1121
|
+
status?: YNFlag;
|
|
1122
|
+
}
|
|
1123
|
+
/**
|
|
1124
|
+
* Parameters for deleting lottery activity
|
|
1125
|
+
*/
|
|
1126
|
+
export interface LotteryActivityDeleteParams {
|
|
1127
|
+
/** Channel ID */
|
|
1128
|
+
channelId: string;
|
|
1129
|
+
/** Activity ID */
|
|
1130
|
+
activityId: string;
|
|
1131
|
+
}
|
|
1132
|
+
/**
|
|
1133
|
+
* Parameters for adding to blacklist
|
|
1134
|
+
*/
|
|
1135
|
+
export interface BlacklistAddParams {
|
|
1136
|
+
/** Channel ID */
|
|
1137
|
+
channelId: string;
|
|
1138
|
+
/** Viewer IDs */
|
|
1139
|
+
viewerIds: string[];
|
|
1140
|
+
}
|
|
1141
|
+
/**
|
|
1142
|
+
* Parameters for deleting from blacklist
|
|
1143
|
+
*/
|
|
1144
|
+
export interface BlacklistDeleteParams {
|
|
1145
|
+
/** Channel ID */
|
|
1146
|
+
channelId: string;
|
|
1147
|
+
/** Viewer IDs */
|
|
1148
|
+
viewerIds: string[];
|
|
1149
|
+
}
|
|
1150
|
+
/**
|
|
1151
|
+
* Parameters for paging blacklist
|
|
1152
|
+
*/
|
|
1153
|
+
export interface BlacklistPageParams {
|
|
1154
|
+
/** Channel ID */
|
|
1155
|
+
channelId: string;
|
|
1156
|
+
/** Page number */
|
|
1157
|
+
pageNumber?: number;
|
|
1158
|
+
/** Page size */
|
|
1159
|
+
pageSize?: number;
|
|
1160
|
+
}
|
|
1161
|
+
/**
|
|
1162
|
+
* Blacklist item
|
|
1163
|
+
*/
|
|
1164
|
+
export interface BlacklistItem {
|
|
1165
|
+
/** Viewer ID */
|
|
1166
|
+
viewerId: string;
|
|
1167
|
+
/** Viewer name */
|
|
1168
|
+
viewerName: string;
|
|
1169
|
+
/** Added time */
|
|
1170
|
+
addedTime: number;
|
|
1171
|
+
}
|
|
1172
|
+
/**
|
|
1173
|
+
* Response for paging blacklist
|
|
1174
|
+
*/
|
|
1175
|
+
export interface BlacklistPageResponse {
|
|
1176
|
+
/** Page number */
|
|
1177
|
+
pageNumber: number;
|
|
1178
|
+
/** Page size */
|
|
1179
|
+
pageSize: number;
|
|
1180
|
+
/** Total items */
|
|
1181
|
+
totalItems: number;
|
|
1182
|
+
/** Contents */
|
|
1183
|
+
contents: BlacklistItem[];
|
|
1184
|
+
}
|
|
1185
|
+
/**
|
|
1186
|
+
* Parameters for adding group
|
|
1187
|
+
*/
|
|
1188
|
+
export interface GroupAddParams {
|
|
1189
|
+
/** Channel ID */
|
|
1190
|
+
channelId: string;
|
|
1191
|
+
/** Group name */
|
|
1192
|
+
name: string;
|
|
1193
|
+
}
|
|
1194
|
+
/**
|
|
1195
|
+
* Response for adding group
|
|
1196
|
+
*/
|
|
1197
|
+
export interface GroupAddResponse {
|
|
1198
|
+
/** Group ID */
|
|
1199
|
+
groupId: string;
|
|
1200
|
+
}
|
|
1201
|
+
/**
|
|
1202
|
+
* Parameters for creating viewer name group
|
|
1203
|
+
*/
|
|
1204
|
+
export interface GroupCreateViewerNameParams {
|
|
1205
|
+
/** Channel ID */
|
|
1206
|
+
channelId: string;
|
|
1207
|
+
/** Group name */
|
|
1208
|
+
name: string;
|
|
1209
|
+
/** Viewer names */
|
|
1210
|
+
viewerNames: string[];
|
|
1211
|
+
}
|
|
1212
|
+
/**
|
|
1213
|
+
* Parameters for deleting group
|
|
1214
|
+
*/
|
|
1215
|
+
export interface GroupDeleteParams {
|
|
1216
|
+
/** Channel ID */
|
|
1217
|
+
channelId: string;
|
|
1218
|
+
/** Group ID */
|
|
1219
|
+
groupId: string;
|
|
1220
|
+
}
|
|
1221
|
+
/**
|
|
1222
|
+
* Parameters for listing groups
|
|
1223
|
+
*/
|
|
1224
|
+
export interface GroupListParams {
|
|
1225
|
+
/** Channel ID */
|
|
1226
|
+
channelId: string;
|
|
1227
|
+
}
|
|
1228
|
+
/**
|
|
1229
|
+
* Group info
|
|
1230
|
+
*/
|
|
1231
|
+
export interface GroupInfo {
|
|
1232
|
+
/** Group ID */
|
|
1233
|
+
groupId: string;
|
|
1234
|
+
/** Group name */
|
|
1235
|
+
name: string;
|
|
1236
|
+
/** Member count */
|
|
1237
|
+
memberCount: number;
|
|
1238
|
+
/** Created time */
|
|
1239
|
+
createdTime: number;
|
|
1240
|
+
}
|
|
1241
|
+
/**
|
|
1242
|
+
* Parameters for updating group
|
|
1243
|
+
*/
|
|
1244
|
+
export interface GroupUpdateParams {
|
|
1245
|
+
/** Channel ID */
|
|
1246
|
+
channelId: string;
|
|
1247
|
+
/** Group ID */
|
|
1248
|
+
groupId: string;
|
|
1249
|
+
/** Group name */
|
|
1250
|
+
name: string;
|
|
1251
|
+
}
|
|
1252
|
+
/**
|
|
1253
|
+
* Parameters for adding viewer to group
|
|
1254
|
+
*/
|
|
1255
|
+
export interface GroupViewerAddParams {
|
|
1256
|
+
/** Channel ID */
|
|
1257
|
+
channelId: string;
|
|
1258
|
+
/** Group ID */
|
|
1259
|
+
groupId: string;
|
|
1260
|
+
/** Viewer IDs */
|
|
1261
|
+
viewerIds: string[];
|
|
1262
|
+
}
|
|
1263
|
+
/**
|
|
1264
|
+
* Parameters for deleting viewer from group
|
|
1265
|
+
*/
|
|
1266
|
+
export interface GroupViewerDeleteParams {
|
|
1267
|
+
/** Channel ID */
|
|
1268
|
+
channelId: string;
|
|
1269
|
+
/** Group ID */
|
|
1270
|
+
groupId: string;
|
|
1271
|
+
/** Viewer IDs */
|
|
1272
|
+
viewerIds: string[];
|
|
1273
|
+
}
|
|
1274
|
+
/**
|
|
1275
|
+
* Parameters for listing group viewers
|
|
1276
|
+
*/
|
|
1277
|
+
export interface GroupViewerListParams {
|
|
1278
|
+
/** Channel ID */
|
|
1279
|
+
channelId: string;
|
|
1280
|
+
/** Group ID */
|
|
1281
|
+
groupId: string;
|
|
1282
|
+
/** Page number */
|
|
1283
|
+
pageNumber?: number;
|
|
1284
|
+
/** Page size */
|
|
1285
|
+
pageSize?: number;
|
|
1286
|
+
}
|
|
1287
|
+
/**
|
|
1288
|
+
* Group viewer info
|
|
1289
|
+
*/
|
|
1290
|
+
export interface GroupViewerInfo {
|
|
1291
|
+
/** Viewer ID */
|
|
1292
|
+
viewerId: string;
|
|
1293
|
+
/** Viewer name */
|
|
1294
|
+
viewerName: string;
|
|
1295
|
+
/** Added time */
|
|
1296
|
+
addedTime: number;
|
|
1297
|
+
}
|
|
1298
|
+
/**
|
|
1299
|
+
* Response for listing group viewers
|
|
1300
|
+
*/
|
|
1301
|
+
export interface GroupViewerListResponse {
|
|
1302
|
+
/** Page number */
|
|
1303
|
+
pageNumber: number;
|
|
1304
|
+
/** Page size */
|
|
1305
|
+
pageSize: number;
|
|
1306
|
+
/** Total items */
|
|
1307
|
+
totalItems: number;
|
|
1308
|
+
/** Contents */
|
|
1309
|
+
contents: GroupViewerInfo[];
|
|
1310
|
+
}
|
|
1311
|
+
/**
|
|
1312
|
+
* Parameters for saving interaction event
|
|
1313
|
+
*/
|
|
1314
|
+
export interface InteractionEventSaveParams {
|
|
1315
|
+
/** Channel ID */
|
|
1316
|
+
channelId: string;
|
|
1317
|
+
/** Event type */
|
|
1318
|
+
eventType: string;
|
|
1319
|
+
/** Event data */
|
|
1320
|
+
eventData: Record<string, unknown>;
|
|
1321
|
+
}
|
|
1322
|
+
/**
|
|
1323
|
+
* Parameters for deleting interaction event
|
|
1324
|
+
*/
|
|
1325
|
+
export interface InteractionEventDeleteParams {
|
|
1326
|
+
/** Channel ID */
|
|
1327
|
+
channelId: string;
|
|
1328
|
+
/** Event ID */
|
|
1329
|
+
eventId: string;
|
|
1330
|
+
}
|
|
1331
|
+
/**
|
|
1332
|
+
* Parameters for creating inviter
|
|
1333
|
+
*/
|
|
1334
|
+
export interface InviterCreateParams {
|
|
1335
|
+
/** Channel ID */
|
|
1336
|
+
channelId: string;
|
|
1337
|
+
/** Inviter name */
|
|
1338
|
+
name: string;
|
|
1339
|
+
/** Inviter code */
|
|
1340
|
+
code?: string;
|
|
1341
|
+
}
|
|
1342
|
+
/**
|
|
1343
|
+
* Response for creating inviter
|
|
1344
|
+
*/
|
|
1345
|
+
export interface InviterCreateResponse {
|
|
1346
|
+
/** Inviter ID */
|
|
1347
|
+
inviterId: string;
|
|
1348
|
+
}
|
|
1349
|
+
/**
|
|
1350
|
+
* Parameters for uploading disk video script
|
|
1351
|
+
*/
|
|
1352
|
+
export interface DiskVideoScriptUploadParams {
|
|
1353
|
+
/** Channel ID */
|
|
1354
|
+
channelId: string;
|
|
1355
|
+
/** Script URL */
|
|
1356
|
+
scriptUrl: string;
|
|
1357
|
+
/** Script name */
|
|
1358
|
+
scriptName: string;
|
|
1359
|
+
}
|
|
1360
|
+
/**
|
|
1361
|
+
* Response for uploading disk video script
|
|
1362
|
+
*/
|
|
1363
|
+
export interface DiskVideoScriptUploadResponse {
|
|
1364
|
+
/** Script ID */
|
|
1365
|
+
scriptId: string;
|
|
1366
|
+
}
|
|
1367
|
+
/**
|
|
1368
|
+
* Parameters for querying disk video script
|
|
1369
|
+
*/
|
|
1370
|
+
export interface DiskVideoScriptQueryParams {
|
|
1371
|
+
/** Channel ID */
|
|
1372
|
+
channelId: string;
|
|
1373
|
+
/** Page number */
|
|
1374
|
+
pageNumber?: number;
|
|
1375
|
+
/** Page size */
|
|
1376
|
+
pageSize?: number;
|
|
1377
|
+
}
|
|
1378
|
+
/**
|
|
1379
|
+
* Disk video script info
|
|
1380
|
+
*/
|
|
1381
|
+
export interface DiskVideoScriptInfo {
|
|
1382
|
+
/** Script ID */
|
|
1383
|
+
scriptId: string;
|
|
1384
|
+
/** Script name */
|
|
1385
|
+
scriptName: string;
|
|
1386
|
+
/** Script URL */
|
|
1387
|
+
scriptUrl: string;
|
|
1388
|
+
/** Created time */
|
|
1389
|
+
createdTime: number;
|
|
1390
|
+
}
|
|
1391
|
+
/**
|
|
1392
|
+
* Response for querying disk video script
|
|
1393
|
+
*/
|
|
1394
|
+
export interface DiskVideoScriptQueryResponse {
|
|
1395
|
+
/** Page number */
|
|
1396
|
+
pageNumber: number;
|
|
1397
|
+
/** Page size */
|
|
1398
|
+
pageSize: number;
|
|
1399
|
+
/** Total items */
|
|
1400
|
+
totalItems: number;
|
|
1401
|
+
/** Contents */
|
|
1402
|
+
contents: DiskVideoScriptInfo[];
|
|
1403
|
+
}
|
|
1404
|
+
/**
|
|
1405
|
+
* Parameters for deleting disk video script
|
|
1406
|
+
*/
|
|
1407
|
+
export interface DiskVideoScriptDeleteParams {
|
|
1408
|
+
/** Channel ID */
|
|
1409
|
+
channelId: string;
|
|
1410
|
+
/** Script ID */
|
|
1411
|
+
scriptId: string;
|
|
1412
|
+
}
|
|
1413
|
+
/**
|
|
1414
|
+
* Share settings
|
|
1415
|
+
*/
|
|
1416
|
+
export interface ShareSettings {
|
|
1417
|
+
/** Channel ID */
|
|
1418
|
+
channelId: string;
|
|
1419
|
+
/** Share title */
|
|
1420
|
+
title: string;
|
|
1421
|
+
/** Share description */
|
|
1422
|
+
description: string;
|
|
1423
|
+
/** Share image URL */
|
|
1424
|
+
imageUrl: string;
|
|
1425
|
+
}
|
|
1426
|
+
/**
|
|
1427
|
+
* Parameters for getting share settings
|
|
1428
|
+
*/
|
|
1429
|
+
export interface ShareGetParams {
|
|
1430
|
+
/** Channel ID */
|
|
1431
|
+
channelId: string;
|
|
1432
|
+
}
|
|
1433
|
+
/**
|
|
1434
|
+
* Parameters for updating share settings
|
|
1435
|
+
*/
|
|
1436
|
+
export interface ShareUpdateParams {
|
|
1437
|
+
/** Channel ID */
|
|
1438
|
+
channelId: string;
|
|
1439
|
+
/** Share title */
|
|
1440
|
+
title?: string;
|
|
1441
|
+
/** Share description */
|
|
1442
|
+
description?: string;
|
|
1443
|
+
/** Share image URL */
|
|
1444
|
+
imageUrl?: string;
|
|
1445
|
+
}
|
|
1446
|
+
/**
|
|
1447
|
+
* Card push info
|
|
1448
|
+
*/
|
|
1449
|
+
export interface CardPushInfo {
|
|
1450
|
+
/** Card push ID */
|
|
1451
|
+
id: number;
|
|
1452
|
+
/** Channel ID */
|
|
1453
|
+
channelId: string;
|
|
1454
|
+
/** Card title */
|
|
1455
|
+
title: string;
|
|
1456
|
+
/** Card content */
|
|
1457
|
+
content: string;
|
|
1458
|
+
/** Card type */
|
|
1459
|
+
type: string;
|
|
1460
|
+
/** Card URL */
|
|
1461
|
+
url: string;
|
|
1462
|
+
/** Created time */
|
|
1463
|
+
createdTime: number;
|
|
1464
|
+
}
|
|
1465
|
+
/**
|
|
1466
|
+
* Parameters for creating card push
|
|
1467
|
+
*/
|
|
1468
|
+
export interface CardPushCreateParams {
|
|
1469
|
+
/** Channel ID */
|
|
1470
|
+
channelId: string;
|
|
1471
|
+
/** Card title */
|
|
1472
|
+
title: string;
|
|
1473
|
+
/** Card content */
|
|
1474
|
+
content: string;
|
|
1475
|
+
/** Card type */
|
|
1476
|
+
type: string;
|
|
1477
|
+
/** Card URL */
|
|
1478
|
+
url?: string;
|
|
1479
|
+
}
|
|
1480
|
+
/**
|
|
1481
|
+
* Response for creating card push
|
|
1482
|
+
*/
|
|
1483
|
+
export interface CardPushCreateResponse {
|
|
1484
|
+
/** Card push ID */
|
|
1485
|
+
id: number;
|
|
1486
|
+
}
|
|
1487
|
+
/**
|
|
1488
|
+
* Parameters for getting card push
|
|
1489
|
+
*/
|
|
1490
|
+
export interface CardPushGetParams {
|
|
1491
|
+
/** Channel ID */
|
|
1492
|
+
channelId: string;
|
|
1493
|
+
/** Card push ID */
|
|
1494
|
+
id: number;
|
|
1495
|
+
}
|
|
1496
|
+
/**
|
|
1497
|
+
* Parameters for updating card push
|
|
1498
|
+
*/
|
|
1499
|
+
export interface CardPushUpdateParams {
|
|
1500
|
+
/** Channel ID */
|
|
1501
|
+
channelId: string;
|
|
1502
|
+
/** Card push ID */
|
|
1503
|
+
id: number;
|
|
1504
|
+
/** Card title */
|
|
1505
|
+
title?: string;
|
|
1506
|
+
/** Card content */
|
|
1507
|
+
content?: string;
|
|
1508
|
+
/** Card URL */
|
|
1509
|
+
url?: string;
|
|
1510
|
+
}
|
|
1511
|
+
/**
|
|
1512
|
+
* Parameters for deleting card push
|
|
1513
|
+
*/
|
|
1514
|
+
export interface CardPushDeleteParams {
|
|
1515
|
+
/** Channel ID */
|
|
1516
|
+
channelId: string;
|
|
1517
|
+
/** Card push ID */
|
|
1518
|
+
id: number;
|
|
1519
|
+
}
|
|
1520
|
+
/**
|
|
1521
|
+
* Parameters for pushing card
|
|
1522
|
+
*/
|
|
1523
|
+
export interface CardPushPushParams {
|
|
1524
|
+
/** Channel ID */
|
|
1525
|
+
channelId: string;
|
|
1526
|
+
/** Card push ID */
|
|
1527
|
+
id: number;
|
|
1528
|
+
}
|
|
1529
|
+
/**
|
|
1530
|
+
* Parameters for canceling card push
|
|
1531
|
+
*/
|
|
1532
|
+
export interface CardPushCancelPushParams {
|
|
1533
|
+
/** Channel ID */
|
|
1534
|
+
channelId: string;
|
|
1535
|
+
/** Card push ID */
|
|
1536
|
+
id: number;
|
|
1537
|
+
}
|
|
1538
|
+
/**
|
|
1539
|
+
* Parameters for browsers summary
|
|
1540
|
+
*/
|
|
1541
|
+
export interface BrowsersSummaryParams {
|
|
1542
|
+
/** Channel ID */
|
|
1543
|
+
channelId: string;
|
|
1544
|
+
/** Start time */
|
|
1545
|
+
startTime: string;
|
|
1546
|
+
/** End time */
|
|
1547
|
+
endTime: string;
|
|
1548
|
+
}
|
|
1549
|
+
/**
|
|
1550
|
+
* Browsers summary
|
|
1551
|
+
*/
|
|
1552
|
+
export interface BrowsersSummary {
|
|
1553
|
+
/** Channel ID */
|
|
1554
|
+
channelId: string;
|
|
1555
|
+
/** Browser types */
|
|
1556
|
+
browsers: Array<{
|
|
1557
|
+
browserType: string;
|
|
1558
|
+
count: number;
|
|
1559
|
+
percentage: number;
|
|
1560
|
+
}>;
|
|
1561
|
+
}
|
|
1562
|
+
/**
|
|
1563
|
+
* Parameters for geo summary
|
|
1564
|
+
*/
|
|
1565
|
+
export interface GeoSummaryParams {
|
|
1566
|
+
/** Channel ID */
|
|
1567
|
+
channelId: string;
|
|
1568
|
+
/** Start time */
|
|
1569
|
+
startTime: string;
|
|
1570
|
+
/** End time */
|
|
1571
|
+
endTime: string;
|
|
1572
|
+
}
|
|
1573
|
+
/**
|
|
1574
|
+
* Geo summary
|
|
1575
|
+
*/
|
|
1576
|
+
export interface GeoSummary {
|
|
1577
|
+
/** Channel ID */
|
|
1578
|
+
channelId: string;
|
|
1579
|
+
/** Regions */
|
|
1580
|
+
regions: Array<{
|
|
1581
|
+
region: string;
|
|
1582
|
+
count: number;
|
|
1583
|
+
percentage: number;
|
|
1584
|
+
}>;
|
|
1585
|
+
}
|
|
1586
|
+
/**
|
|
1587
|
+
* Parameters for invite rank
|
|
1588
|
+
*/
|
|
1589
|
+
export interface GetInviteRankParams {
|
|
1590
|
+
/** Channel ID */
|
|
1591
|
+
channelId: string;
|
|
1592
|
+
}
|
|
1593
|
+
/**
|
|
1594
|
+
* Invite rank info
|
|
1595
|
+
*/
|
|
1596
|
+
export interface InviteRankInfo {
|
|
1597
|
+
/** Viewer ID */
|
|
1598
|
+
viewerId: string;
|
|
1599
|
+
/** Viewer name */
|
|
1600
|
+
viewerName: string;
|
|
1601
|
+
/** Invite count */
|
|
1602
|
+
inviteCount: number;
|
|
1603
|
+
/** Rank */
|
|
1604
|
+
rank: number;
|
|
1605
|
+
}
|
|
1606
|
+
/**
|
|
1607
|
+
* Parameters for invite stats
|
|
1608
|
+
*/
|
|
1609
|
+
export interface GetInviteStatsParams {
|
|
1610
|
+
/** Channel ID */
|
|
1611
|
+
channelId: string;
|
|
1612
|
+
}
|
|
1613
|
+
/**
|
|
1614
|
+
* Invite stats
|
|
1615
|
+
*/
|
|
1616
|
+
export interface InviteStats {
|
|
1617
|
+
/** Channel ID */
|
|
1618
|
+
channelId: string;
|
|
1619
|
+
/** Total invites */
|
|
1620
|
+
totalInvites: number;
|
|
1621
|
+
/** Unique inviters */
|
|
1622
|
+
uniqueInviters: number;
|
|
1623
|
+
}
|
|
1624
|
+
/**
|
|
1625
|
+
* Parameters for live summary
|
|
1626
|
+
*/
|
|
1627
|
+
export interface LiveSummaryParams {
|
|
1628
|
+
/** Channel ID */
|
|
1629
|
+
channelId: string;
|
|
1630
|
+
/** Start time */
|
|
1631
|
+
startTime: string;
|
|
1632
|
+
/** End time */
|
|
1633
|
+
endTime: string;
|
|
1634
|
+
}
|
|
1635
|
+
/**
|
|
1636
|
+
* Live summary
|
|
1637
|
+
*/
|
|
1638
|
+
export interface LiveSummary {
|
|
1639
|
+
/** Channel ID */
|
|
1640
|
+
channelId: string;
|
|
1641
|
+
/** Total views */
|
|
1642
|
+
totalViews: number;
|
|
1643
|
+
/** Unique viewers */
|
|
1644
|
+
uniqueViewers: number;
|
|
1645
|
+
/** Average duration */
|
|
1646
|
+
averageDuration: number;
|
|
1647
|
+
/** Peak concurrent */
|
|
1648
|
+
peakConcurrent: number;
|
|
1649
|
+
}
|
|
1650
|
+
/**
|
|
1651
|
+
* Parameters for lottery list
|
|
1652
|
+
*/
|
|
1653
|
+
export interface LotteryListParams extends V4PaginationParams {
|
|
1654
|
+
/** Channel ID */
|
|
1655
|
+
channelId: string;
|
|
1656
|
+
}
|
|
1657
|
+
/**
|
|
1658
|
+
* Lottery info
|
|
1659
|
+
*/
|
|
1660
|
+
export interface LotteryInfo {
|
|
1661
|
+
/** Lottery ID */
|
|
1662
|
+
lotteryId: string;
|
|
1663
|
+
/** Lottery name */
|
|
1664
|
+
name: string;
|
|
1665
|
+
/** Winner count */
|
|
1666
|
+
winnerCount: number;
|
|
1667
|
+
/** Created time */
|
|
1668
|
+
createdTime: number;
|
|
1669
|
+
}
|
|
1670
|
+
/**
|
|
1671
|
+
* Parameters for WeChat booking stats
|
|
1672
|
+
*/
|
|
1673
|
+
export interface WeixinBookingStatsParams {
|
|
1674
|
+
/** Channel ID */
|
|
1675
|
+
channelId: string;
|
|
1676
|
+
}
|
|
1677
|
+
/**
|
|
1678
|
+
* WeChat booking stats
|
|
1679
|
+
*/
|
|
1680
|
+
export interface WeixinBookingStats {
|
|
1681
|
+
/** Channel ID */
|
|
1682
|
+
channelId: string;
|
|
1683
|
+
/** Total bookings */
|
|
1684
|
+
totalBookings: number;
|
|
1685
|
+
/** Booking rate */
|
|
1686
|
+
bookingRate: number;
|
|
1687
|
+
}
|
|
1688
|
+
/**
|
|
1689
|
+
* Parameters for sorting channel product
|
|
1690
|
+
*/
|
|
1691
|
+
export interface SortChannelProductParams {
|
|
1692
|
+
/** Channel ID */
|
|
1693
|
+
channelId: string;
|
|
1694
|
+
/** Product IDs in order */
|
|
1695
|
+
productIds: string[];
|
|
1696
|
+
}
|
|
1697
|
+
/**
|
|
1698
|
+
* Product settings
|
|
1699
|
+
*/
|
|
1700
|
+
export interface ProductSettings {
|
|
1701
|
+
/** Channel ID */
|
|
1702
|
+
channelId: string;
|
|
1703
|
+
/** Product enabled */
|
|
1704
|
+
productEnabled: YNFlag;
|
|
1705
|
+
/** Product layout */
|
|
1706
|
+
productLayout: string;
|
|
1707
|
+
}
|
|
1708
|
+
/**
|
|
1709
|
+
* Parameters for getting product setting
|
|
1710
|
+
*/
|
|
1711
|
+
export interface GetProductSettingParams {
|
|
1712
|
+
/** Channel ID */
|
|
1713
|
+
channelId: string;
|
|
1714
|
+
}
|
|
1715
|
+
/**
|
|
1716
|
+
* Parameters for updating product setting
|
|
1717
|
+
*/
|
|
1718
|
+
export interface UpdateProductSettingParams {
|
|
1719
|
+
/** Channel ID */
|
|
1720
|
+
channelId: string;
|
|
1721
|
+
/** Product enabled */
|
|
1722
|
+
productEnabled?: YNFlag;
|
|
1723
|
+
/** Product layout */
|
|
1724
|
+
productLayout?: string;
|
|
1725
|
+
}
|
|
1726
|
+
/**
|
|
1727
|
+
* Parameters for paging product stats
|
|
1728
|
+
*/
|
|
1729
|
+
export interface ProductStatsPageParams {
|
|
1730
|
+
/** Channel ID */
|
|
1731
|
+
channelId: string;
|
|
1732
|
+
/** Page number */
|
|
1733
|
+
pageNumber?: number;
|
|
1734
|
+
/** Page size */
|
|
1735
|
+
pageSize?: number;
|
|
1736
|
+
}
|
|
1737
|
+
/**
|
|
1738
|
+
* Product stats
|
|
1739
|
+
*/
|
|
1740
|
+
export interface ProductStats {
|
|
1741
|
+
/** Product ID */
|
|
1742
|
+
productId: string;
|
|
1743
|
+
/** Product name */
|
|
1744
|
+
productName: string;
|
|
1745
|
+
/** View count */
|
|
1746
|
+
viewCount: number;
|
|
1747
|
+
/** Click count */
|
|
1748
|
+
clickCount: number;
|
|
1749
|
+
/** Purchase count */
|
|
1750
|
+
purchaseCount: number;
|
|
1751
|
+
}
|
|
1752
|
+
/**
|
|
1753
|
+
* Response for paging product stats
|
|
1754
|
+
*/
|
|
1755
|
+
export interface ProductStatsPageResponse {
|
|
1756
|
+
/** Page number */
|
|
1757
|
+
pageNumber: number;
|
|
1758
|
+
/** Page size */
|
|
1759
|
+
pageSize: number;
|
|
1760
|
+
/** Total items */
|
|
1761
|
+
totalItems: number;
|
|
1762
|
+
/** Contents */
|
|
1763
|
+
contents: ProductStats[];
|
|
1764
|
+
}
|
|
1765
|
+
/**
|
|
1766
|
+
* Product tag info
|
|
1767
|
+
*/
|
|
1768
|
+
export interface ProductTag {
|
|
1769
|
+
/** Tag ID */
|
|
1770
|
+
tagId: string;
|
|
1771
|
+
/** Tag name */
|
|
1772
|
+
name: string;
|
|
1773
|
+
/** Tag color */
|
|
1774
|
+
color: string;
|
|
1775
|
+
}
|
|
1776
|
+
/**
|
|
1777
|
+
* Parameters for creating product tag
|
|
1778
|
+
*/
|
|
1779
|
+
export interface ProductTagCreateParams {
|
|
1780
|
+
/** Channel ID */
|
|
1781
|
+
channelId: string;
|
|
1782
|
+
/** Tag name */
|
|
1783
|
+
name: string;
|
|
1784
|
+
/** Tag color */
|
|
1785
|
+
color?: string;
|
|
1786
|
+
}
|
|
1787
|
+
/**
|
|
1788
|
+
* Response for creating product tag
|
|
1789
|
+
*/
|
|
1790
|
+
export interface ProductTagCreateResponse {
|
|
1791
|
+
/** Tag ID */
|
|
1792
|
+
tagId: string;
|
|
1793
|
+
}
|
|
1794
|
+
/**
|
|
1795
|
+
* Parameters for getting product tag
|
|
1796
|
+
*/
|
|
1797
|
+
export interface ProductTagGetParams {
|
|
1798
|
+
/** Channel ID */
|
|
1799
|
+
channelId: string;
|
|
1800
|
+
/** Tag ID */
|
|
1801
|
+
tagId: string;
|
|
1802
|
+
}
|
|
1803
|
+
/**
|
|
1804
|
+
* Parameters for listing product tags
|
|
1805
|
+
*/
|
|
1806
|
+
export interface ProductTagListParams {
|
|
1807
|
+
/** Channel ID */
|
|
1808
|
+
channelId: string;
|
|
1809
|
+
}
|
|
1810
|
+
/**
|
|
1811
|
+
* Parameters for updating product tag
|
|
1812
|
+
*/
|
|
1813
|
+
export interface ProductTagUpdateParams {
|
|
1814
|
+
/** Channel ID */
|
|
1815
|
+
channelId: string;
|
|
1816
|
+
/** Tag ID */
|
|
1817
|
+
tagId: string;
|
|
1818
|
+
/** Tag name */
|
|
1819
|
+
name?: string;
|
|
1820
|
+
/** Tag color */
|
|
1821
|
+
color?: string;
|
|
1822
|
+
}
|
|
1823
|
+
/**
|
|
1824
|
+
* Parameters for deleting product tag
|
|
1825
|
+
*/
|
|
1826
|
+
export interface ProductTagDeleteParams {
|
|
1827
|
+
/** Channel ID */
|
|
1828
|
+
channelId: string;
|
|
1829
|
+
/** Tag ID */
|
|
1830
|
+
tagId: string;
|
|
1831
|
+
}
|
|
1832
|
+
/**
|
|
1833
|
+
* Parameters for paging gifts
|
|
1834
|
+
*/
|
|
1835
|
+
export interface GiftPageParams {
|
|
1836
|
+
/** Channel ID */
|
|
1837
|
+
channelId: string;
|
|
1838
|
+
/** Page number */
|
|
1839
|
+
pageNumber?: number;
|
|
1840
|
+
/** Page size */
|
|
1841
|
+
pageSize?: number;
|
|
1842
|
+
/** Start time */
|
|
1843
|
+
startTime?: number;
|
|
1844
|
+
/** End time */
|
|
1845
|
+
endTime?: number;
|
|
1846
|
+
}
|
|
1847
|
+
/**
|
|
1848
|
+
* Gift info
|
|
1849
|
+
*/
|
|
1850
|
+
export interface GiftInfo {
|
|
1851
|
+
/** Gift ID */
|
|
1852
|
+
giftId: string;
|
|
1853
|
+
/** Gift name */
|
|
1854
|
+
giftName: string;
|
|
1855
|
+
/** Sender name */
|
|
1856
|
+
senderName: string;
|
|
1857
|
+
/** Amount */
|
|
1858
|
+
amount: number;
|
|
1859
|
+
/** Send time */
|
|
1860
|
+
sendTime: number;
|
|
1861
|
+
}
|
|
1862
|
+
/**
|
|
1863
|
+
* Response for paging gifts
|
|
1864
|
+
*/
|
|
1865
|
+
export interface GiftPageResponse {
|
|
1866
|
+
/** Page number */
|
|
1867
|
+
pageNumber: number;
|
|
1868
|
+
/** Page size */
|
|
1869
|
+
pageSize: number;
|
|
1870
|
+
/** Total items */
|
|
1871
|
+
totalItems: number;
|
|
1872
|
+
/** Contents */
|
|
1873
|
+
contents: GiftInfo[];
|
|
1874
|
+
}
|
|
1875
|
+
/**
|
|
1876
|
+
* Parameters for paging likes
|
|
1877
|
+
*/
|
|
1878
|
+
export interface LikePageParams {
|
|
1879
|
+
/** Channel ID */
|
|
1880
|
+
channelId: string;
|
|
1881
|
+
/** Page number */
|
|
1882
|
+
pageNumber?: number;
|
|
1883
|
+
/** Page size */
|
|
1884
|
+
pageSize?: number;
|
|
1885
|
+
/** Start time */
|
|
1886
|
+
startTime?: number;
|
|
1887
|
+
/** End time */
|
|
1888
|
+
endTime?: number;
|
|
1889
|
+
}
|
|
1890
|
+
/**
|
|
1891
|
+
* Like info
|
|
1892
|
+
*/
|
|
1893
|
+
export interface LikeInfo {
|
|
1894
|
+
/** Viewer ID */
|
|
1895
|
+
viewerId: string;
|
|
1896
|
+
/** Viewer name */
|
|
1897
|
+
viewerName: string;
|
|
1898
|
+
/** Like count */
|
|
1899
|
+
likeCount: number;
|
|
1900
|
+
/** Like time */
|
|
1901
|
+
likeTime: number;
|
|
1902
|
+
}
|
|
1903
|
+
/**
|
|
1904
|
+
* Response for paging likes
|
|
1905
|
+
*/
|
|
1906
|
+
export interface LikePageResponse {
|
|
1907
|
+
/** Page number */
|
|
1908
|
+
pageNumber: number;
|
|
1909
|
+
/** Page size */
|
|
1910
|
+
pageSize: number;
|
|
1911
|
+
/** Total items */
|
|
1912
|
+
totalItems: number;
|
|
1913
|
+
/** Contents */
|
|
1914
|
+
contents: LikeInfo[];
|
|
1915
|
+
}
|
|
1916
|
+
/**
|
|
1917
|
+
* Task reward info
|
|
1918
|
+
*/
|
|
1919
|
+
export interface TaskReward {
|
|
1920
|
+
/** Task ID */
|
|
1921
|
+
taskId: string;
|
|
1922
|
+
/** Channel ID */
|
|
1923
|
+
channelId: string;
|
|
1924
|
+
/** Task name */
|
|
1925
|
+
name: string;
|
|
1926
|
+
/** Task type */
|
|
1927
|
+
type: string;
|
|
1928
|
+
/** Status */
|
|
1929
|
+
status: string;
|
|
1930
|
+
/** Start time */
|
|
1931
|
+
startTime: number;
|
|
1932
|
+
/** End time */
|
|
1933
|
+
endTime: number;
|
|
1934
|
+
/** Created time */
|
|
1935
|
+
createdTime: number;
|
|
1936
|
+
}
|
|
1937
|
+
/**
|
|
1938
|
+
* Parameters for creating task reward
|
|
1939
|
+
*/
|
|
1940
|
+
export interface TaskRewardCreateParams {
|
|
1941
|
+
/** Channel ID */
|
|
1942
|
+
channelId: string;
|
|
1943
|
+
/** Task name */
|
|
1944
|
+
name: string;
|
|
1945
|
+
/** Task type */
|
|
1946
|
+
type: string;
|
|
1947
|
+
/** Start time */
|
|
1948
|
+
startTime?: number;
|
|
1949
|
+
/** End time */
|
|
1950
|
+
endTime?: number;
|
|
1951
|
+
}
|
|
1952
|
+
/**
|
|
1953
|
+
* Response for creating task reward
|
|
1954
|
+
*/
|
|
1955
|
+
export interface TaskRewardCreateResponse {
|
|
1956
|
+
/** Task ID */
|
|
1957
|
+
taskId: string;
|
|
1958
|
+
}
|
|
1959
|
+
/**
|
|
1960
|
+
* Parameters for getting task reward
|
|
1961
|
+
*/
|
|
1962
|
+
export interface TaskRewardGetParams {
|
|
1963
|
+
/** Channel ID */
|
|
1964
|
+
channelId: string;
|
|
1965
|
+
/** Task ID */
|
|
1966
|
+
taskId: string;
|
|
1967
|
+
}
|
|
1968
|
+
/**
|
|
1969
|
+
* Parameters for paging task rewards
|
|
1970
|
+
*/
|
|
1971
|
+
export interface TaskRewardPageParams {
|
|
1972
|
+
/** Channel ID */
|
|
1973
|
+
channelId: string;
|
|
1974
|
+
/** Page number */
|
|
1975
|
+
pageNumber?: number;
|
|
1976
|
+
/** Page size */
|
|
1977
|
+
pageSize?: number;
|
|
1978
|
+
}
|
|
1979
|
+
/**
|
|
1980
|
+
* Response for paging task rewards
|
|
1981
|
+
*/
|
|
1982
|
+
export interface TaskRewardPageResponse {
|
|
1983
|
+
/** Page number */
|
|
1984
|
+
pageNumber: number;
|
|
1985
|
+
/** Page size */
|
|
1986
|
+
pageSize: number;
|
|
1987
|
+
/** Total items */
|
|
1988
|
+
totalItems: number;
|
|
1989
|
+
/** Contents */
|
|
1990
|
+
contents: TaskReward[];
|
|
1991
|
+
}
|
|
1992
|
+
/**
|
|
1993
|
+
* Parameters for updating task reward
|
|
1994
|
+
*/
|
|
1995
|
+
export interface TaskRewardUpdateParams {
|
|
1996
|
+
/** Channel ID */
|
|
1997
|
+
channelId: string;
|
|
1998
|
+
/** Task ID */
|
|
1999
|
+
taskId: string;
|
|
2000
|
+
/** Task name */
|
|
2001
|
+
name?: string;
|
|
2002
|
+
/** Start time */
|
|
2003
|
+
startTime?: number;
|
|
2004
|
+
/** End time */
|
|
2005
|
+
endTime?: number;
|
|
2006
|
+
}
|
|
2007
|
+
/**
|
|
2008
|
+
* Parameters for deleting task reward
|
|
2009
|
+
*/
|
|
2010
|
+
export interface TaskRewardDeleteParams {
|
|
2011
|
+
/** Channel ID */
|
|
2012
|
+
channelId: string;
|
|
2013
|
+
/** Task ID */
|
|
2014
|
+
taskId: string;
|
|
2015
|
+
}
|
|
2016
|
+
/**
|
|
2017
|
+
* Parameters for stopping task reward
|
|
2018
|
+
*/
|
|
2019
|
+
export interface TaskRewardStopParams {
|
|
2020
|
+
/** Channel ID */
|
|
2021
|
+
channelId: string;
|
|
2022
|
+
/** Task ID */
|
|
2023
|
+
taskId: string;
|
|
2024
|
+
}
|
|
2025
|
+
/**
|
|
2026
|
+
* Parameters for getting task reward stats
|
|
2027
|
+
*/
|
|
2028
|
+
export interface TaskRewardStatsParams {
|
|
2029
|
+
/** Channel ID */
|
|
2030
|
+
channelId: string;
|
|
2031
|
+
/** Task ID */
|
|
2032
|
+
taskId: string;
|
|
2033
|
+
}
|
|
2034
|
+
/**
|
|
2035
|
+
* Task reward stats
|
|
2036
|
+
*/
|
|
2037
|
+
export interface TaskRewardStats {
|
|
2038
|
+
/** Task ID */
|
|
2039
|
+
taskId: string;
|
|
2040
|
+
/** Channel ID */
|
|
2041
|
+
channelId: string;
|
|
2042
|
+
/** Total participants */
|
|
2043
|
+
totalParticipants: number;
|
|
2044
|
+
/** Completed count */
|
|
2045
|
+
completedCount: number;
|
|
2046
|
+
/** Completion rate */
|
|
2047
|
+
completionRate: number;
|
|
2048
|
+
}
|
|
2049
|
+
/**
|
|
2050
|
+
* Parameters for submitting accept info
|
|
2051
|
+
*/
|
|
2052
|
+
export interface TaskRewardSubmitAcceptInfoParams {
|
|
2053
|
+
/** Channel ID */
|
|
2054
|
+
channelId: string;
|
|
2055
|
+
/** Task ID */
|
|
2056
|
+
taskId: string;
|
|
2057
|
+
/** Viewer ID */
|
|
2058
|
+
viewerId: string;
|
|
2059
|
+
/** Accept info */
|
|
2060
|
+
acceptInfo: Record<string, unknown>;
|
|
2061
|
+
}
|
|
2062
|
+
/**
|
|
2063
|
+
* Parameters for getting viewer detail
|
|
2064
|
+
*/
|
|
2065
|
+
export interface TaskRewardViewerDetailParams {
|
|
2066
|
+
/** Channel ID */
|
|
2067
|
+
channelId: string;
|
|
2068
|
+
/** Task ID */
|
|
2069
|
+
taskId: string;
|
|
2070
|
+
/** Viewer ID */
|
|
2071
|
+
viewerId: string;
|
|
2072
|
+
}
|
|
2073
|
+
/**
|
|
2074
|
+
* Task reward viewer detail
|
|
2075
|
+
*/
|
|
2076
|
+
export interface TaskRewardViewerDetail {
|
|
2077
|
+
/** Viewer ID */
|
|
2078
|
+
viewerId: string;
|
|
2079
|
+
/** Viewer name */
|
|
2080
|
+
viewerName: string;
|
|
2081
|
+
/** Task ID */
|
|
2082
|
+
taskId: string;
|
|
2083
|
+
/** Status */
|
|
2084
|
+
status: string;
|
|
2085
|
+
/** Progress */
|
|
2086
|
+
progress: number;
|
|
2087
|
+
/** Accept info */
|
|
2088
|
+
acceptInfo: Record<string, unknown>;
|
|
2089
|
+
}
|
|
2090
|
+
/**
|
|
2091
|
+
* Parameters for getting viewer union detail
|
|
2092
|
+
*/
|
|
2093
|
+
export interface TaskRewardViewerUnionDetailParams {
|
|
2094
|
+
/** Channel ID */
|
|
2095
|
+
channelId: string;
|
|
2096
|
+
/** Task ID */
|
|
2097
|
+
taskId: string;
|
|
2098
|
+
/** Union ID */
|
|
2099
|
+
unionId: string;
|
|
2100
|
+
}
|
|
2101
|
+
/**
|
|
2102
|
+
* Task reward viewer union detail
|
|
2103
|
+
*/
|
|
2104
|
+
export interface TaskRewardViewerUnionDetail {
|
|
2105
|
+
/** Union ID */
|
|
2106
|
+
unionId: string;
|
|
2107
|
+
/** Task ID */
|
|
2108
|
+
taskId: string;
|
|
2109
|
+
/** Status */
|
|
2110
|
+
status: string;
|
|
2111
|
+
/** Progress */
|
|
2112
|
+
progress: number;
|
|
2113
|
+
}
|
|
2114
|
+
/**
|
|
2115
|
+
* Parameters for getting subtitle
|
|
2116
|
+
*/
|
|
2117
|
+
export interface GetSubtitleParams {
|
|
2118
|
+
/** Channel ID */
|
|
2119
|
+
channelId: string;
|
|
2120
|
+
/** Video ID */
|
|
2121
|
+
videoId?: string;
|
|
2122
|
+
}
|
|
2123
|
+
/**
|
|
2124
|
+
* Subtitle info
|
|
2125
|
+
*/
|
|
2126
|
+
export interface SubtitleInfo {
|
|
2127
|
+
/** Subtitle ID */
|
|
2128
|
+
subtitleId: string;
|
|
2129
|
+
/** Language */
|
|
2130
|
+
language: string;
|
|
2131
|
+
/** URL */
|
|
2132
|
+
url: string;
|
|
2133
|
+
}
|
|
2134
|
+
/**
|
|
2135
|
+
* Language info
|
|
2136
|
+
*/
|
|
2137
|
+
export interface LanguageInfo {
|
|
2138
|
+
/** Language code */
|
|
2139
|
+
code: string;
|
|
2140
|
+
/** Language name */
|
|
2141
|
+
name: string;
|
|
2142
|
+
}
|
|
2143
|
+
/**
|
|
2144
|
+
* Parameters for updating subtitle
|
|
2145
|
+
*/
|
|
2146
|
+
export interface UpdateSubtitleParams {
|
|
2147
|
+
/** Channel ID */
|
|
2148
|
+
channelId: string;
|
|
2149
|
+
/** Video ID */
|
|
2150
|
+
videoId: string;
|
|
2151
|
+
/** Subtitle URL */
|
|
2152
|
+
subtitleUrl: string;
|
|
2153
|
+
/** Language */
|
|
2154
|
+
language: string;
|
|
2155
|
+
}
|
|
2156
|
+
/**
|
|
2157
|
+
* Parameters for getting by role
|
|
2158
|
+
*/
|
|
2159
|
+
export interface GetByRoleParams {
|
|
2160
|
+
/** Channel ID */
|
|
2161
|
+
channelId: string;
|
|
2162
|
+
/** Role */
|
|
2163
|
+
role: string;
|
|
2164
|
+
}
|
|
2165
|
+
/**
|
|
2166
|
+
* Role config
|
|
2167
|
+
*/
|
|
2168
|
+
export interface RoleConfig {
|
|
2169
|
+
/** Channel ID */
|
|
2170
|
+
channelId: string;
|
|
2171
|
+
/** Role */
|
|
2172
|
+
role: string;
|
|
2173
|
+
/** Config */
|
|
2174
|
+
config: Record<string, unknown>;
|
|
2175
|
+
}
|
|
2176
|
+
/**
|
|
2177
|
+
* Parameters for updating by role
|
|
2178
|
+
*/
|
|
2179
|
+
export interface UpdateByRoleParams {
|
|
2180
|
+
/** Channel ID */
|
|
2181
|
+
channelId: string;
|
|
2182
|
+
/** Role */
|
|
2183
|
+
role: string;
|
|
2184
|
+
/** Config */
|
|
2185
|
+
config: Record<string, unknown>;
|
|
2186
|
+
}
|
|
2187
|
+
/**
|
|
2188
|
+
* Parameters for viewer logout
|
|
2189
|
+
*/
|
|
2190
|
+
export interface ViewerLogoutParams {
|
|
2191
|
+
/** Channel ID */
|
|
2192
|
+
channelId: string;
|
|
2193
|
+
/** Viewer ID */
|
|
2194
|
+
viewerId: string;
|
|
2195
|
+
}
|
|
2196
|
+
/**
|
|
2197
|
+
* Live status info
|
|
2198
|
+
*/
|
|
2199
|
+
export interface LiveStatusInfo {
|
|
2200
|
+
/** Channel ID */
|
|
2201
|
+
channelId: string;
|
|
2202
|
+
/** Live status */
|
|
2203
|
+
liveStatus: WatchStatus;
|
|
2204
|
+
/** Session ID */
|
|
2205
|
+
sessionId: string;
|
|
2206
|
+
/** Viewer count */
|
|
2207
|
+
viewerCount: number;
|
|
2208
|
+
}
|
|
2209
|
+
/**
|
|
2210
|
+
* Stream info
|
|
2211
|
+
*/
|
|
2212
|
+
export interface StreamInfo {
|
|
2213
|
+
/** Channel ID */
|
|
2214
|
+
channelId: string;
|
|
2215
|
+
/** Stream type */
|
|
2216
|
+
streamType: string;
|
|
2217
|
+
/** Stream URL */
|
|
2218
|
+
streamUrl: string;
|
|
2219
|
+
/** Status */
|
|
2220
|
+
status: string;
|
|
2221
|
+
}
|
|
2222
|
+
/**
|
|
2223
|
+
* Parameters for batch creating popularization
|
|
2224
|
+
*/
|
|
2225
|
+
export interface BatchCreatePopularizationParams {
|
|
2226
|
+
/** Channel ID */
|
|
2227
|
+
channelId: string;
|
|
2228
|
+
/** Popularizations */
|
|
2229
|
+
popularizations: Array<{
|
|
2230
|
+
name: string;
|
|
2231
|
+
url: string;
|
|
2232
|
+
}>;
|
|
2233
|
+
}
|
|
2234
|
+
/**
|
|
2235
|
+
* Response for batch creating popularization
|
|
2236
|
+
*/
|
|
2237
|
+
export interface BatchCreatePopularizationResponse {
|
|
2238
|
+
/** Created count */
|
|
2239
|
+
createdCount: number;
|
|
2240
|
+
}
|
|
2241
|
+
/**
|
|
2242
|
+
* Parameters for listing popularization
|
|
2243
|
+
*/
|
|
2244
|
+
export interface PopularizationListParams {
|
|
2245
|
+
/** Channel ID */
|
|
2246
|
+
channelId: string;
|
|
2247
|
+
/** Page number */
|
|
2248
|
+
pageNumber?: number;
|
|
2249
|
+
/** Page size */
|
|
2250
|
+
pageSize?: number;
|
|
2251
|
+
}
|
|
2252
|
+
/**
|
|
2253
|
+
* Popularization info
|
|
2254
|
+
*/
|
|
2255
|
+
export interface PopularizationInfo {
|
|
2256
|
+
/** Popularization ID */
|
|
2257
|
+
id: string;
|
|
2258
|
+
/** Channel ID */
|
|
2259
|
+
channelId: string;
|
|
2260
|
+
/** Name */
|
|
2261
|
+
name: string;
|
|
2262
|
+
/** URL */
|
|
2263
|
+
url: string;
|
|
2264
|
+
/** View count */
|
|
2265
|
+
viewCount: number;
|
|
2266
|
+
/** Created time */
|
|
2267
|
+
createdTime: number;
|
|
2268
|
+
}
|
|
2269
|
+
/**
|
|
2270
|
+
* Response for listing popularization
|
|
2271
|
+
*/
|
|
2272
|
+
export interface PopularizationListResponse {
|
|
2273
|
+
/** Page number */
|
|
2274
|
+
pageNumber: number;
|
|
2275
|
+
/** Page size */
|
|
2276
|
+
pageSize: number;
|
|
2277
|
+
/** Total items */
|
|
2278
|
+
totalItems: number;
|
|
2279
|
+
/** Contents */
|
|
2280
|
+
contents: PopularizationInfo[];
|
|
2281
|
+
}
|
|
2282
|
+
/**
|
|
2283
|
+
* Parameters for getting live session
|
|
2284
|
+
*/
|
|
2285
|
+
export interface GetLiveSessionParams {
|
|
2286
|
+
/** Channel ID */
|
|
2287
|
+
channelId: string;
|
|
2288
|
+
/** Session ID */
|
|
2289
|
+
sessionId?: string;
|
|
2290
|
+
}
|
|
2291
|
+
/**
|
|
2292
|
+
* Live session info
|
|
2293
|
+
*/
|
|
2294
|
+
export interface LiveSessionInfo {
|
|
2295
|
+
/** Session ID */
|
|
2296
|
+
sessionId: string;
|
|
2297
|
+
/** Channel ID */
|
|
2298
|
+
channelId: string;
|
|
2299
|
+
/** Start time */
|
|
2300
|
+
startTime: number;
|
|
2301
|
+
/** End time */
|
|
2302
|
+
endTime: number;
|
|
2303
|
+
/** Duration */
|
|
2304
|
+
duration: number;
|
|
2305
|
+
/** Viewer count */
|
|
2306
|
+
viewerCount: number;
|
|
2307
|
+
/** Max viewer count */
|
|
2308
|
+
maxViewerCount: number;
|
|
2309
|
+
}
|
|
2310
|
+
/** V4 Pagination parameters */
|
|
2311
|
+
export interface V4PaginationParams {
|
|
2312
|
+
/** Page number (1-based) */
|
|
2313
|
+
page?: number;
|
|
2314
|
+
/** Page number alias */
|
|
2315
|
+
pageNumber?: number;
|
|
2316
|
+
/** Page size */
|
|
2317
|
+
pageSize?: number;
|
|
2318
|
+
}
|
|
2319
|
+
/** V4 Paginated response wrapper */
|
|
2320
|
+
export interface V4PaginatedResponse<T> {
|
|
2321
|
+
/** Data items */
|
|
2322
|
+
contents: T[];
|
|
2323
|
+
/** Total count */
|
|
2324
|
+
total: number;
|
|
2325
|
+
/** Current page */
|
|
2326
|
+
pageNo?: number;
|
|
2327
|
+
/** Page size */
|
|
2328
|
+
pageSize?: number;
|
|
2329
|
+
}
|
|
2330
|
+
/** Channel ID parameter */
|
|
2331
|
+
export interface ChannelIdParam {
|
|
2332
|
+
/** Channel ID */
|
|
2333
|
+
channelId: string;
|
|
2334
|
+
}
|
|
2335
|
+
/** Alias for ChannelScene (newScene in API) */
|
|
2336
|
+
export type NewScene = ChannelScene;
|
|
2337
|
+
/** Alias for ChannelTemplate */
|
|
2338
|
+
export type Template = ChannelTemplate;
|
|
2339
|
+
/** Broadcast type */
|
|
2340
|
+
export type BroadcastType = 'normal' | 'transmit' | 'receive';
|
|
2341
|
+
/** Double teacher type */
|
|
2342
|
+
export type DoubleTeacherType = 'normal' | 'transmit' | 'receive';
|
|
2343
|
+
export type BatchCreateChannelsParams = CreateBatchChannelsParams;
|
|
2344
|
+
export type BatchCreateChannelsResponse = CreateBatchChannelsResponse;
|
|
2345
|
+
export type ChannelDetail = ChannelDetailInfo;
|
|
2346
|
+
export type ChannelBasicListItem = ChannelBasicInfo;
|
|
2347
|
+
export type ChannelSimpleListItem = ChannelSimpleInfo;
|
|
2348
|
+
export type ChannelDetailListItem = ChannelDetailInfo;
|
|
2349
|
+
export type DistributeItem = DistributeInfo;
|
|
2350
|
+
export type ListDistributeParams = DistributeListParams;
|
|
2351
|
+
export type CreateDistributeBatchParams = DistributeCreateBatchParams;
|
|
2352
|
+
export type UpdateDistributeBatchParams = DistributeUpdateBatchParams;
|
|
2353
|
+
export type DeleteDistributeBatchParams = DistributeDeleteBatchParams;
|
|
2354
|
+
export type GetDistributeStatisticParams = DistributeStatisticParams;
|
|
2355
|
+
export type PlaybackItem = PlaybackInfo;
|
|
2356
|
+
export type RecordedFileItem = RecordedFileInfo;
|
|
2357
|
+
export type CreateLotteryActivityParams = LotteryActivityCreateParams;
|
|
2358
|
+
export type CreateLotteryActivityResponse = LotteryActivityCreateResponse;
|
|
2359
|
+
export type GetLotteryActivityParams = LotteryActivityGetParams;
|
|
2360
|
+
export type ListLotteryActivitiesParams = LotteryActivityListParams;
|
|
2361
|
+
export type UpdateLotteryActivityParams = LotteryActivityUpdateParams;
|
|
2362
|
+
export type DeleteLotteryActivityParams = LotteryActivityDeleteParams;
|
|
2363
|
+
export type GroupResponse = GroupAddResponse;
|
|
2364
|
+
export type CreateViewerNameGroupParams = GroupCreateViewerNameParams;
|
|
2365
|
+
export type CardPushItem = CardPushInfo;
|
|
2366
|
+
export type GetShareParams = ShareGetParams;
|
|
2367
|
+
export type UpdateShareParams = ShareUpdateParams;
|
|
2368
|
+
export type CreateCardPushParams = CardPushCreateParams;
|
|
2369
|
+
export type CreateCardPushResponse = CardPushCreateResponse;
|
|
2370
|
+
export type GetCardPushParams = CardPushGetParams;
|
|
2371
|
+
export type UpdateCardPushParams = CardPushUpdateParams;
|
|
2372
|
+
export type DeleteCardPushParams = CardPushDeleteParams;
|
|
2373
|
+
export type PushCardParams = CardPushPushParams;
|
|
2374
|
+
export type CancelCardPushParams = CardPushCancelPushParams;
|
|
2375
|
+
export type InviteRankItem = InviteRankInfo;
|
|
2376
|
+
export type LiveStatusItem = LiveStatusInfo;
|
|
2377
|
+
export type MonitorStreamInfo = StreamInfo;
|
|
2378
|
+
export type LotteryStatistics = LotteryInfo;
|
|
2379
|
+
export type ProductSetting = ProductSettings;
|
|
2380
|
+
export type ProductStatsItem = ProductStats;
|
|
2381
|
+
export type CreateProductTagParams = ProductTagCreateParams;
|
|
2382
|
+
export type CreateProductTagResponse = ProductTagCreateResponse;
|
|
2383
|
+
export type GetProductTagParams = ProductTagGetParams;
|
|
2384
|
+
export type ListProductTagsParams = ProductTagListParams;
|
|
2385
|
+
export type UpdateProductTagParams = ProductTagUpdateParams;
|
|
2386
|
+
export type DeleteProductTagParams = ProductTagDeleteParams;
|
|
2387
|
+
export type GiftItem = GiftInfo;
|
|
2388
|
+
export type LikeItem = LikeInfo;
|
|
2389
|
+
export type CreateTaskRewardParams = TaskRewardCreateParams;
|
|
2390
|
+
export type CreateTaskRewardResponse = TaskRewardCreateResponse;
|
|
2391
|
+
export type GetTaskRewardParams = TaskRewardGetParams;
|
|
2392
|
+
export type UpdateTaskRewardParams = TaskRewardUpdateParams;
|
|
2393
|
+
export type DeleteTaskRewardParams = TaskRewardDeleteParams;
|
|
2394
|
+
export type StopTaskRewardParams = TaskRewardStopParams;
|
|
2395
|
+
export type GetTaskRewardStatsParams = TaskRewardStatsParams;
|
|
2396
|
+
export type SubmitAcceptInfoParams = TaskRewardSubmitAcceptInfoParams;
|
|
2397
|
+
export type GetViewerDetailParams = TaskRewardViewerDetailParams;
|
|
2398
|
+
export type GetViewerUnionDetailParams = TaskRewardViewerUnionDetailParams;
|
|
2399
|
+
export type PopularizationItem = PopularizationInfo;
|
|
2400
|
+
//# sourceMappingURL=v4-channel.d.ts.map
|