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,1014 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* V4 User Service
|
|
3
|
+
*
|
|
4
|
+
* Service for managing PolyV V4 User operations.
|
|
5
|
+
* Provides methods for sub-accounts, organizations, viewer records, products, labels, and more.
|
|
6
|
+
*
|
|
7
|
+
* @module services/v4/user
|
|
8
|
+
*/
|
|
9
|
+
import type { PolyVClient } from '../../client.js';
|
|
10
|
+
import type { CreateChildAccountParams, ChildAccount, ListChildAccountsParams, ListChildAccountsResponse, GetChildAccountParams, UpdateChildAccountParams, DeleteChildAccountsParams, ChildAccountRole, GetBySaleParams, ListOrganizationsResponse, CreateOrganizationParams, CreateOrganizationResponse, DeleteOrganizationParams, ListViewerRecordsParams, ListViewerRecordsResponse, GetViewerRecordParams, ViewerRecord, CreateViewerRecordParams, UpdateViewerRecordParams, DeleteViewerRecordParams, DirectAuthViewerParams, ImportExternalViewerParams, ListViewerLabelsResponse, CreateViewerLabelParams, CreateViewerLabelResponse, UpdateViewerLabelParams, DeleteViewerLabelParams, AddViewerLabelParams, DeleteViewerLabelRefParams, ListProductsParams, ListProductsResponse, CreateProductParams, CreateProductResponse, UpdateProductParams, DeleteProductParams, ListProductTagsResponse, CreateProductTagParams, CreateProductTagResponse, UpdateProductTagParams, DeleteProductTagParams, ListProductOrdersParams, ListProductOrdersResponse, GetProductOrderParams, ProductOrder, BatchUpdateOrderStatusParams, ListLabelsResponse, CreateLabelParams, CreateLabelResponse, UpdateLabelParams, DeleteLabelParams, AddChannelLabelRefsParams, ListInviteSalesResponse, AddInviteSaleParams, AddInviteSaleResponse, UpdateInviteSaleParams, RemoveInviteSaleParams, ListFollowViewersParams, ListFollowViewersResponse, ListCustomFieldsResponse, AddCustomFieldParams, AddCustomFieldResponse, AddCustomFieldValueParams, DonateTemplate, UpdateDonateTemplateParams, MarqueeTemplate, UpdateMarqueeTemplateParams, RoleConfigTemplate, UpdateRoleConfigTemplateParams, PlaybackSetting, UpdatePlaybackSettingParams, AudioModerationSetting, UpdateAudioModerationSettingParams, VideoModerationSetting, UpdateVideoModerationSettingParams, CallbackSettings, UpdateCallbackParams, GlobalSwitchSettings, UpdateGlobalSwitchParams, GlobalFooterSettings, UpdateGlobalFooterParams, PvShowEnableSettings, UpdatePvShowEnableParams, GetMicDurationParams, MicDurationResponse, MrConcurrencyDetailResponse, SendSmsParams, GetBillUseDetailListParams, GetBillUseDetailListResponse, ViewerLotteryWinParams, ViewerLotteryWinResponse, GetWatchLogDetailParams, WatchLogDetailResponse, GetWatchLogListParams, GetWatchLogListResponse } from '../../types/v4-user.js';
|
|
11
|
+
/**
|
|
12
|
+
* V4UserService
|
|
13
|
+
*
|
|
14
|
+
* Provides methods to interact with PolyV V4 User APIs.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```typescript
|
|
18
|
+
* const client = new PolyVClient({ appId: 'xxx', appSecret: 'yyy' });
|
|
19
|
+
* const accounts = await client.v4User.listChildAccounts({ pageNumber: 1, pageSize: 10 });
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
export declare class V4UserService {
|
|
23
|
+
private client;
|
|
24
|
+
/**
|
|
25
|
+
* Create a new V4UserService instance
|
|
26
|
+
*
|
|
27
|
+
* @param client - The PolyVClient instance to use for API calls
|
|
28
|
+
*/
|
|
29
|
+
constructor(client: PolyVClient);
|
|
30
|
+
/**
|
|
31
|
+
* Create a child account (sub-account)
|
|
32
|
+
*
|
|
33
|
+
* @param params - Account creation parameters
|
|
34
|
+
* @returns Created child account
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```typescript
|
|
38
|
+
* const account = await client.v4User.createChildAccount({
|
|
39
|
+
* childEmail: 'test@example.com',
|
|
40
|
+
* childName: 'Test User',
|
|
41
|
+
* password: 'Password123',
|
|
42
|
+
* roleId: 1,
|
|
43
|
+
* });
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
createChildAccount(params: CreateChildAccountParams): Promise<ChildAccount>;
|
|
47
|
+
/**
|
|
48
|
+
* List child accounts with pagination
|
|
49
|
+
*
|
|
50
|
+
* @param params - Query parameters
|
|
51
|
+
* @returns Paginated child account list
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```typescript
|
|
55
|
+
* const result = await client.v4User.listChildAccounts({
|
|
56
|
+
* pageNumber: 1,
|
|
57
|
+
* pageSize: 10,
|
|
58
|
+
* });
|
|
59
|
+
* ```
|
|
60
|
+
*/
|
|
61
|
+
listChildAccounts(params: ListChildAccountsParams): Promise<ListChildAccountsResponse>;
|
|
62
|
+
/**
|
|
63
|
+
* Get a child account by ID
|
|
64
|
+
*
|
|
65
|
+
* @param params - Query parameters
|
|
66
|
+
* @returns Child account details
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* ```typescript
|
|
70
|
+
* const account = await client.v4User.getChildAccount({
|
|
71
|
+
* childUserId: 'child_001',
|
|
72
|
+
* });
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
getChildAccount(params: GetChildAccountParams): Promise<ChildAccount>;
|
|
76
|
+
/**
|
|
77
|
+
* Update a child account
|
|
78
|
+
*
|
|
79
|
+
* @param params - Update parameters
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* ```typescript
|
|
83
|
+
* await client.v4User.updateChildAccount({
|
|
84
|
+
* childUserId: 'child_001',
|
|
85
|
+
* childName: 'Updated Name',
|
|
86
|
+
* });
|
|
87
|
+
* ```
|
|
88
|
+
*/
|
|
89
|
+
updateChildAccount(params: UpdateChildAccountParams): Promise<void>;
|
|
90
|
+
/**
|
|
91
|
+
* Delete child accounts
|
|
92
|
+
*
|
|
93
|
+
* @param params - Delete parameters
|
|
94
|
+
*
|
|
95
|
+
* @example
|
|
96
|
+
* ```typescript
|
|
97
|
+
* await client.v4User.deleteChildAccounts({
|
|
98
|
+
* childUserIds: ['child_001', 'child_002'],
|
|
99
|
+
* });
|
|
100
|
+
* ```
|
|
101
|
+
*/
|
|
102
|
+
deleteChildAccounts(params: DeleteChildAccountsParams): Promise<void>;
|
|
103
|
+
/**
|
|
104
|
+
* List child account roles
|
|
105
|
+
*
|
|
106
|
+
* @returns List of roles
|
|
107
|
+
*
|
|
108
|
+
* @example
|
|
109
|
+
* ```typescript
|
|
110
|
+
* const roles = await client.v4User.listChildAccountRoles();
|
|
111
|
+
* ```
|
|
112
|
+
*/
|
|
113
|
+
listChildAccountRoles(): Promise<ChildAccountRole[]>;
|
|
114
|
+
/**
|
|
115
|
+
* Get child account by sale
|
|
116
|
+
*
|
|
117
|
+
* @param params - Query parameters
|
|
118
|
+
* @returns Child account details
|
|
119
|
+
*
|
|
120
|
+
* @example
|
|
121
|
+
* ```typescript
|
|
122
|
+
* const account = await client.v4User.getBySale({ sale: '100' });
|
|
123
|
+
* ```
|
|
124
|
+
*/
|
|
125
|
+
getBySale(params: GetBySaleParams): Promise<ChildAccount>;
|
|
126
|
+
/**
|
|
127
|
+
* List organizations
|
|
128
|
+
*
|
|
129
|
+
* @returns List of organizations
|
|
130
|
+
*
|
|
131
|
+
* @example
|
|
132
|
+
* ```typescript
|
|
133
|
+
* const orgs = await client.v4User.listOrganizations();
|
|
134
|
+
* ```
|
|
135
|
+
*/
|
|
136
|
+
listOrganizations(): Promise<ListOrganizationsResponse>;
|
|
137
|
+
/**
|
|
138
|
+
* Create an organization
|
|
139
|
+
*
|
|
140
|
+
* @param params - Creation parameters
|
|
141
|
+
* @returns Created organization
|
|
142
|
+
*
|
|
143
|
+
* @example
|
|
144
|
+
* ```typescript
|
|
145
|
+
* const org = await client.v4User.createOrganization({
|
|
146
|
+
* organizationName: 'New Org',
|
|
147
|
+
* });
|
|
148
|
+
* ```
|
|
149
|
+
*/
|
|
150
|
+
createOrganization(params: CreateOrganizationParams): Promise<CreateOrganizationResponse>;
|
|
151
|
+
/**
|
|
152
|
+
* Delete an organization
|
|
153
|
+
*
|
|
154
|
+
* @param params - Delete parameters
|
|
155
|
+
*
|
|
156
|
+
* @example
|
|
157
|
+
* ```typescript
|
|
158
|
+
* await client.v4User.deleteOrganization({ organizationId: 1 });
|
|
159
|
+
* ```
|
|
160
|
+
*/
|
|
161
|
+
deleteOrganization(params: DeleteOrganizationParams): Promise<void>;
|
|
162
|
+
/**
|
|
163
|
+
* List viewer records with pagination
|
|
164
|
+
*
|
|
165
|
+
* @param params - Query parameters
|
|
166
|
+
* @returns Paginated viewer record list
|
|
167
|
+
*
|
|
168
|
+
* @example
|
|
169
|
+
* ```typescript
|
|
170
|
+
* const result = await client.v4User.listViewerRecords({
|
|
171
|
+
* pageNumber: 1,
|
|
172
|
+
* pageSize: 10,
|
|
173
|
+
* });
|
|
174
|
+
* ```
|
|
175
|
+
*/
|
|
176
|
+
listViewerRecords(params: ListViewerRecordsParams): Promise<ListViewerRecordsResponse>;
|
|
177
|
+
/**
|
|
178
|
+
* Get a viewer record by ID
|
|
179
|
+
*
|
|
180
|
+
* @param params - Query parameters
|
|
181
|
+
* @returns Viewer record details
|
|
182
|
+
*
|
|
183
|
+
* @example
|
|
184
|
+
* ```typescript
|
|
185
|
+
* const viewer = await client.v4User.getViewerRecord({
|
|
186
|
+
* viewerUnionId: 'viewer_001',
|
|
187
|
+
* });
|
|
188
|
+
* ```
|
|
189
|
+
*/
|
|
190
|
+
getViewerRecord(params: GetViewerRecordParams): Promise<ViewerRecord>;
|
|
191
|
+
/**
|
|
192
|
+
* Create a viewer record
|
|
193
|
+
*
|
|
194
|
+
* @param params - Creation parameters
|
|
195
|
+
* @returns Created viewer record
|
|
196
|
+
*
|
|
197
|
+
* @example
|
|
198
|
+
* ```typescript
|
|
199
|
+
* const viewer = await client.v4User.createViewerRecord({
|
|
200
|
+
* nickname: 'Test Viewer',
|
|
201
|
+
* mobile: '13800138000',
|
|
202
|
+
* });
|
|
203
|
+
* ```
|
|
204
|
+
*/
|
|
205
|
+
createViewerRecord(params: CreateViewerRecordParams): Promise<ViewerRecord>;
|
|
206
|
+
/**
|
|
207
|
+
* Update a viewer record
|
|
208
|
+
*
|
|
209
|
+
* @param params - Update parameters
|
|
210
|
+
*
|
|
211
|
+
* @example
|
|
212
|
+
* ```typescript
|
|
213
|
+
* await client.v4User.updateViewerRecord({
|
|
214
|
+
* viewerUnionId: 'viewer_001',
|
|
215
|
+
* nickname: 'Updated Name',
|
|
216
|
+
* });
|
|
217
|
+
* ```
|
|
218
|
+
*/
|
|
219
|
+
updateViewerRecord(params: UpdateViewerRecordParams): Promise<void>;
|
|
220
|
+
/**
|
|
221
|
+
* Delete a viewer record
|
|
222
|
+
*
|
|
223
|
+
* @param params - Delete parameters
|
|
224
|
+
*
|
|
225
|
+
* @example
|
|
226
|
+
* ```typescript
|
|
227
|
+
* await client.v4User.deleteViewerRecord({
|
|
228
|
+
* viewerUnionId: 'viewer_001',
|
|
229
|
+
* });
|
|
230
|
+
* ```
|
|
231
|
+
*/
|
|
232
|
+
deleteViewerRecord(params: DeleteViewerRecordParams): Promise<void>;
|
|
233
|
+
/**
|
|
234
|
+
* Direct auth viewer
|
|
235
|
+
*
|
|
236
|
+
* @param params - Auth parameters
|
|
237
|
+
*
|
|
238
|
+
* @example
|
|
239
|
+
* ```typescript
|
|
240
|
+
* await client.v4User.directAuthViewer({
|
|
241
|
+
* channelId: '123456',
|
|
242
|
+
* viewerId: 'viewer_001',
|
|
243
|
+
* nickname: 'Auth User',
|
|
244
|
+
* });
|
|
245
|
+
* ```
|
|
246
|
+
*/
|
|
247
|
+
directAuthViewer(params: DirectAuthViewerParams): Promise<void>;
|
|
248
|
+
/**
|
|
249
|
+
* Import external viewers
|
|
250
|
+
*
|
|
251
|
+
* @param params - Import parameters
|
|
252
|
+
*
|
|
253
|
+
* @example
|
|
254
|
+
* ```typescript
|
|
255
|
+
* await client.v4User.importExternalViewer({
|
|
256
|
+
* viewers: [
|
|
257
|
+
* { nickname: 'User 1', mobile: '13800138001' },
|
|
258
|
+
* ],
|
|
259
|
+
* });
|
|
260
|
+
* ```
|
|
261
|
+
*/
|
|
262
|
+
importExternalViewer(params: ImportExternalViewerParams): Promise<void>;
|
|
263
|
+
/**
|
|
264
|
+
* List viewer labels
|
|
265
|
+
*
|
|
266
|
+
* @returns List of viewer labels
|
|
267
|
+
*
|
|
268
|
+
* @example
|
|
269
|
+
* ```typescript
|
|
270
|
+
* const labels = await client.v4User.listViewerLabels();
|
|
271
|
+
* ```
|
|
272
|
+
*/
|
|
273
|
+
listViewerLabels(): Promise<ListViewerLabelsResponse>;
|
|
274
|
+
/**
|
|
275
|
+
* Create a viewer label
|
|
276
|
+
*
|
|
277
|
+
* @param params - Creation parameters
|
|
278
|
+
* @returns Created viewer label
|
|
279
|
+
*
|
|
280
|
+
* @example
|
|
281
|
+
* ```typescript
|
|
282
|
+
* const label = await client.v4User.createViewerLabel({
|
|
283
|
+
* labelName: 'VIP',
|
|
284
|
+
* });
|
|
285
|
+
* ```
|
|
286
|
+
*/
|
|
287
|
+
createViewerLabel(params: CreateViewerLabelParams): Promise<CreateViewerLabelResponse>;
|
|
288
|
+
/**
|
|
289
|
+
* Update a viewer label
|
|
290
|
+
*
|
|
291
|
+
* @param params - Update parameters
|
|
292
|
+
*
|
|
293
|
+
* @example
|
|
294
|
+
* ```typescript
|
|
295
|
+
* await client.v4User.updateViewerLabel({
|
|
296
|
+
* labelId: 1,
|
|
297
|
+
* labelName: 'Updated Label',
|
|
298
|
+
* });
|
|
299
|
+
* ```
|
|
300
|
+
*/
|
|
301
|
+
updateViewerLabel(params: UpdateViewerLabelParams): Promise<void>;
|
|
302
|
+
/**
|
|
303
|
+
* Delete a viewer label
|
|
304
|
+
*
|
|
305
|
+
* @param params - Delete parameters
|
|
306
|
+
*
|
|
307
|
+
* @example
|
|
308
|
+
* ```typescript
|
|
309
|
+
* await client.v4User.deleteViewerLabel({ labelId: 1 });
|
|
310
|
+
* ```
|
|
311
|
+
*/
|
|
312
|
+
deleteViewerLabel(params: DeleteViewerLabelParams): Promise<void>;
|
|
313
|
+
/**
|
|
314
|
+
* Add a label to a viewer
|
|
315
|
+
*
|
|
316
|
+
* @param params - Add parameters
|
|
317
|
+
*
|
|
318
|
+
* @example
|
|
319
|
+
* ```typescript
|
|
320
|
+
* await client.v4User.addViewerLabel({
|
|
321
|
+
* viewerUnionId: 'viewer_001',
|
|
322
|
+
* labelId: 1,
|
|
323
|
+
* });
|
|
324
|
+
* ```
|
|
325
|
+
*/
|
|
326
|
+
addViewerLabel(params: AddViewerLabelParams): Promise<void>;
|
|
327
|
+
/**
|
|
328
|
+
* Delete a label from a viewer
|
|
329
|
+
*
|
|
330
|
+
* @param params - Delete parameters
|
|
331
|
+
*
|
|
332
|
+
* @example
|
|
333
|
+
* ```typescript
|
|
334
|
+
* await client.v4User.deleteViewerLabelRef({
|
|
335
|
+
* viewerUnionId: 'viewer_001',
|
|
336
|
+
* labelId: 1,
|
|
337
|
+
* });
|
|
338
|
+
* ```
|
|
339
|
+
*/
|
|
340
|
+
deleteViewerLabelRef(params: DeleteViewerLabelRefParams): Promise<void>;
|
|
341
|
+
/**
|
|
342
|
+
* List products with pagination
|
|
343
|
+
*
|
|
344
|
+
* @param params - Query parameters
|
|
345
|
+
* @returns Paginated product list
|
|
346
|
+
*
|
|
347
|
+
* @example
|
|
348
|
+
* ```typescript
|
|
349
|
+
* const result = await client.v4User.listProducts({
|
|
350
|
+
* pageNumber: 1,
|
|
351
|
+
* pageSize: 10,
|
|
352
|
+
* });
|
|
353
|
+
* ```
|
|
354
|
+
*/
|
|
355
|
+
listProducts(params: ListProductsParams): Promise<ListProductsResponse>;
|
|
356
|
+
/**
|
|
357
|
+
* Create a product
|
|
358
|
+
*
|
|
359
|
+
* @param params - Creation parameters
|
|
360
|
+
* @returns Created product
|
|
361
|
+
*
|
|
362
|
+
* @example
|
|
363
|
+
* ```typescript
|
|
364
|
+
* const product = await client.v4User.createProduct({
|
|
365
|
+
* name: 'New Product',
|
|
366
|
+
* linkType: 10,
|
|
367
|
+
* link: 'https://example.com/product',
|
|
368
|
+
* });
|
|
369
|
+
* ```
|
|
370
|
+
*/
|
|
371
|
+
createProduct(params: CreateProductParams): Promise<CreateProductResponse>;
|
|
372
|
+
/**
|
|
373
|
+
* Update a product
|
|
374
|
+
*
|
|
375
|
+
* @param params - Update parameters
|
|
376
|
+
*
|
|
377
|
+
* @example
|
|
378
|
+
* ```typescript
|
|
379
|
+
* await client.v4User.updateProduct({
|
|
380
|
+
* productId: 'prod_001',
|
|
381
|
+
* name: 'Updated Product',
|
|
382
|
+
* });
|
|
383
|
+
* ```
|
|
384
|
+
*/
|
|
385
|
+
updateProduct(params: UpdateProductParams): Promise<void>;
|
|
386
|
+
/**
|
|
387
|
+
* Delete a product
|
|
388
|
+
*
|
|
389
|
+
* @param params - Delete parameters
|
|
390
|
+
*
|
|
391
|
+
* @example
|
|
392
|
+
* ```typescript
|
|
393
|
+
* await client.v4User.deleteProduct({ productId: 'prod_001' });
|
|
394
|
+
* ```
|
|
395
|
+
*/
|
|
396
|
+
deleteProduct(params: DeleteProductParams): Promise<void>;
|
|
397
|
+
/**
|
|
398
|
+
* List product tags
|
|
399
|
+
*
|
|
400
|
+
* @returns List of product tags
|
|
401
|
+
*
|
|
402
|
+
* @example
|
|
403
|
+
* ```typescript
|
|
404
|
+
* const tags = await client.v4User.listProductTags();
|
|
405
|
+
* ```
|
|
406
|
+
*/
|
|
407
|
+
listProductTags(): Promise<ListProductTagsResponse>;
|
|
408
|
+
/**
|
|
409
|
+
* Create a product tag
|
|
410
|
+
*
|
|
411
|
+
* @param params - Creation parameters
|
|
412
|
+
* @returns Created product tag
|
|
413
|
+
*
|
|
414
|
+
* @example
|
|
415
|
+
* ```typescript
|
|
416
|
+
* const tag = await client.v4User.createProductTag({
|
|
417
|
+
* tagName: 'Hot',
|
|
418
|
+
* });
|
|
419
|
+
* ```
|
|
420
|
+
*/
|
|
421
|
+
createProductTag(params: CreateProductTagParams): Promise<CreateProductTagResponse>;
|
|
422
|
+
/**
|
|
423
|
+
* Update a product tag
|
|
424
|
+
*
|
|
425
|
+
* @param params - Update parameters
|
|
426
|
+
*
|
|
427
|
+
* @example
|
|
428
|
+
* ```typescript
|
|
429
|
+
* await client.v4User.updateProductTag({
|
|
430
|
+
* tagId: 1,
|
|
431
|
+
* tagName: 'Updated Tag',
|
|
432
|
+
* });
|
|
433
|
+
* ```
|
|
434
|
+
*/
|
|
435
|
+
updateProductTag(params: UpdateProductTagParams): Promise<void>;
|
|
436
|
+
/**
|
|
437
|
+
* Delete a product tag
|
|
438
|
+
*
|
|
439
|
+
* @param params - Delete parameters
|
|
440
|
+
*
|
|
441
|
+
* @example
|
|
442
|
+
* ```typescript
|
|
443
|
+
* await client.v4User.deleteProductTag({ tagId: 1 });
|
|
444
|
+
* ```
|
|
445
|
+
*/
|
|
446
|
+
deleteProductTag(params: DeleteProductTagParams): Promise<void>;
|
|
447
|
+
/**
|
|
448
|
+
* List product orders with pagination
|
|
449
|
+
*
|
|
450
|
+
* @param params - Query parameters
|
|
451
|
+
* @returns Paginated product order list
|
|
452
|
+
*
|
|
453
|
+
* @example
|
|
454
|
+
* ```typescript
|
|
455
|
+
* const result = await client.v4User.listProductOrders({
|
|
456
|
+
* pageNumber: 1,
|
|
457
|
+
* pageSize: 10,
|
|
458
|
+
* });
|
|
459
|
+
* ```
|
|
460
|
+
*/
|
|
461
|
+
listProductOrders(params: ListProductOrdersParams): Promise<ListProductOrdersResponse>;
|
|
462
|
+
/**
|
|
463
|
+
* Get a product order by ID
|
|
464
|
+
*
|
|
465
|
+
* @param params - Query parameters
|
|
466
|
+
* @returns Product order details
|
|
467
|
+
*
|
|
468
|
+
* @example
|
|
469
|
+
* ```typescript
|
|
470
|
+
* const order = await client.v4User.getProductOrder({
|
|
471
|
+
* orderId: 'order_001',
|
|
472
|
+
* });
|
|
473
|
+
* ```
|
|
474
|
+
*/
|
|
475
|
+
getProductOrder(params: GetProductOrderParams): Promise<ProductOrder>;
|
|
476
|
+
/**
|
|
477
|
+
* Batch update order status
|
|
478
|
+
*
|
|
479
|
+
* @param params - Update parameters
|
|
480
|
+
*
|
|
481
|
+
* @example
|
|
482
|
+
* ```typescript
|
|
483
|
+
* await client.v4User.batchUpdateOrderStatus({
|
|
484
|
+
* orderIds: ['order_001', 'order_002'],
|
|
485
|
+
* status: 'completed',
|
|
486
|
+
* });
|
|
487
|
+
* ```
|
|
488
|
+
*/
|
|
489
|
+
batchUpdateOrderStatus(params: BatchUpdateOrderStatusParams): Promise<void>;
|
|
490
|
+
/**
|
|
491
|
+
* List labels
|
|
492
|
+
*
|
|
493
|
+
* @returns List of labels
|
|
494
|
+
*
|
|
495
|
+
* @example
|
|
496
|
+
* ```typescript
|
|
497
|
+
* const labels = await client.v4User.listLabels();
|
|
498
|
+
* ```
|
|
499
|
+
*/
|
|
500
|
+
listLabels(): Promise<ListLabelsResponse>;
|
|
501
|
+
/**
|
|
502
|
+
* Create a label
|
|
503
|
+
*
|
|
504
|
+
* @param params - Creation parameters
|
|
505
|
+
* @returns Created label
|
|
506
|
+
*
|
|
507
|
+
* @example
|
|
508
|
+
* ```typescript
|
|
509
|
+
* const label = await client.v4User.createLabel({
|
|
510
|
+
* labelName: 'Tech',
|
|
511
|
+
* });
|
|
512
|
+
* ```
|
|
513
|
+
*/
|
|
514
|
+
createLabel(params: CreateLabelParams): Promise<CreateLabelResponse>;
|
|
515
|
+
/**
|
|
516
|
+
* Update a label
|
|
517
|
+
*
|
|
518
|
+
* @param params - Update parameters
|
|
519
|
+
*
|
|
520
|
+
* @example
|
|
521
|
+
* ```typescript
|
|
522
|
+
* await client.v4User.updateLabel({
|
|
523
|
+
* labelId: 1,
|
|
524
|
+
* labelName: 'Updated Label',
|
|
525
|
+
* });
|
|
526
|
+
* ```
|
|
527
|
+
*/
|
|
528
|
+
updateLabel(params: UpdateLabelParams): Promise<void>;
|
|
529
|
+
/**
|
|
530
|
+
* Delete a label
|
|
531
|
+
*
|
|
532
|
+
* @param params - Delete parameters
|
|
533
|
+
*
|
|
534
|
+
* @example
|
|
535
|
+
* ```typescript
|
|
536
|
+
* await client.v4User.deleteLabel({ labelId: 1 });
|
|
537
|
+
* ```
|
|
538
|
+
*/
|
|
539
|
+
deleteLabel(params: DeleteLabelParams): Promise<void>;
|
|
540
|
+
/**
|
|
541
|
+
* Add channel label refs
|
|
542
|
+
*
|
|
543
|
+
* @param params - Add parameters
|
|
544
|
+
*
|
|
545
|
+
* @example
|
|
546
|
+
* ```typescript
|
|
547
|
+
* await client.v4User.addChannelLabelRefs({
|
|
548
|
+
* labelId: 1,
|
|
549
|
+
* channelIds: ['123456', '789012'],
|
|
550
|
+
* });
|
|
551
|
+
* ```
|
|
552
|
+
*/
|
|
553
|
+
addChannelLabelRefs(params: AddChannelLabelRefsParams): Promise<void>;
|
|
554
|
+
/**
|
|
555
|
+
* List invite sales
|
|
556
|
+
*
|
|
557
|
+
* @returns List of invite sales
|
|
558
|
+
*
|
|
559
|
+
* @example
|
|
560
|
+
* ```typescript
|
|
561
|
+
* const sales = await client.v4User.listInviteSales();
|
|
562
|
+
* ```
|
|
563
|
+
*/
|
|
564
|
+
listInviteSales(): Promise<ListInviteSalesResponse>;
|
|
565
|
+
/**
|
|
566
|
+
* Add an invite sale
|
|
567
|
+
*
|
|
568
|
+
* @param params - Add parameters
|
|
569
|
+
* @returns Created invite sale
|
|
570
|
+
*
|
|
571
|
+
* @example
|
|
572
|
+
* ```typescript
|
|
573
|
+
* const sale = await client.v4User.addInviteSale({
|
|
574
|
+
* nickname: 'New Sales',
|
|
575
|
+
* });
|
|
576
|
+
* ```
|
|
577
|
+
*/
|
|
578
|
+
addInviteSale(params: AddInviteSaleParams): Promise<AddInviteSaleResponse>;
|
|
579
|
+
/**
|
|
580
|
+
* Update an invite sale
|
|
581
|
+
*
|
|
582
|
+
* @param params - Update parameters
|
|
583
|
+
*
|
|
584
|
+
* @example
|
|
585
|
+
* ```typescript
|
|
586
|
+
* await client.v4User.updateInviteSale({
|
|
587
|
+
* inviteId: 1,
|
|
588
|
+
* nickname: 'Updated Sales',
|
|
589
|
+
* });
|
|
590
|
+
* ```
|
|
591
|
+
*/
|
|
592
|
+
updateInviteSale(params: UpdateInviteSaleParams): Promise<void>;
|
|
593
|
+
/**
|
|
594
|
+
* Remove an invite sale
|
|
595
|
+
*
|
|
596
|
+
* @param params - Remove parameters
|
|
597
|
+
*
|
|
598
|
+
* @example
|
|
599
|
+
* ```typescript
|
|
600
|
+
* await client.v4User.removeInviteSale({ inviteId: 1 });
|
|
601
|
+
* ```
|
|
602
|
+
*/
|
|
603
|
+
removeInviteSale(params: RemoveInviteSaleParams): Promise<void>;
|
|
604
|
+
/**
|
|
605
|
+
* List follow viewers
|
|
606
|
+
*
|
|
607
|
+
* @param params - Query parameters
|
|
608
|
+
* @returns List of follow viewers
|
|
609
|
+
*
|
|
610
|
+
* @example
|
|
611
|
+
* ```typescript
|
|
612
|
+
* const viewers = await client.v4User.listFollowViewers({ inviteId: 1 });
|
|
613
|
+
* ```
|
|
614
|
+
*/
|
|
615
|
+
listFollowViewers(params: ListFollowViewersParams): Promise<ListFollowViewersResponse>;
|
|
616
|
+
/**
|
|
617
|
+
* List custom fields
|
|
618
|
+
*
|
|
619
|
+
* @returns List of custom fields
|
|
620
|
+
*
|
|
621
|
+
* @example
|
|
622
|
+
* ```typescript
|
|
623
|
+
* const fields = await client.v4User.listCustomFields();
|
|
624
|
+
* ```
|
|
625
|
+
*/
|
|
626
|
+
listCustomFields(): Promise<ListCustomFieldsResponse>;
|
|
627
|
+
/**
|
|
628
|
+
* Add a custom field
|
|
629
|
+
*
|
|
630
|
+
* @param params - Add parameters
|
|
631
|
+
* @returns Created custom field
|
|
632
|
+
*
|
|
633
|
+
* @example
|
|
634
|
+
* ```typescript
|
|
635
|
+
* const field = await client.v4User.addCustomField({
|
|
636
|
+
* fieldName: 'Company',
|
|
637
|
+
* fieldType: 'text',
|
|
638
|
+
* });
|
|
639
|
+
* ```
|
|
640
|
+
*/
|
|
641
|
+
addCustomField(params: AddCustomFieldParams): Promise<AddCustomFieldResponse>;
|
|
642
|
+
/**
|
|
643
|
+
* Add a custom field value
|
|
644
|
+
*
|
|
645
|
+
* @param params - Add parameters
|
|
646
|
+
*
|
|
647
|
+
* @example
|
|
648
|
+
* ```typescript
|
|
649
|
+
* await client.v4User.addCustomFieldValue({
|
|
650
|
+
* fieldId: 1,
|
|
651
|
+
* viewerUnionId: 'viewer_001',
|
|
652
|
+
* value: 'Tech Corp',
|
|
653
|
+
* });
|
|
654
|
+
* ```
|
|
655
|
+
*/
|
|
656
|
+
addCustomFieldValue(params: AddCustomFieldValueParams): Promise<void>;
|
|
657
|
+
/**
|
|
658
|
+
* Get donate template settings
|
|
659
|
+
*
|
|
660
|
+
* @returns Donate template settings
|
|
661
|
+
*
|
|
662
|
+
* @example
|
|
663
|
+
* ```typescript
|
|
664
|
+
* const template = await client.v4User.getDonateTemplate();
|
|
665
|
+
* ```
|
|
666
|
+
*/
|
|
667
|
+
getDonateTemplate(): Promise<DonateTemplate>;
|
|
668
|
+
/**
|
|
669
|
+
* Update donate template settings
|
|
670
|
+
*
|
|
671
|
+
* @param params - Update parameters
|
|
672
|
+
*
|
|
673
|
+
* @example
|
|
674
|
+
* ```typescript
|
|
675
|
+
* await client.v4User.updateDonateTemplate({
|
|
676
|
+
* enabled: true,
|
|
677
|
+
* minAmount: 1,
|
|
678
|
+
* maxAmount: 10000,
|
|
679
|
+
* });
|
|
680
|
+
* ```
|
|
681
|
+
*/
|
|
682
|
+
updateDonateTemplate(params: UpdateDonateTemplateParams): Promise<void>;
|
|
683
|
+
/**
|
|
684
|
+
* Get marquee template settings
|
|
685
|
+
*
|
|
686
|
+
* @returns Marquee template settings
|
|
687
|
+
*
|
|
688
|
+
* @example
|
|
689
|
+
* ```typescript
|
|
690
|
+
* const template = await client.v4User.getMarqueeTemplate();
|
|
691
|
+
* ```
|
|
692
|
+
*/
|
|
693
|
+
getMarqueeTemplate(): Promise<MarqueeTemplate>;
|
|
694
|
+
/**
|
|
695
|
+
* Update marquee template settings
|
|
696
|
+
*
|
|
697
|
+
* @param params - Update parameters
|
|
698
|
+
*
|
|
699
|
+
* @example
|
|
700
|
+
* ```typescript
|
|
701
|
+
* await client.v4User.updateMarqueeTemplate({
|
|
702
|
+
* enabled: true,
|
|
703
|
+
* content: 'New message',
|
|
704
|
+
* });
|
|
705
|
+
* ```
|
|
706
|
+
*/
|
|
707
|
+
updateMarqueeTemplate(params: UpdateMarqueeTemplateParams): Promise<void>;
|
|
708
|
+
/**
|
|
709
|
+
* Get role config template settings
|
|
710
|
+
*
|
|
711
|
+
* @returns Role config template settings
|
|
712
|
+
*
|
|
713
|
+
* @example
|
|
714
|
+
* ```typescript
|
|
715
|
+
* const config = await client.v4User.getRoleConfigTemplate();
|
|
716
|
+
* ```
|
|
717
|
+
*/
|
|
718
|
+
getRoleConfigTemplate(): Promise<RoleConfigTemplate>;
|
|
719
|
+
/**
|
|
720
|
+
* Update role config template settings
|
|
721
|
+
*
|
|
722
|
+
* @param params - Update parameters
|
|
723
|
+
*
|
|
724
|
+
* @example
|
|
725
|
+
* ```typescript
|
|
726
|
+
* await client.v4User.updateRoleConfigTemplate({
|
|
727
|
+
* roles: ['admin', 'moderator'],
|
|
728
|
+
* });
|
|
729
|
+
* ```
|
|
730
|
+
*/
|
|
731
|
+
updateRoleConfigTemplate(params: UpdateRoleConfigTemplateParams): Promise<void>;
|
|
732
|
+
/**
|
|
733
|
+
* Get playback setting
|
|
734
|
+
*
|
|
735
|
+
* @returns Playback setting
|
|
736
|
+
*
|
|
737
|
+
* @example
|
|
738
|
+
* ```typescript
|
|
739
|
+
* const setting = await client.v4User.getPlaybackSetting();
|
|
740
|
+
* ```
|
|
741
|
+
*/
|
|
742
|
+
getPlaybackSetting(): Promise<PlaybackSetting>;
|
|
743
|
+
/**
|
|
744
|
+
* Update playback setting
|
|
745
|
+
*
|
|
746
|
+
* @param params - Update parameters
|
|
747
|
+
*
|
|
748
|
+
* @example
|
|
749
|
+
* ```typescript
|
|
750
|
+
* await client.v4User.updatePlaybackSetting({
|
|
751
|
+
* autoPlay: false,
|
|
752
|
+
* quality: 'medium',
|
|
753
|
+
* });
|
|
754
|
+
* ```
|
|
755
|
+
*/
|
|
756
|
+
updatePlaybackSetting(params: UpdatePlaybackSettingParams): Promise<void>;
|
|
757
|
+
/**
|
|
758
|
+
* Get audio moderation setting
|
|
759
|
+
*
|
|
760
|
+
* @returns Audio moderation setting
|
|
761
|
+
*
|
|
762
|
+
* @example
|
|
763
|
+
* ```typescript
|
|
764
|
+
* const setting = await client.v4User.getAudioModerationSetting();
|
|
765
|
+
* ```
|
|
766
|
+
*/
|
|
767
|
+
getAudioModerationSetting(): Promise<AudioModerationSetting>;
|
|
768
|
+
/**
|
|
769
|
+
* Update audio moderation setting
|
|
770
|
+
*
|
|
771
|
+
* @param params - Update parameters
|
|
772
|
+
*
|
|
773
|
+
* @example
|
|
774
|
+
* ```typescript
|
|
775
|
+
* await client.v4User.updateAudioModerationSetting({
|
|
776
|
+
* enabled: true,
|
|
777
|
+
* level: 'moderate',
|
|
778
|
+
* });
|
|
779
|
+
* ```
|
|
780
|
+
*/
|
|
781
|
+
updateAudioModerationSetting(params: UpdateAudioModerationSettingParams): Promise<void>;
|
|
782
|
+
/**
|
|
783
|
+
* Get video moderation setting
|
|
784
|
+
*
|
|
785
|
+
* @returns Video moderation setting
|
|
786
|
+
*
|
|
787
|
+
* @example
|
|
788
|
+
* ```typescript
|
|
789
|
+
* const setting = await client.v4User.getVideoModerationSetting();
|
|
790
|
+
* ```
|
|
791
|
+
*/
|
|
792
|
+
getVideoModerationSetting(): Promise<VideoModerationSetting>;
|
|
793
|
+
/**
|
|
794
|
+
* Update video moderation setting
|
|
795
|
+
*
|
|
796
|
+
* @param params - Update parameters
|
|
797
|
+
*
|
|
798
|
+
* @example
|
|
799
|
+
* ```typescript
|
|
800
|
+
* await client.v4User.updateVideoModerationSetting({
|
|
801
|
+
* enabled: true,
|
|
802
|
+
* level: 'moderate',
|
|
803
|
+
* });
|
|
804
|
+
* ```
|
|
805
|
+
*/
|
|
806
|
+
updateVideoModerationSetting(params: UpdateVideoModerationSettingParams): Promise<void>;
|
|
807
|
+
/**
|
|
808
|
+
* Get callback settings
|
|
809
|
+
*
|
|
810
|
+
* @returns Callback settings
|
|
811
|
+
*
|
|
812
|
+
* @example
|
|
813
|
+
* ```typescript
|
|
814
|
+
* const callback = await client.v4User.getCallback();
|
|
815
|
+
* ```
|
|
816
|
+
*/
|
|
817
|
+
getCallback(): Promise<CallbackSettings>;
|
|
818
|
+
/**
|
|
819
|
+
* Update callback settings
|
|
820
|
+
*
|
|
821
|
+
* @param params - Update parameters
|
|
822
|
+
*
|
|
823
|
+
* @example
|
|
824
|
+
* ```typescript
|
|
825
|
+
* await client.v4User.updateCallback({
|
|
826
|
+
* url: 'https://example.com/new-callback',
|
|
827
|
+
* enabled: true,
|
|
828
|
+
* });
|
|
829
|
+
* ```
|
|
830
|
+
*/
|
|
831
|
+
updateCallback(params: UpdateCallbackParams): Promise<void>;
|
|
832
|
+
/**
|
|
833
|
+
* Get global switch settings
|
|
834
|
+
*
|
|
835
|
+
* @returns Global switch settings
|
|
836
|
+
*
|
|
837
|
+
* @example
|
|
838
|
+
* ```typescript
|
|
839
|
+
* const switches = await client.v4User.getGlobalSwitch();
|
|
840
|
+
* ```
|
|
841
|
+
*/
|
|
842
|
+
getGlobalSwitch(): Promise<GlobalSwitchSettings>;
|
|
843
|
+
/**
|
|
844
|
+
* Update global switch settings
|
|
845
|
+
*
|
|
846
|
+
* @param params - Update parameters
|
|
847
|
+
*
|
|
848
|
+
* @example
|
|
849
|
+
* ```typescript
|
|
850
|
+
* await client.v4User.updateGlobalSwitch({
|
|
851
|
+
* chatEnabled: false,
|
|
852
|
+
* danmuEnabled: true,
|
|
853
|
+
* });
|
|
854
|
+
* ```
|
|
855
|
+
*/
|
|
856
|
+
updateGlobalSwitch(params: UpdateGlobalSwitchParams): Promise<void>;
|
|
857
|
+
/**
|
|
858
|
+
* Get global footer settings
|
|
859
|
+
*
|
|
860
|
+
* @returns Global footer settings
|
|
861
|
+
*
|
|
862
|
+
* @example
|
|
863
|
+
* ```typescript
|
|
864
|
+
* const footer = await client.v4User.getGlobalFooter();
|
|
865
|
+
* ```
|
|
866
|
+
*/
|
|
867
|
+
getGlobalFooter(): Promise<GlobalFooterSettings>;
|
|
868
|
+
/**
|
|
869
|
+
* Update global footer settings
|
|
870
|
+
*
|
|
871
|
+
* @param params - Update parameters
|
|
872
|
+
*
|
|
873
|
+
* @example
|
|
874
|
+
* ```typescript
|
|
875
|
+
* await client.v4User.updateGlobalFooter({
|
|
876
|
+
* enabled: true,
|
|
877
|
+
* content: 'New footer text',
|
|
878
|
+
* });
|
|
879
|
+
* ```
|
|
880
|
+
*/
|
|
881
|
+
updateGlobalFooter(params: UpdateGlobalFooterParams): Promise<void>;
|
|
882
|
+
/**
|
|
883
|
+
* Get PV show enable settings
|
|
884
|
+
*
|
|
885
|
+
* @returns PV show enable settings
|
|
886
|
+
*
|
|
887
|
+
* @example
|
|
888
|
+
* ```typescript
|
|
889
|
+
* const pvShow = await client.v4User.getPvShowEnable();
|
|
890
|
+
* ```
|
|
891
|
+
*/
|
|
892
|
+
getPvShowEnable(): Promise<PvShowEnableSettings>;
|
|
893
|
+
/**
|
|
894
|
+
* Update PV show enable settings
|
|
895
|
+
*
|
|
896
|
+
* @param params - Update parameters
|
|
897
|
+
*
|
|
898
|
+
* @example
|
|
899
|
+
* ```typescript
|
|
900
|
+
* await client.v4User.updatePvShowEnable({ enabled: false });
|
|
901
|
+
* ```
|
|
902
|
+
*/
|
|
903
|
+
updatePvShowEnable(params: UpdatePvShowEnableParams): Promise<void>;
|
|
904
|
+
/**
|
|
905
|
+
* Get mic duration
|
|
906
|
+
*
|
|
907
|
+
* @param params - Query parameters
|
|
908
|
+
* @returns Mic duration info
|
|
909
|
+
*
|
|
910
|
+
* @example
|
|
911
|
+
* ```typescript
|
|
912
|
+
* const duration = await client.v4User.getMicDuration({
|
|
913
|
+
* channelId: '123456',
|
|
914
|
+
* sessionId: 'session_001',
|
|
915
|
+
* });
|
|
916
|
+
* ```
|
|
917
|
+
*/
|
|
918
|
+
getMicDuration(params: GetMicDurationParams): Promise<MicDurationResponse>;
|
|
919
|
+
/**
|
|
920
|
+
* Get MR concurrency detail
|
|
921
|
+
*
|
|
922
|
+
* @returns MR concurrency detail
|
|
923
|
+
*
|
|
924
|
+
* @example
|
|
925
|
+
* ```typescript
|
|
926
|
+
* const detail = await client.v4User.getMrConcurrencyDetail();
|
|
927
|
+
* ```
|
|
928
|
+
*/
|
|
929
|
+
getMrConcurrencyDetail(): Promise<MrConcurrencyDetailResponse>;
|
|
930
|
+
/**
|
|
931
|
+
* Send SMS
|
|
932
|
+
*
|
|
933
|
+
* @param params - SMS parameters
|
|
934
|
+
*
|
|
935
|
+
* @example
|
|
936
|
+
* ```typescript
|
|
937
|
+
* await client.v4User.sendSms({
|
|
938
|
+
* mobile: '13800138000',
|
|
939
|
+
* content: 'Your verification code is 123456',
|
|
940
|
+
* });
|
|
941
|
+
* ```
|
|
942
|
+
*/
|
|
943
|
+
sendSms(params: SendSmsParams): Promise<void>;
|
|
944
|
+
/**
|
|
945
|
+
* Get bill use detail list
|
|
946
|
+
*
|
|
947
|
+
* @param params - Query parameters
|
|
948
|
+
* @returns Bill use detail list
|
|
949
|
+
*
|
|
950
|
+
* @example
|
|
951
|
+
* ```typescript
|
|
952
|
+
* const bills = await client.v4User.getBillUseDetailList({
|
|
953
|
+
* startDate: '2024-01-01',
|
|
954
|
+
* endDate: '2024-01-31',
|
|
955
|
+
* });
|
|
956
|
+
* ```
|
|
957
|
+
*/
|
|
958
|
+
getBillUseDetailList(params: GetBillUseDetailListParams): Promise<GetBillUseDetailListResponse>;
|
|
959
|
+
/**
|
|
960
|
+
* Get viewer lottery win info
|
|
961
|
+
*
|
|
962
|
+
* @param params - Query parameters
|
|
963
|
+
* @returns Viewer lottery win info
|
|
964
|
+
*
|
|
965
|
+
* @example
|
|
966
|
+
* ```typescript
|
|
967
|
+
* const win = await client.v4User.viewerLotteryWin({
|
|
968
|
+
* lotteryId: 1,
|
|
969
|
+
* viewerId: 'viewer_001',
|
|
970
|
+
* });
|
|
971
|
+
* ```
|
|
972
|
+
*/
|
|
973
|
+
viewerLotteryWin(params: ViewerLotteryWinParams): Promise<ViewerLotteryWinResponse>;
|
|
974
|
+
/**
|
|
975
|
+
* Get watch log detail
|
|
976
|
+
*
|
|
977
|
+
* @param params - Query parameters
|
|
978
|
+
* @returns Watch log detail
|
|
979
|
+
*
|
|
980
|
+
* @example
|
|
981
|
+
* ```typescript
|
|
982
|
+
* const log = await client.v4User.getWatchLogDetail({ logId: 1 });
|
|
983
|
+
* ```
|
|
984
|
+
*/
|
|
985
|
+
getWatchLogDetail(params: GetWatchLogDetailParams): Promise<WatchLogDetailResponse>;
|
|
986
|
+
/**
|
|
987
|
+
* Get watch log list with pagination
|
|
988
|
+
*
|
|
989
|
+
* @param params - Query parameters
|
|
990
|
+
* @returns Paginated watch log list
|
|
991
|
+
*
|
|
992
|
+
* @example
|
|
993
|
+
* ```typescript
|
|
994
|
+
* const logs = await client.v4User.getWatchLogList({
|
|
995
|
+
* pageNumber: 1,
|
|
996
|
+
* pageSize: 10,
|
|
997
|
+
* });
|
|
998
|
+
* ```
|
|
999
|
+
*/
|
|
1000
|
+
getWatchLogList(params: GetWatchLogListParams): Promise<GetWatchLogListResponse>;
|
|
1001
|
+
/**
|
|
1002
|
+
* Validate pagination parameters
|
|
1003
|
+
*/
|
|
1004
|
+
private validatePaginationParams;
|
|
1005
|
+
/**
|
|
1006
|
+
* Validate required string parameter
|
|
1007
|
+
*/
|
|
1008
|
+
private validateRequiredString;
|
|
1009
|
+
/**
|
|
1010
|
+
* Validate required number parameter
|
|
1011
|
+
*/
|
|
1012
|
+
private validateRequiredNumber;
|
|
1013
|
+
}
|
|
1014
|
+
//# sourceMappingURL=user.service.d.ts.map
|