mezon-js 2.7.1

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.
@@ -0,0 +1,735 @@
1
+ /** A single user-role pair. */
2
+ export interface ChannelUserListChannelUser {
3
+ id?: string;
4
+ role_id?: string;
5
+ thread_id?: string;
6
+ user?: ApiUser;
7
+ }
8
+ /** A single user-role pair. */
9
+ export interface ClanUserListClanUser {
10
+ role_id?: string;
11
+ user?: ApiUser;
12
+ }
13
+ /** A single user-role pair. */
14
+ export interface RoleUserListRoleUser {
15
+ avatar_url?: string;
16
+ display_name?: string;
17
+ id?: string;
18
+ lang_tag?: string;
19
+ location?: string;
20
+ online?: boolean;
21
+ username?: string;
22
+ }
23
+ /** A user with additional account details. Always the current user. */
24
+ export interface ApiAccount {
25
+ custom_id?: string;
26
+ devices?: Array<ApiAccountDevice>;
27
+ disable_time?: string;
28
+ email?: string;
29
+ user?: ApiUser;
30
+ verify_time?: string;
31
+ wallet?: string;
32
+ }
33
+ /** Send a Apple Sign In token to the server. Used with authenticate/link/unlink. */
34
+ export interface ApiAccountApple {
35
+ token?: string;
36
+ vars?: Record<string, string>;
37
+ }
38
+ /** Send a custom ID to the server. Used with authenticate/link/unlink. */
39
+ export interface ApiAccountCustom {
40
+ id?: string;
41
+ vars?: Record<string, string>;
42
+ }
43
+ /** Send a device to the server. Used with authenticate/link/unlink and user. */
44
+ export interface ApiAccountDevice {
45
+ id?: string;
46
+ vars?: Record<string, string>;
47
+ }
48
+ /** Send an email with password to the server. Used with authenticate/link/unlink. */
49
+ export interface ApiAccountEmail {
50
+ email?: string;
51
+ password?: string;
52
+ vars?: Record<string, string>;
53
+ }
54
+ /** Send a Facebook token to the server. Used with authenticate/link/unlink. */
55
+ export interface ApiAccountFacebook {
56
+ token?: string;
57
+ vars?: Record<string, string>;
58
+ }
59
+ /** Send a Facebook Instant Game token to the server. Used with authenticate/link/unlink. */
60
+ export interface ApiAccountFacebookInstantGame {
61
+ signed_player_info?: string;
62
+ vars?: Record<string, string>;
63
+ }
64
+ /** Send Apple's Game Center account credentials to the server. Used with authenticate/link/unlink.
65
+
66
+ https://developer.apple.com/documentation/gamekit/gklocalplayer/1515407-generateidentityverificationsign */
67
+ export interface ApiAccountGameCenter {
68
+ bundle_id?: string;
69
+ player_id?: string;
70
+ public_key_url?: string;
71
+ salt?: string;
72
+ signature?: string;
73
+ timestamp_seconds?: string;
74
+ vars?: Record<string, string>;
75
+ }
76
+ /** Send a Google token to the server. Used with authenticate/link/unlink. */
77
+ export interface ApiAccountGoogle {
78
+ token?: string;
79
+ vars?: Record<string, string>;
80
+ }
81
+ /** Send a Steam token to the server. Used with authenticate/link/unlink. */
82
+ export interface ApiAccountSteam {
83
+ token?: string;
84
+ vars?: Record<string, string>;
85
+ }
86
+ /** Add a role for channel. */
87
+ export interface ApiAddRoleChannelDescRequest {
88
+ channel_id?: string;
89
+ role_ids?: Array<string>;
90
+ }
91
+ /** */
92
+ export interface ApiCategoryDesc {
93
+ category_id?: string;
94
+ category_name?: string;
95
+ clan_id?: string;
96
+ creator_id?: string;
97
+ }
98
+ /** */
99
+ export interface ApiCategoryDescList {
100
+ categorydesc?: Array<ApiCategoryDesc>;
101
+ }
102
+ /** A list of channel description, usually a result of a list operation. */
103
+ export interface ApiChannelDescList {
104
+ cacheable_cursor?: string;
105
+ channeldesc?: Array<ApiChannelDescription>;
106
+ next_cursor?: string;
107
+ prev_cursor?: string;
108
+ }
109
+ /** */
110
+ export interface ApiChannelDescription {
111
+ category_id?: string;
112
+ category_name?: string;
113
+ channel_avatar?: string;
114
+ channel_id?: string;
115
+ channel_label?: string;
116
+ channel_private?: number;
117
+ clan_id?: string;
118
+ creator_id?: string;
119
+ last_seen_message?: ApiChannelMessageHeader;
120
+ last_sent_message?: ApiChannelMessageHeader;
121
+ parrent_id?: string;
122
+ type?: number;
123
+ user_id?: string;
124
+ }
125
+ /** A message sent on a channel. */
126
+ export interface ApiChannelMessage {
127
+ attachments?: string;
128
+ avatar?: string;
129
+ channel_id: string;
130
+ channel_label: string;
131
+ clan_id?: string;
132
+ code: number;
133
+ content: string;
134
+ create_time?: string;
135
+ mentions?: string;
136
+ message_id: string;
137
+ reactions?: string;
138
+ referenced_message?: string;
139
+ references?: string;
140
+ sender_id: string;
141
+ update_time?: string;
142
+ user_id_one?: string;
143
+ user_id_two?: string;
144
+ username?: string;
145
+ }
146
+ /** */
147
+ export interface ApiChannelMessageHeader {
148
+ id?: string;
149
+ timestamp?: string;
150
+ sender_id: string;
151
+ content: string;
152
+ }
153
+ /** A list of channel messages, usually a result of a list operation. */
154
+ export interface ApiChannelMessageList {
155
+ last_seen_message?: ApiChannelMessageHeader;
156
+ messages?: Array<ApiChannelMessage>;
157
+ }
158
+ /** A list of users belonging to a channel, along with their role. */
159
+ export interface ApiChannelUserList {
160
+ channel_id?: string;
161
+ channel_users?: Array<ChannelUserListChannelUser>;
162
+ cursor?: string;
163
+ }
164
+ /** */
165
+ export interface ApiClanDesc {
166
+ banner?: string;
167
+ clan_id?: string;
168
+ clan_name?: string;
169
+ creator_id?: string;
170
+ logo?: string;
171
+ status?: number;
172
+ }
173
+ /** */
174
+ export interface ApiClanDescList {
175
+ clandesc?: Array<ApiClanDesc>;
176
+ }
177
+ /** */
178
+ export interface ApiClanDescProfile {
179
+ avatar_url?: string;
180
+ clan_id?: string;
181
+ creator_id?: string;
182
+ nick_name?: string;
183
+ profile_banner?: string;
184
+ profile_theme?: string;
185
+ }
186
+ /** Get clan profile. */
187
+ export interface ApiClanProfile {
188
+ avartar?: string;
189
+ clan_id?: string;
190
+ nick_name?: string;
191
+ user_id?: string;
192
+ }
193
+ /** A list of users belonging to a clan, along with their role. */
194
+ export interface ApiClanUserList {
195
+ clan_id?: string;
196
+ clan_users?: Array<ClanUserListClanUser>;
197
+ cursor?: string;
198
+ }
199
+ /** */
200
+ export interface ApiCreateCategoryDescRequest {
201
+ category_name?: string;
202
+ clan_id?: string;
203
+ }
204
+ /** Create a channel within clan. */
205
+ export interface ApiCreateChannelDescRequest {
206
+ category_id?: string;
207
+ channel_id?: string;
208
+ channel_label?: string;
209
+ channel_private?: number;
210
+ clan_id?: string;
211
+ parrent_id?: string;
212
+ type?: number;
213
+ user_ids?: Array<string>;
214
+ }
215
+ /** */
216
+ export interface ApiCreateClanDescRequest {
217
+ banner?: string;
218
+ clan_name?: string;
219
+ creator_id?: string;
220
+ logo?: string;
221
+ }
222
+ /** Create a role within clan. */
223
+ export interface ApiCreateRoleRequest {
224
+ active_permission_ids?: Array<string>;
225
+ add_user_ids?: Array<string>;
226
+ allow_mention?: number;
227
+ clan_id?: string;
228
+ color?: string;
229
+ description?: string;
230
+ display_online?: number;
231
+ role_icon?: string;
232
+ title?: string;
233
+ }
234
+ /** Delete a role the user has access to. */
235
+ export interface ApiDeleteRoleRequest {
236
+ channel_id?: string;
237
+ role_id?: string;
238
+ }
239
+ /** Storage objects to delete. */
240
+ export interface ApiDeleteStorageObjectId {
241
+ collection?: string;
242
+ key?: string;
243
+ version?: string;
244
+ }
245
+ /** Batch delete storage objects. */
246
+ export interface ApiDeleteStorageObjectsRequest {
247
+ object_ids?: Array<ApiDeleteStorageObjectId>;
248
+ }
249
+ /** Represents an event to be passed through the server to registered event handlers. */
250
+ export interface ApiEvent {
251
+ external?: boolean;
252
+ name?: string;
253
+ properties?: Record<string, string>;
254
+ timestamp?: string;
255
+ }
256
+ /** A friend of a user. */
257
+ export interface ApiFriend {
258
+ state?: number;
259
+ update_time?: string;
260
+ user?: ApiUser;
261
+ }
262
+ /** A collection of zero or more friends of the user. */
263
+ export interface ApiFriendList {
264
+ cursor?: string;
265
+ friends?: Array<ApiFriend>;
266
+ }
267
+ /** Add link invite users to. */
268
+ export interface ApiInviteUserRes {
269
+ channel_id?: string;
270
+ channel_label?: string;
271
+ clan_id?: string;
272
+ clan_name?: string;
273
+ user_joined?: boolean;
274
+ }
275
+ /** Add link invite users to. */
276
+ export interface ApiLinkInviteUser {
277
+ channel_id?: string;
278
+ clan_id?: string;
279
+ create_time?: string;
280
+ creator_id?: string;
281
+ expiry_time?: string;
282
+ id?: string;
283
+ invite_link?: string;
284
+ }
285
+ /** Add link invite users to. */
286
+ export interface ApiLinkInviteUserRequest {
287
+ channel_id?: string;
288
+ clan_id?: string;
289
+ expiry_time?: number;
290
+ }
291
+ /** Link Steam to the current user's account. */
292
+ export interface ApiLinkSteamRequest {
293
+ account?: ApiAccountSteam;
294
+ sync?: boolean;
295
+ }
296
+ /** */
297
+ export interface ApiMessageAttachment {
298
+ filename?: string;
299
+ filetype?: string;
300
+ height?: number;
301
+ size?: number;
302
+ url?: string;
303
+ width?: number;
304
+ }
305
+ /** */
306
+ export interface ApiMessageDeleted {
307
+ deletor?: string;
308
+ message_id?: string;
309
+ }
310
+ /** */
311
+ export interface ApiMessageMention {
312
+ create_time?: string;
313
+ id?: string;
314
+ user_id?: string;
315
+ username?: string;
316
+ }
317
+ /** */
318
+ export interface ApiMessageReaction {
319
+ action?: boolean;
320
+ emoji?: string;
321
+ id?: string;
322
+ sender_id?: string;
323
+ sender_name?: string;
324
+ sender_avatar?: string;
325
+ count: number;
326
+ }
327
+ /** */
328
+ export interface ApiMessageRef {
329
+ message_id?: string;
330
+ message_ref_id?: string;
331
+ ref_type?: number;
332
+ message_sender_id?: string;
333
+ content?: string;
334
+ has_attachment: boolean;
335
+ }
336
+ /** A notification in the server. */
337
+ export interface ApiNotification {
338
+ code?: number;
339
+ content?: string;
340
+ create_time?: string;
341
+ id?: string;
342
+ persistent?: boolean;
343
+ sender_id?: string;
344
+ subject?: string;
345
+ }
346
+ /** A collection of zero or more notifications. */
347
+ export interface ApiNotificationList {
348
+ cacheable_cursor?: string;
349
+ notifications?: Array<ApiNotification>;
350
+ }
351
+ /** */
352
+ export interface ApiPermission {
353
+ active?: number;
354
+ description?: string;
355
+ id?: string;
356
+ slug?: string;
357
+ title?: string;
358
+ }
359
+ /** A list of permission description, usually a result of a list operation. */
360
+ export interface ApiPermissionList {
361
+ permissions?: Array<ApiPermission>;
362
+ }
363
+ /** Storage objects to get. */
364
+ export interface ApiReadStorageObjectId {
365
+ collection?: string;
366
+ key?: string;
367
+ user_id?: string;
368
+ }
369
+ /** Batch get storage objects. */
370
+ export interface ApiReadStorageObjectsRequest {
371
+ object_ids?: Array<ApiReadStorageObjectId>;
372
+ }
373
+ /** */
374
+ export interface ApiRole {
375
+ active?: number;
376
+ allow_mention?: number;
377
+ clan_id?: string;
378
+ color?: string;
379
+ creator_id?: string;
380
+ description?: string;
381
+ display_online?: number;
382
+ id?: string;
383
+ permission_list?: ApiPermissionList;
384
+ role_icon?: string;
385
+ role_user_list?: ApiRoleUserList;
386
+ slug?: string;
387
+ title?: string;
388
+ role_channel_active?: string;
389
+ channel_id?: string;
390
+ }
391
+ /** A list of role description, usually a result of a list operation. */
392
+ export interface ApiRoleList {
393
+ cacheable_cursor?: string;
394
+ next_cursor?: string;
395
+ prev_cursor?: string;
396
+ roles?: Array<ApiRole>;
397
+ }
398
+ /** */
399
+ export interface ApiRoleUserList {
400
+ cursor?: string;
401
+ role_users?: Array<RoleUserListRoleUser>;
402
+ }
403
+ /** Execute an Lua function on the server. */
404
+ export interface ApiRpc {
405
+ http_key?: string;
406
+ id?: string;
407
+ payload?: string;
408
+ }
409
+ /** A user's session used to authenticate messages. */
410
+ export interface ApiSession {
411
+ created?: boolean;
412
+ refresh_token?: string;
413
+ token?: string;
414
+ }
415
+ /** Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user. */
416
+ export interface ApiSessionLogoutRequest {
417
+ refresh_token?: string;
418
+ token?: string;
419
+ }
420
+ /** Authenticate against the server with a refresh token. */
421
+ export interface ApiSessionRefreshRequest {
422
+ token?: string;
423
+ vars?: Record<string, string>;
424
+ }
425
+ /** An object within the storage engine. */
426
+ export interface ApiStorageObject {
427
+ collection?: string;
428
+ create_time?: string;
429
+ key?: string;
430
+ permission_read?: number;
431
+ permission_write?: number;
432
+ update_time?: string;
433
+ user_id?: string;
434
+ value?: string;
435
+ version?: string;
436
+ }
437
+ /** A storage acknowledgement. */
438
+ export interface ApiStorageObjectAck {
439
+ collection?: string;
440
+ create_time?: string;
441
+ key?: string;
442
+ update_time?: string;
443
+ user_id?: string;
444
+ version?: string;
445
+ }
446
+ /** Batch of acknowledgements for the storage object write. */
447
+ export interface ApiStorageObjectAcks {
448
+ acks?: Array<ApiStorageObjectAck>;
449
+ }
450
+ /** List of storage objects. */
451
+ export interface ApiStorageObjectList {
452
+ cursor?: string;
453
+ objects?: Array<ApiStorageObject>;
454
+ }
455
+ /** Batch of storage objects. */
456
+ export interface ApiStorageObjects {
457
+ objects?: Array<ApiStorageObject>;
458
+ }
459
+ /** Update a user's account details. */
460
+ export interface ApiUpdateAccountRequest {
461
+ avatar_url?: string;
462
+ display_name?: string;
463
+ lang_tag?: string;
464
+ location?: string;
465
+ timezone?: string;
466
+ username?: string;
467
+ }
468
+ /** */
469
+ export interface ApiUpdateCategoryDescRequest {
470
+ category_id?: string;
471
+ category_name?: string;
472
+ }
473
+ /** Fetch a batch of zero or more users from the server. */
474
+ export interface ApiUpdateUsersRequest {
475
+ avatar_url?: string;
476
+ display_name?: string;
477
+ }
478
+ /** */
479
+ export interface ApiUploadAttachment {
480
+ filename?: string;
481
+ url?: string;
482
+ }
483
+ /** */
484
+ export interface ApiUploadAttachmentRequest {
485
+ filename?: string;
486
+ filetype?: string;
487
+ height?: number;
488
+ size?: number;
489
+ width?: number;
490
+ }
491
+ /** A user in the server. */
492
+ export interface ApiUser {
493
+ apple_id?: string;
494
+ avatar_url?: string;
495
+ create_time?: string;
496
+ display_name?: string;
497
+ edge_count?: number;
498
+ facebook_id?: string;
499
+ gamecenter_id?: string;
500
+ google_id?: string;
501
+ id?: string;
502
+ lang_tag?: string;
503
+ location?: string;
504
+ metadata?: string;
505
+ online?: boolean;
506
+ steam_id?: string;
507
+ timezone?: string;
508
+ update_time?: string;
509
+ username?: string;
510
+ }
511
+ /** A collection of zero or more users. */
512
+ export interface ApiUsers {
513
+ users?: Array<ApiUser>;
514
+ }
515
+ /** A list of users belonging to a channel, along with their role. */
516
+ export interface ApiVoiceChannelUser {
517
+ channel_id?: string;
518
+ jid?: string;
519
+ user_id?: string;
520
+ }
521
+ /** A list of users belonging to a channel, along with their role. */
522
+ export interface ApiVoiceChannelUserList {
523
+ voice_channel_users?: Array<ApiVoiceChannelUser>;
524
+ }
525
+ /** The object to store. */
526
+ export interface ApiWriteStorageObject {
527
+ collection?: string;
528
+ key?: string;
529
+ permission_read?: number;
530
+ permission_write?: number;
531
+ value?: string;
532
+ version?: string;
533
+ }
534
+ /** Write objects to the storage engine. */
535
+ export interface ApiWriteStorageObjectsRequest {
536
+ objects?: Array<ApiWriteStorageObject>;
537
+ }
538
+ /** */
539
+ export interface ProtobufAny {
540
+ type_url?: string;
541
+ value?: string;
542
+ }
543
+ /** */
544
+ export interface RpcStatus {
545
+ code?: number;
546
+ details?: Array<ProtobufAny>;
547
+ message?: string;
548
+ }
549
+ export declare class MezonApi {
550
+ readonly serverKey: string;
551
+ readonly basePath: string;
552
+ readonly timeoutMs: number;
553
+ constructor(serverKey: string, basePath: string, timeoutMs: number);
554
+ /** A healthcheck which load balancers can use to check the service. */
555
+ healthcheck(bearerToken: string, options?: any): Promise<any>;
556
+ /** Delete the current user's account. */
557
+ deleteAccount(bearerToken: string, options?: any): Promise<any>;
558
+ /** Fetch the current user's account. */
559
+ getAccount(bearerToken: string, options?: any): Promise<ApiAccount>;
560
+ /** Update fields in the current user's account. */
561
+ updateAccount(bearerToken: string, body: ApiUpdateAccountRequest, options?: any): Promise<any>;
562
+ /** Authenticate a user with an Apple ID against the server. */
563
+ authenticateApple(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountApple, create?: boolean, username?: string, options?: any): Promise<ApiSession>;
564
+ /** Authenticate a user with a custom id against the server. */
565
+ authenticateCustom(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountCustom, create?: boolean, username?: string, options?: any): Promise<ApiSession>;
566
+ /** Authenticate a user with a device id against the server. */
567
+ authenticateDevice(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountDevice, create?: boolean, username?: string, options?: any): Promise<ApiSession>;
568
+ /** Authenticate a user with an email+password against the server. */
569
+ authenticateEmail(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountEmail, create?: boolean, username?: string, options?: any): Promise<ApiSession>;
570
+ /** Authenticate a user with a Facebook OAuth token against the server. */
571
+ authenticateFacebook(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountFacebook, create?: boolean, username?: string, sync?: boolean, options?: any): Promise<ApiSession>;
572
+ /** Authenticate a user with a Facebook Instant Game token against the server. */
573
+ authenticateFacebookInstantGame(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountFacebookInstantGame, create?: boolean, username?: string, options?: any): Promise<ApiSession>;
574
+ /** Authenticate a user with Apple's GameCenter against the server. */
575
+ authenticateGameCenter(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountGameCenter, create?: boolean, username?: string, options?: any): Promise<ApiSession>;
576
+ /** Authenticate a user with Google against the server. */
577
+ authenticateGoogle(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountGoogle, create?: boolean, username?: string, options?: any): Promise<ApiSession>;
578
+ /** Authenticate a user with Steam against the server. */
579
+ authenticateSteam(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountSteam, create?: boolean, username?: string, sync?: boolean, options?: any): Promise<ApiSession>;
580
+ /** Add an Apple ID to the social profiles on the current user's account. */
581
+ linkApple(bearerToken: string, body: ApiAccountApple, options?: any): Promise<any>;
582
+ /** Add a custom ID to the social profiles on the current user's account. */
583
+ linkCustom(bearerToken: string, body: ApiAccountCustom, options?: any): Promise<any>;
584
+ /** Add a device ID to the social profiles on the current user's account. */
585
+ linkDevice(bearerToken: string, body: ApiAccountDevice, options?: any): Promise<any>;
586
+ /** Add an email+password to the social profiles on the current user's account. */
587
+ linkEmail(bearerToken: string, body: ApiAccountEmail, options?: any): Promise<any>;
588
+ /** Add Facebook to the social profiles on the current user's account. */
589
+ linkFacebook(bearerToken: string, account: ApiAccountFacebook, sync?: boolean, options?: any): Promise<any>;
590
+ /** Add Facebook Instant Game to the social profiles on the current user's account. */
591
+ linkFacebookInstantGame(bearerToken: string, body: ApiAccountFacebookInstantGame, options?: any): Promise<any>;
592
+ /** Add Apple's GameCenter to the social profiles on the current user's account. */
593
+ linkGameCenter(bearerToken: string, body: ApiAccountGameCenter, options?: any): Promise<any>;
594
+ /** Add Google to the social profiles on the current user's account. */
595
+ linkGoogle(bearerToken: string, body: ApiAccountGoogle, options?: any): Promise<any>;
596
+ /** Add Steam to the social profiles on the current user's account. */
597
+ linkSteam(bearerToken: string, body: ApiLinkSteamRequest, options?: any): Promise<any>;
598
+ /** Refresh a user's session using a refresh token retrieved from a previous authentication request. */
599
+ sessionRefresh(basicAuthUsername: string, basicAuthPassword: string, body: ApiSessionRefreshRequest, options?: any): Promise<ApiSession>;
600
+ /** Remove the Apple ID from the social profiles on the current user's account. */
601
+ unlinkApple(bearerToken: string, body: ApiAccountApple, options?: any): Promise<any>;
602
+ /** Remove the custom ID from the social profiles on the current user's account. */
603
+ unlinkCustom(bearerToken: string, body: ApiAccountCustom, options?: any): Promise<any>;
604
+ /** Remove the device ID from the social profiles on the current user's account. */
605
+ unlinkDevice(bearerToken: string, body: ApiAccountDevice, options?: any): Promise<any>;
606
+ /** Remove the email+password from the social profiles on the current user's account. */
607
+ unlinkEmail(bearerToken: string, body: ApiAccountEmail, options?: any): Promise<any>;
608
+ /** Remove Facebook from the social profiles on the current user's account. */
609
+ unlinkFacebook(bearerToken: string, body: ApiAccountFacebook, options?: any): Promise<any>;
610
+ /** Remove Facebook Instant Game profile from the social profiles on the current user's account. */
611
+ unlinkFacebookInstantGame(bearerToken: string, body: ApiAccountFacebookInstantGame, options?: any): Promise<any>;
612
+ /** Remove Apple's GameCenter from the social profiles on the current user's account. */
613
+ unlinkGameCenter(bearerToken: string, body: ApiAccountGameCenter, options?: any): Promise<any>;
614
+ /** Remove Google from the social profiles on the current user's account. */
615
+ unlinkGoogle(bearerToken: string, body: ApiAccountGoogle, options?: any): Promise<any>;
616
+ /** Remove Steam from the social profiles on the current user's account. */
617
+ unlinkSteam(bearerToken: string, body: ApiAccountSteam, options?: any): Promise<any>;
618
+ /** */
619
+ listCategoryDescs(bearerToken: string, clanId: string, creatorId?: string, categoryName?: string, categoryId?: string, options?: any): Promise<ApiCategoryDescList>;
620
+ /** List a channel's message history. */
621
+ listChannelMessages(bearerToken: string, channelId: string, messageId?: string, direction?: number, limit?: number, options?: any): Promise<ApiChannelMessageList>;
622
+ /** List user channels */
623
+ listChannelDescs(bearerToken: string, limit?: number, state?: number, cursor?: string, clanId?: string, channelType?: number, options?: any): Promise<ApiChannelDescList>;
624
+ /** Create a new channel with the current user as the owner. */
625
+ createChannelDesc(bearerToken: string, body: ApiCreateChannelDescRequest, options?: any): Promise<ApiChannelDescription>;
626
+ /** Delete a channel by ID. */
627
+ deleteChannelDesc(bearerToken: string, channelId: string, options?: any): Promise<any>;
628
+ /** Update fields in a given channel. */
629
+ updateChannelDesc(bearerToken: string, channelId: string, body: {}, options?: any): Promise<any>;
630
+ /** Add users to a channel. */
631
+ addChannelUsers(bearerToken: string, channelId: string, userIds?: Array<string>, options?: any): Promise<any>;
632
+ /** Leave a channel the user is a member of. */
633
+ leaveChannel(bearerToken: string, channelId: string, options?: any): Promise<any>;
634
+ /** Kick a set of users from a channel. */
635
+ removeChannelUsers(bearerToken: string, channelId: string, userIds?: Array<string>, options?: any): Promise<any>;
636
+ /** List all users that are part of a channel. */
637
+ listChannelUsers(bearerToken: string, clanId: string, channelId: string, channelType?: number, limit?: number, state?: number, cursor?: string, options?: any): Promise<ApiChannelUserList>;
638
+ /** List all users that are part of a channel. */
639
+ listChannelVoiceUsers(bearerToken: string, clanId?: string, channelId?: string, channelType?: number, limit?: number, state?: number, cursor?: string, options?: any): Promise<ApiVoiceChannelUserList>;
640
+ /** List clans */
641
+ listClanDescs(bearerToken: string, limit?: number, state?: number, cursor?: string, options?: any): Promise<ApiClanDescList>;
642
+ /** Create a clan */
643
+ createClanDesc(bearerToken: string, body: ApiCreateClanDescRequest, options?: any): Promise<ApiClanDesc>;
644
+ /** Delete a clan desc by ID. */
645
+ deleteClanDesc(bearerToken: string, clanDescId: string, options?: any): Promise<any>;
646
+ /** Update fields in a given clan. */
647
+ updateClanDesc(bearerToken: string, clanId: string, creatorId?: string, clanName?: string, logo?: string, banner?: string, options?: any): Promise<any>;
648
+ /** List all users that are part of a clan. */
649
+ listClanUsers(bearerToken: string, clanId: string, options?: any): Promise<ApiClanUserList>;
650
+ /** Get a clan desc profile */
651
+ getClanDescProfile(bearerToken: string, clanId: string, options?: any): Promise<ApiClanDescProfile>;
652
+ /** Update fields in a given clan profile. */
653
+ updateClanDescProfile(bearerToken: string, clanId: string, body: {}, options?: any): Promise<any>;
654
+ /** */
655
+ createCategoryDesc(bearerToken: string, body: ApiCreateCategoryDescRequest, options?: any): Promise<ApiCategoryDesc>;
656
+ /** */
657
+ deleteCategoryDesc(bearerToken: string, creatorId: string, options?: any): Promise<any>;
658
+ /** Immediately join an open group, or request to join a closed one. */
659
+ registFCMDeviceToken(bearerToken: string, token?: string, options?: any): Promise<any>;
660
+ /** Submit an event for processing in the server's registered runtime custom events handler. */
661
+ event(bearerToken: string, body: ApiEvent, options?: any): Promise<any>;
662
+ /** Delete one or more users by ID or username. */
663
+ deleteFriends(bearerToken: string, ids?: Array<string>, usernames?: Array<string>, options?: any): Promise<any>;
664
+ /** List all friends for the current user. */
665
+ listFriends(bearerToken: string, limit?: number, state?: number, cursor?: string, options?: any): Promise<ApiFriendList>;
666
+ /** Add friends by ID or username to a user's account. */
667
+ addFriends(bearerToken: string, ids?: Array<string>, usernames?: Array<string>, options?: any): Promise<any>;
668
+ /** Block one or more users by ID or username. */
669
+ blockFriends(bearerToken: string, ids?: Array<string>, usernames?: Array<string>, options?: any): Promise<any>;
670
+ /** Import Facebook friends and add them to a user's account. */
671
+ importFacebookFriends(bearerToken: string, account: ApiAccountFacebook, reset?: boolean, options?: any): Promise<any>;
672
+ /** Import Steam friends and add them to a user's account. */
673
+ importSteamFriends(bearerToken: string, account: ApiAccountSteam, reset?: boolean, options?: any): Promise<any>;
674
+ /** */
675
+ getUserProfileOnClan(bearerToken: string, clanId: string, options?: any): Promise<ApiClanProfile>;
676
+ /** Add users to a channel. */
677
+ createLinkInviteUser(bearerToken: string, body: ApiLinkInviteUserRequest, options?: any): Promise<ApiLinkInviteUser>;
678
+ /** Add users to a channel. */
679
+ getLinkInvite(bearerToken: string, inviteId: string, options?: any): Promise<ApiInviteUserRes>;
680
+ /** Add users to a channel. */
681
+ inviteUser(bearerToken: string, inviteId: string, options?: any): Promise<ApiInviteUserRes>;
682
+ /** */
683
+ getListPermission(bearerToken: string, options?: any): Promise<ApiPermissionList>;
684
+ /** Delete one or more notifications for the current user. */
685
+ deleteNotifications(bearerToken: string, ids?: Array<string>, options?: any): Promise<any>;
686
+ /** Fetch list of notifications. */
687
+ listNotifications(bearerToken: string, limit?: number, cacheableCursor?: string, options?: any): Promise<ApiNotificationList>;
688
+ /** */
689
+ GetPermissionOfUserInTheClan(bearerToken: string, clanId: string, options?: any): Promise<ApiPermissionList>;
690
+ /** */
691
+ addRolesChannelDesc(bearerToken: string, body: ApiAddRoleChannelDescRequest, options?: any): Promise<any>;
692
+ /** Update a role when Delete a role by ID. */
693
+ deleteRoleChannelDesc(bearerToken: string, body: ApiDeleteRoleRequest, options?: any): Promise<any>;
694
+ /** List user roles */
695
+ listRoles(bearerToken: string, limit?: number, state?: number, cursor?: string, clanId?: string, options?: any): Promise<ApiRoleList>;
696
+ /** Create a new role for clan. */
697
+ createRole(bearerToken: string, body: ApiCreateRoleRequest, options?: any): Promise<ApiRole>;
698
+ /** Update a role when Delete a role by ID. */
699
+ updateRoleDelete(bearerToken: string, roleId: string, body: {}, options?: any): Promise<any>;
700
+ /** Delete a role by ID. */
701
+ deleteRole(bearerToken: string, roleId: string, options?: any): Promise<any>;
702
+ /** Update fields in a given role. */
703
+ updateRole(bearerToken: string, roleId: string, body: {}, options?: any): Promise<any>;
704
+ /** List role permissions */
705
+ listRolePermissions(bearerToken: string, roleId: string, options?: any): Promise<ApiPermissionList>;
706
+ /** List role permissions */
707
+ listRoleUsers(bearerToken: string, roleId: string, limit?: number, cursor?: string, options?: any): Promise<ApiRoleUserList>;
708
+ /** Execute a Lua function on the server. */
709
+ rpcFunc2(bearerToken: string, basicAuthUsername: string, basicAuthPassword: string, id: string, payload?: string, httpKey?: string, options?: any): Promise<ApiRpc>;
710
+ /** Execute a Lua function on the server. */
711
+ rpcFunc(bearerToken: string, basicAuthUsername: string, basicAuthPassword: string, id: string, payload: string, httpKey?: string, options?: any): Promise<ApiRpc>;
712
+ /** Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user. */
713
+ sessionLogout(bearerToken: string, body: ApiSessionLogoutRequest, options?: any): Promise<any>;
714
+ /** Get storage objects. */
715
+ readStorageObjects(bearerToken: string, body: ApiReadStorageObjectsRequest, options?: any): Promise<ApiStorageObjects>;
716
+ /** Write objects into the storage engine. */
717
+ writeStorageObjects(bearerToken: string, body: ApiWriteStorageObjectsRequest, options?: any): Promise<ApiStorageObjectAcks>;
718
+ /** Delete one or more objects by ID or username. */
719
+ deleteStorageObjects(bearerToken: string, body: ApiDeleteStorageObjectsRequest, options?: any): Promise<any>;
720
+ /** List publicly readable storage objects in a given collection. */
721
+ listStorageObjects(bearerToken: string, collection: string, userId?: string, limit?: number, cursor?: string, options?: any): Promise<ApiStorageObjectList>;
722
+ /** List publicly readable storage objects in a given collection. */
723
+ listStorageObjects2(bearerToken: string, collection: string, userId: string, limit?: number, cursor?: string, options?: any): Promise<ApiStorageObjectList>;
724
+ /** Update fields in a given category. */
725
+ updateCategory(bearerToken: string, body: ApiUpdateCategoryDescRequest, options?: any): Promise<any>;
726
+ /** */
727
+ updateUserProfileByClan(bearerToken: string, clanId: string, body: {}, options?: any): Promise<any>;
728
+ /** Create a new group with the current user as the owner. */
729
+ uploadAttachmentFile(bearerToken: string, body: ApiUploadAttachmentRequest, options?: any): Promise<any>;
730
+ /** Fetch zero or more users by ID and/or username. */
731
+ getUsers(bearerToken: string, ids?: Array<string>, usernames?: Array<string>, facebookIds?: Array<string>, options?: any): Promise<ApiUsers>;
732
+ /** */
733
+ updateUser(bearerToken: string, body: ApiUpdateUsersRequest, options?: any): Promise<any>;
734
+ buildFullUrl(basePath: string, fragment: string, queryParams: Map<string, any>): string;
735
+ }