mezon-js 2.8.42 → 2.8.44

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,1096 +0,0 @@
1
- /** A single user-role pair. */
2
- export interface ChannelUserListChannelUser {
3
- clan_avatar?: string;
4
- clan_id?: string;
5
- clan_nick?: string;
6
- id?: string;
7
- role_id?: Array<string>;
8
- thread_id?: string;
9
- user?: ApiUser;
10
- }
11
- /** A single user-role pair. */
12
- export interface ClanUserListClanUser {
13
- clan_avatar?: string;
14
- clan_id?: string;
15
- clan_nick?: string;
16
- role_id?: string;
17
- user?: ApiUser;
18
- }
19
- /** */
20
- export interface MezonChangeChannelCategoryBody {
21
- channel_id?: string;
22
- }
23
- /** */
24
- export interface MezonDeleteWebhookByIdBody {
25
- }
26
- /** Update app information. */
27
- export interface MezonUpdateAppBody {
28
- applogo?: string;
29
- appname?: string;
30
- metadata?: string;
31
- token?: string;
32
- }
33
- /** Update fields in a given channel. */
34
- export interface MezonUpdateChannelDescBody {
35
- category_id?: string;
36
- channel_label?: string;
37
- }
38
- /** */
39
- export interface MezonUpdateClanDescBody {
40
- banner?: string;
41
- clan_name?: string;
42
- creator_id?: string;
43
- logo?: string;
44
- status?: number;
45
- }
46
- /** */
47
- export interface MezonUpdateClanDescProfileBody {
48
- avatar_url?: string;
49
- nick_name?: string;
50
- profile_banner?: string;
51
- profile_theme?: string;
52
- }
53
- /** */
54
- export interface MezonUpdateClanEmojiByIdBody {
55
- category?: string;
56
- shortname?: string;
57
- source?: string;
58
- }
59
- /** */
60
- export interface MezonUpdateClanStickerByIdBody {
61
- category?: string;
62
- shortname?: string;
63
- source?: string;
64
- }
65
- /** update a event within clan. */
66
- export interface MezonUpdateEventBody {
67
- address?: string;
68
- channel_id?: string;
69
- description?: string;
70
- end_time?: string;
71
- logo?: string;
72
- start_time?: string;
73
- title?: string;
74
- }
75
- /** Update fields in a given role. */
76
- export interface MezonUpdateRoleBody {
77
- active_permission_ids?: Array<string>;
78
- add_user_ids?: Array<string>;
79
- allow_mention?: number;
80
- clan_id?: string;
81
- color?: string;
82
- description?: string;
83
- display_online?: number;
84
- remove_permission_ids?: Array<string>;
85
- remove_user_ids?: Array<string>;
86
- role_icon?: string;
87
- title?: string;
88
- }
89
- /** Delete a role the user has access to. */
90
- export interface MezonUpdateRoleDeleteBody {
91
- channel_id?: string;
92
- clan_id?: string;
93
- }
94
- /** */
95
- export interface MezonUpdateUserProfileByClanBody {
96
- avatar?: string;
97
- nick_name?: string;
98
- }
99
- /** */
100
- export interface MezonUpdateWebhookByIdBody {
101
- avatar?: string;
102
- channel_id?: string;
103
- webhook_name?: string;
104
- }
105
- /** A single user-role pair. */
106
- export interface RoleUserListRoleUser {
107
- avatar_url?: string;
108
- display_name?: string;
109
- id?: string;
110
- lang_tag?: string;
111
- location?: string;
112
- online?: boolean;
113
- username?: string;
114
- }
115
- /** A user with additional account details. Always the current user. */
116
- export interface ApiAccount {
117
- custom_id?: string;
118
- devices?: Array<ApiAccountDevice>;
119
- disable_time?: string;
120
- email?: string;
121
- user?: ApiUser;
122
- verify_time?: string;
123
- wallet?: string;
124
- }
125
- /** Send a app token to the server. Used with authenticate/link/unlink. */
126
- export interface ApiAccountApp {
127
- appid?: string;
128
- appname?: string;
129
- token?: string;
130
- vars?: Record<string, string>;
131
- }
132
- /** Send a Apple Sign In token to the server. Used with authenticate/link/unlink. */
133
- export interface ApiAccountApple {
134
- token?: string;
135
- vars?: Record<string, string>;
136
- }
137
- /** Send a custom ID to the server. Used with authenticate/link/unlink. */
138
- export interface ApiAccountCustom {
139
- id?: string;
140
- vars?: Record<string, string>;
141
- }
142
- /** Send a device to the server. Used with authenticate/link/unlink and user. */
143
- export interface ApiAccountDevice {
144
- id?: string;
145
- vars?: Record<string, string>;
146
- }
147
- /** Send an email with password to the server. Used with authenticate/link/unlink. */
148
- export interface ApiAccountEmail {
149
- email?: string;
150
- password?: string;
151
- vars?: Record<string, string>;
152
- }
153
- /** Send a Facebook token to the server. Used with authenticate/link/unlink. */
154
- export interface ApiAccountFacebook {
155
- token?: string;
156
- vars?: Record<string, string>;
157
- }
158
- /** Send a Facebook Instant Game token to the server. Used with authenticate/link/unlink. */
159
- export interface ApiAccountFacebookInstantGame {
160
- signed_player_info?: string;
161
- vars?: Record<string, string>;
162
- }
163
- /** Send Apple's Game Center account credentials to the server. Used with authenticate/link/unlink.
164
-
165
- https://developer.apple.com/documentation/gamekit/gklocalplayer/1515407-generateidentityverificationsign */
166
- export interface ApiAccountGameCenter {
167
- bundle_id?: string;
168
- player_id?: string;
169
- public_key_url?: string;
170
- salt?: string;
171
- signature?: string;
172
- timestamp_seconds?: string;
173
- vars?: Record<string, string>;
174
- }
175
- /** Send a Google token to the server. Used with authenticate/link/unlink. */
176
- export interface ApiAccountGoogle {
177
- token?: string;
178
- vars?: Record<string, string>;
179
- }
180
- /** Send a Steam token to the server. Used with authenticate/link/unlink. */
181
- export interface ApiAccountSteam {
182
- token?: string;
183
- vars?: Record<string, string>;
184
- }
185
- /** */
186
- export interface ApiAddAppRequest {
187
- appname?: string;
188
- creator_id?: string;
189
- role?: number;
190
- token?: string;
191
- }
192
- /** Add a role for channel. */
193
- export interface ApiAddRoleChannelDescRequest {
194
- channel_id?: string;
195
- role_ids?: Array<string>;
196
- }
197
- /** App information. */
198
- export interface ApiApp {
199
- applogo?: string;
200
- appname?: string;
201
- creator_id?: string;
202
- disable_time?: string;
203
- id?: string;
204
- is_shadow?: boolean;
205
- role?: number;
206
- token?: string;
207
- }
208
- /** A list of apps. */
209
- export interface ApiAppList {
210
- apps?: Array<ApiApp>;
211
- next_cursor?: string;
212
- total_count?: number;
213
- }
214
- /** Authenticate against the server with a device ID. */
215
- export interface ApiAuthenticateRequest {
216
- account?: ApiAccountApp;
217
- }
218
- /** */
219
- export interface ApiCategoryDesc {
220
- category_id?: string;
221
- category_name?: string;
222
- clan_id?: string;
223
- creator_id?: string;
224
- }
225
- /** */
226
- export interface ApiCategoryDescList {
227
- categorydesc?: Array<ApiCategoryDesc>;
228
- }
229
- /** Update fields in a given channel. */
230
- export interface ApiChangeChannelPrivateRequest {
231
- channel_id?: string;
232
- channel_private?: number;
233
- role_ids?: Array<string>;
234
- user_ids?: Array<string>;
235
- }
236
- /** */
237
- export interface ApiChannelAttachment {
238
- create_time?: string;
239
- filename?: string;
240
- filesize?: string;
241
- filetype?: string;
242
- id?: string;
243
- uploader?: string;
244
- url?: string;
245
- }
246
- /** */
247
- export interface ApiChannelAttachmentList {
248
- attachments?: Array<ApiChannelAttachment>;
249
- }
250
- /** A list of channel description, usually a result of a list operation. */
251
- export interface ApiChannelDescList {
252
- cacheable_cursor?: string;
253
- channeldesc?: Array<ApiChannelDescription>;
254
- next_cursor?: string;
255
- prev_cursor?: string;
256
- }
257
- /** */
258
- export interface ApiChannelDescription {
259
- active?: number;
260
- category_id?: string;
261
- category_name?: string;
262
- channel_avatar?: Array<string>;
263
- channel_id?: string;
264
- channel_label?: string;
265
- channel_private?: number;
266
- clan_id?: string;
267
- count_mess_unread?: number;
268
- create_time_ms?: number;
269
- creator_id?: string;
270
- creator_name?: string;
271
- last_pin_message?: string;
272
- last_seen_message?: ApiChannelMessageHeader;
273
- last_sent_message?: ApiChannelMessageHeader;
274
- meeting_code?: string;
275
- parrent_id?: string;
276
- status?: number;
277
- type?: number;
278
- update_time_ms?: number;
279
- user_id?: Array<string>;
280
- usernames?: string;
281
- }
282
- /** A message sent on a channel. */
283
- export interface ApiChannelMessage {
284
- attachments?: string;
285
- avatar?: string;
286
- category_name?: string;
287
- channel_id?: string;
288
- channel_label?: string;
289
- clan_avatar?: string;
290
- clan_id?: string;
291
- clan_logo?: string;
292
- clan_nick?: string;
293
- code?: number;
294
- content?: string;
295
- create_time?: string;
296
- create_time_ms?: number;
297
- display_name?: string;
298
- hide_editted?: boolean;
299
- mentions?: string;
300
- message_id?: string;
301
- mode?: number;
302
- reactions?: string;
303
- referenced_message?: string;
304
- references?: string;
305
- sender_id?: string;
306
- update_time?: string;
307
- update_time_ms?: number;
308
- username?: string;
309
- }
310
- /** */
311
- export interface ApiChannelMessageHeader {
312
- attachment?: string;
313
- content?: string;
314
- id?: string;
315
- mention?: string;
316
- reaction?: string;
317
- referece?: string;
318
- sender_id?: string;
319
- timestamp?: string;
320
- }
321
- /** A list of channel messages, usually a result of a list operation. */
322
- export interface ApiChannelMessageList {
323
- last_seen_message?: ApiChannelMessageHeader;
324
- last_sent_message?: ApiChannelMessageHeader;
325
- messages?: Array<ApiChannelMessage>;
326
- }
327
- /** A list of users belonging to a channel, along with their role. */
328
- export interface ApiChannelUserList {
329
- channel_id?: string;
330
- channel_users?: Array<ChannelUserListChannelUser>;
331
- cursor?: string;
332
- }
333
- /** */
334
- export interface ApiCheckDuplicateClanNameResponse {
335
- is_duplicate?: boolean;
336
- }
337
- /** */
338
- export interface ApiClanDesc {
339
- banner?: string;
340
- clan_id?: string;
341
- clan_name?: string;
342
- creator_id?: string;
343
- logo?: string;
344
- status?: number;
345
- }
346
- /** */
347
- export interface ApiClanDescList {
348
- clandesc?: Array<ApiClanDesc>;
349
- }
350
- /** */
351
- export interface ApiClanDescProfile {
352
- avatar_url?: string;
353
- clan_id?: string;
354
- creator_id?: string;
355
- nick_name?: string;
356
- profile_banner?: string;
357
- profile_theme?: string;
358
- }
359
- /** */
360
- export interface ApiClanEmojiCreateRequest {
361
- category?: string;
362
- clan_id?: string;
363
- id?: string;
364
- shortname?: string;
365
- source?: string;
366
- }
367
- /** Get clan profile. */
368
- export interface ApiClanProfile {
369
- avartar?: string;
370
- clan_id?: string;
371
- nick_name?: string;
372
- user_id?: string;
373
- }
374
- /** */
375
- export interface ApiClanStickerAddRequest {
376
- category?: string;
377
- clan_id?: string;
378
- id?: string;
379
- shortname?: string;
380
- source?: string;
381
- }
382
- /** A list of users belonging to a clan, along with their role. */
383
- export interface ApiClanUserList {
384
- clan_id?: string;
385
- clan_users?: Array<ClanUserListClanUser>;
386
- cursor?: string;
387
- }
388
- /** */
389
- export interface ApiCreateCategoryDescRequest {
390
- category_name?: string;
391
- clan_id?: string;
392
- }
393
- /** Create a channel within clan. */
394
- export interface ApiCreateChannelDescRequest {
395
- category_id?: string;
396
- channel_id?: string;
397
- channel_label?: string;
398
- channel_private?: number;
399
- clan_id?: string;
400
- parrent_id?: string;
401
- type?: number;
402
- user_ids?: Array<string>;
403
- }
404
- /** */
405
- export interface ApiCreateClanDescRequest {
406
- banner?: string;
407
- clan_name?: string;
408
- creator_id?: string;
409
- logo?: string;
410
- }
411
- /** Create a event within clan. */
412
- export interface ApiCreateEventRequest {
413
- address?: string;
414
- channel_id?: string;
415
- clan_id?: string;
416
- description?: string;
417
- end_time?: string;
418
- logo?: string;
419
- start_time?: string;
420
- title?: string;
421
- }
422
- /** Create a role within clan. */
423
- export interface ApiCreateRoleRequest {
424
- active_permission_ids?: Array<string>;
425
- add_user_ids?: Array<string>;
426
- allow_mention?: number;
427
- clan_id?: string;
428
- color?: string;
429
- description?: string;
430
- display_online?: number;
431
- role_icon?: string;
432
- title?: string;
433
- }
434
- /** Delete a channel the user has access to. */
435
- export interface ApiDeleteChannelDescRequest {
436
- channel_id?: string;
437
- }
438
- /** */
439
- export interface ApiDeleteChannelMessagesResponse {
440
- total?: string;
441
- }
442
- /** */
443
- export interface ApiDeleteEventRequest {
444
- event_id?: string;
445
- }
446
- /** Delete a role the user has access to. */
447
- export interface ApiDeleteRoleRequest {
448
- channel_id?: string;
449
- clan_id?: string;
450
- role_id?: string;
451
- }
452
- /** */
453
- export interface ApiEventList {
454
- events?: Array<ApiEventManagement>;
455
- }
456
- /** */
457
- export interface ApiEventManagement {
458
- active?: number;
459
- address?: string;
460
- channel_id?: string;
461
- clan_id?: string;
462
- create_time?: string;
463
- creator_id?: string;
464
- description?: string;
465
- end_time?: string;
466
- id?: string;
467
- logo?: string;
468
- start_event?: number;
469
- start_time?: string;
470
- title?: string;
471
- user_ids?: Array<string>;
472
- }
473
- /** */
474
- export interface ApiFilterParam {
475
- field_name?: string;
476
- field_value?: string;
477
- }
478
- /** A friend of a user. */
479
- export interface ApiFriend {
480
- state?: number;
481
- update_time?: string;
482
- user?: ApiUser;
483
- }
484
- /** A collection of zero or more friends of the user. */
485
- export interface ApiFriendList {
486
- cursor?: string;
487
- friends?: Array<ApiFriend>;
488
- }
489
- /** Add link invite users to. */
490
- export interface ApiInviteUserRes {
491
- channel_id?: string;
492
- channel_label?: string;
493
- clan_id?: string;
494
- clan_name?: string;
495
- expiry_time?: string;
496
- user_joined?: boolean;
497
- }
498
- /** Add link invite users to. */
499
- export interface ApiLinkInviteUser {
500
- channel_id?: string;
501
- clan_id?: string;
502
- create_time?: string;
503
- creator_id?: string;
504
- expiry_time?: string;
505
- id?: string;
506
- invite_link?: string;
507
- }
508
- /** Add link invite users to. */
509
- export interface ApiLinkInviteUserRequest {
510
- channel_id?: string;
511
- clan_id?: string;
512
- expiry_time?: number;
513
- }
514
- /** Link Steam to the current user's account. */
515
- export interface ApiLinkSteamRequest {
516
- account?: ApiAccountSteam;
517
- sync?: boolean;
518
- }
519
- /** A notification in the server. */
520
- export interface ApiNotification {
521
- avatar_url?: string;
522
- channel_id?: string;
523
- channel_type?: number;
524
- clan_id?: string;
525
- code?: number;
526
- content?: string;
527
- create_time?: string;
528
- id?: string;
529
- persistent?: boolean;
530
- sender_id?: string;
531
- subject?: string;
532
- }
533
- /** */
534
- export interface ApiNotificationChannel {
535
- channel_id?: string;
536
- }
537
- /** */
538
- export interface ApiNotificationChannelCategoySetting {
539
- channel_category_label?: string;
540
- channel_category_title?: string;
541
- id?: string;
542
- notification_setting_type?: number;
543
- }
544
- /** */
545
- export interface ApiNotificationChannelCategoySettingsList {
546
- noti_channel_categoy_setting?: Array<ApiNotificationChannelCategoySetting>;
547
- }
548
- /** A collection of zero or more notifications. */
549
- export interface ApiNotificationList {
550
- cacheable_cursor?: string;
551
- notifications?: Array<ApiNotification>;
552
- }
553
- /** */
554
- export interface ApiPermission {
555
- active?: number;
556
- description?: string;
557
- id?: string;
558
- scope?: number;
559
- slug?: string;
560
- title?: string;
561
- }
562
- /** A list of permission description, usually a result of a list operation. */
563
- export interface ApiPermissionList {
564
- permissions?: Array<ApiPermission>;
565
- }
566
- /** */
567
- export interface ApiPermissionUpdate {
568
- permission_id?: string;
569
- type?: number;
570
- }
571
- /** */
572
- export interface ApiPinMessage {
573
- avatar?: string;
574
- channel_id?: string;
575
- content?: string;
576
- id?: string;
577
- message_id?: string;
578
- sender_id?: string;
579
- username?: string;
580
- }
581
- /** */
582
- export interface ApiPinMessageRequest {
583
- channel_id?: string;
584
- message_id?: string;
585
- }
586
- /** */
587
- export interface ApiPinMessagesList {
588
- pin_messages_list?: Array<ApiPinMessage>;
589
- }
590
- /** */
591
- export interface ApiRegistrationEmailRequest {
592
- avatar_url?: string;
593
- display_name?: string;
594
- dob?: string;
595
- email?: string;
596
- password?: string;
597
- username?: string;
598
- vars?: Record<string, string>;
599
- }
600
- /** */
601
- export interface ApiRole {
602
- active?: number;
603
- allow_mention?: number;
604
- channel_ids?: Array<string>;
605
- clan_id?: string;
606
- color?: string;
607
- creator_id?: string;
608
- description?: string;
609
- display_online?: number;
610
- id?: string;
611
- permission_list?: ApiPermissionList;
612
- role_channel_active?: number;
613
- role_icon?: string;
614
- role_user_list?: ApiRoleUserList;
615
- slug?: string;
616
- title?: string;
617
- }
618
- /** A list of role description, usually a result of a list operation. */
619
- export interface ApiRoleList {
620
- cacheable_cursor?: string;
621
- next_cursor?: string;
622
- prev_cursor?: string;
623
- roles?: Array<ApiRole>;
624
- }
625
- /** */
626
- export interface ApiRoleUserList {
627
- cursor?: string;
628
- role_users?: Array<RoleUserListRoleUser>;
629
- }
630
- /** Execute an Lua function on the server. */
631
- export interface ApiRpc {
632
- http_key?: string;
633
- id?: string;
634
- payload?: string;
635
- }
636
- /** */
637
- export interface ApiSearchMessageDocument {
638
- attachment?: string;
639
- avatar_url?: string;
640
- channel_id?: string;
641
- channel_label?: string;
642
- channel_type?: number;
643
- clan_id?: string;
644
- clan_name?: string;
645
- content?: string;
646
- create_time?: string;
647
- display_name?: string;
648
- mention?: string;
649
- message_id?: string;
650
- reaction?: string;
651
- reference?: string;
652
- sender_id?: string;
653
- update_time?: string;
654
- username?: string;
655
- }
656
- /** */
657
- export interface ApiSearchMessageRequest {
658
- filters?: Array<ApiFilterParam>;
659
- from?: number;
660
- size?: number;
661
- sorts?: Array<ApiSortParam>;
662
- }
663
- /** */
664
- export interface ApiSearchMessageResponse {
665
- messages?: Array<ApiSearchMessageDocument>;
666
- total?: number;
667
- }
668
- /** A user's session used to authenticate messages. */
669
- export interface ApiSession {
670
- created?: boolean;
671
- refresh_token?: string;
672
- token?: string;
673
- }
674
- /** Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user. */
675
- export interface ApiSessionLogoutRequest {
676
- refresh_token?: string;
677
- token?: string;
678
- }
679
- /** Authenticate against the server with a refresh token. */
680
- export interface ApiSessionRefreshRequest {
681
- token?: string;
682
- vars?: Record<string, string>;
683
- }
684
- /** */
685
- export interface ApiSetDefaultNotificationRequest {
686
- category_id?: string;
687
- clan_id?: string;
688
- notification_type?: number;
689
- }
690
- /** */
691
- export interface ApiSetMuteNotificationRequest {
692
- active?: number;
693
- channel_id?: string;
694
- notification_type?: number;
695
- }
696
- /** */
697
- export interface ApiSetNotificationRequest {
698
- channel_category_id?: string;
699
- notification_type?: number;
700
- time_mute?: string;
701
- }
702
- /** */
703
- export interface ApiSortParam {
704
- field_name?: string;
705
- order?: string;
706
- }
707
- /** Update a user's account details. */
708
- export interface ApiUpdateAccountRequest {
709
- about_me?: string;
710
- avatar_url?: string;
711
- display_name?: string;
712
- lang_tag?: string;
713
- location?: string;
714
- timezone?: string;
715
- username?: string;
716
- }
717
- /** */
718
- export interface ApiUpdateCategoryDescRequest {
719
- category_id?: string;
720
- category_name?: string;
721
- }
722
- /** */
723
- export interface ApiUpdateRoleChannelRequest {
724
- channel_id?: string;
725
- permission_update?: Array<ApiPermissionUpdate>;
726
- role_id?: string;
727
- }
728
- /** Fetch a batch of zero or more users from the server. */
729
- export interface ApiUpdateUsersRequest {
730
- avatar_url?: string;
731
- display_name?: string;
732
- }
733
- /** */
734
- export interface ApiUploadAttachment {
735
- filename?: string;
736
- url?: string;
737
- }
738
- /** */
739
- export interface ApiUploadAttachmentRequest {
740
- filename?: string;
741
- filetype?: string;
742
- height?: number;
743
- size?: number;
744
- width?: number;
745
- }
746
- /** A user in the server. */
747
- export interface ApiUser {
748
- about_me?: string;
749
- apple_id?: string;
750
- avatar_url?: string;
751
- create_time?: string;
752
- display_name?: string;
753
- edge_count?: number;
754
- facebook_id?: string;
755
- gamecenter_id?: string;
756
- google_id?: string;
757
- id?: string;
758
- join_time?: string;
759
- lang_tag?: string;
760
- location?: string;
761
- metadata?: string;
762
- online?: boolean;
763
- steam_id?: string;
764
- timezone?: string;
765
- update_time?: string;
766
- username?: string;
767
- }
768
- /** A collection of zero or more users. */
769
- export interface ApiUsers {
770
- users?: Array<ApiUser>;
771
- }
772
- /** A list of users belonging to a channel, along with their role. */
773
- export interface ApiVoiceChannelUser {
774
- channel_id?: string;
775
- id?: string;
776
- participant?: string;
777
- user_id?: string;
778
- }
779
- /** A list of users belonging to a channel, along with their role. */
780
- export interface ApiVoiceChannelUserList {
781
- voice_channel_users?: Array<ApiVoiceChannelUser>;
782
- }
783
- /** */
784
- export interface ApiWebhook {
785
- active?: number;
786
- avatar?: string;
787
- channel_id?: string;
788
- create_time?: string;
789
- creator_id?: string;
790
- id?: string;
791
- update_time?: string;
792
- url?: string;
793
- webhook_name?: string;
794
- }
795
- /** */
796
- export interface ApiWebhookCreateRequest {
797
- avatar?: string;
798
- channel_id?: string;
799
- webhook_name?: string;
800
- }
801
- /** */
802
- export interface ApiWebhookGenerateResponse {
803
- avatar?: string;
804
- channel_id?: string;
805
- hook_name?: string;
806
- url?: string;
807
- }
808
- /** */
809
- export interface ApiWebhookListResponse {
810
- webhooks?: Array<ApiWebhook>;
811
- }
812
- /** Represents an event to be passed through the server to registered event handlers. */
813
- export interface MezonapiEvent {
814
- external?: boolean;
815
- name?: string;
816
- properties?: Record<string, string>;
817
- timestamp?: string;
818
- }
819
- /** */
820
- export interface ProtobufAny {
821
- }
822
- /** */
823
- export interface RpcStatus {
824
- code?: number;
825
- details?: Array<ProtobufAny>;
826
- message?: string;
827
- }
828
- export declare class MezonApi {
829
- readonly serverKey: any;
830
- readonly basePath: string;
831
- readonly timeoutMs: number;
832
- constructor(serverKey: any, apiKey: string, basePath: string, timeoutMs: number);
833
- /** A healthcheck which load balancers can use to check the service. */
834
- healthcheck(bearerToken: string, options?: any): Promise<any>;
835
- /** Delete the current user's account. */
836
- deleteAccount(bearerToken: string, options?: any): Promise<any>;
837
- /** Fetch the current user's account. */
838
- getAccount(bearerToken: string, options?: any): Promise<ApiAccount>;
839
- /** Update fields in the current user's account. */
840
- updateAccount(bearerToken: string, body: ApiUpdateAccountRequest, options?: any): Promise<any>;
841
- /** Authenticate a user with an Apple ID against the server. */
842
- authenticateApple(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountApple, create?: boolean, username?: string, options?: any): Promise<ApiSession>;
843
- /** Authenticate a user with a custom id against the server. */
844
- authenticateCustom(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountCustom, create?: boolean, username?: string, options?: any): Promise<ApiSession>;
845
- /** Authenticate a user with a device id against the server. */
846
- authenticateDevice(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountDevice, create?: boolean, username?: string, options?: any): Promise<ApiSession>;
847
- /** Authenticate a user with an email+password against the server. */
848
- authenticateEmail(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountEmail, create?: boolean, username?: string, options?: any): Promise<ApiSession>;
849
- /** Authenticate a user with a Facebook OAuth token against the server. */
850
- authenticateFacebook(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountFacebook, create?: boolean, username?: string, sync?: boolean, options?: any): Promise<ApiSession>;
851
- /** Authenticate a user with a Facebook Instant Game token against the server. */
852
- authenticateFacebookInstantGame(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountFacebookInstantGame, create?: boolean, username?: string, options?: any): Promise<ApiSession>;
853
- /** Authenticate a user with Apple's GameCenter against the server. */
854
- authenticateGameCenter(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountGameCenter, create?: boolean, username?: string, options?: any): Promise<ApiSession>;
855
- /** Authenticate a user with Google against the server. */
856
- authenticateGoogle(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountGoogle, create?: boolean, username?: string, options?: any): Promise<ApiSession>;
857
- /** Authenticate a user with Steam against the server. */
858
- authenticateSteam(basicAuthUsername: string, basicAuthPassword: string, account: ApiAccountSteam, create?: boolean, username?: string, sync?: boolean, options?: any): Promise<ApiSession>;
859
- /** Add an Apple ID to the social profiles on the current user's account. */
860
- linkApple(bearerToken: string, body: ApiAccountApple, options?: any): Promise<any>;
861
- /** Add a custom ID to the social profiles on the current user's account. */
862
- linkCustom(bearerToken: string, body: ApiAccountCustom, options?: any): Promise<any>;
863
- /** Add a device ID to the social profiles on the current user's account. */
864
- linkDevice(bearerToken: string, body: ApiAccountDevice, options?: any): Promise<any>;
865
- /** Add an email+password to the social profiles on the current user's account. */
866
- linkEmail(bearerToken: string, body: ApiAccountEmail, options?: any): Promise<any>;
867
- /** Add Facebook to the social profiles on the current user's account. */
868
- linkFacebook(bearerToken: string, account: ApiAccountFacebook, sync?: boolean, options?: any): Promise<any>;
869
- /** Add Facebook Instant Game to the social profiles on the current user's account. */
870
- linkFacebookInstantGame(bearerToken: string, body: ApiAccountFacebookInstantGame, options?: any): Promise<any>;
871
- /** Add Apple's GameCenter to the social profiles on the current user's account. */
872
- linkGameCenter(bearerToken: string, body: ApiAccountGameCenter, options?: any): Promise<any>;
873
- /** Add Google to the social profiles on the current user's account. */
874
- linkGoogle(bearerToken: string, body: ApiAccountGoogle, options?: any): Promise<any>;
875
- /** Add Steam to the social profiles on the current user's account. */
876
- linkSteam(bearerToken: string, body: ApiLinkSteamRequest, options?: any): Promise<any>;
877
- /** Authenticate a user with an email+password against the server. */
878
- registrationEmail(bearerToken: string, body: ApiRegistrationEmailRequest, options?: any): Promise<ApiSession>;
879
- /** Refresh a user's session using a refresh token retrieved from a previous authentication request. */
880
- sessionRefresh(basicAuthUsername: string, basicAuthPassword: string, body: ApiSessionRefreshRequest, options?: any): Promise<ApiSession>;
881
- /** Remove the Apple ID from the social profiles on the current user's account. */
882
- unlinkApple(bearerToken: string, body: ApiAccountApple, options?: any): Promise<any>;
883
- /** Remove the custom ID from the social profiles on the current user's account. */
884
- unlinkCustom(bearerToken: string, body: ApiAccountCustom, options?: any): Promise<any>;
885
- /** Remove the device ID from the social profiles on the current user's account. */
886
- unlinkDevice(bearerToken: string, body: ApiAccountDevice, options?: any): Promise<any>;
887
- /** Remove the email+password from the social profiles on the current user's account. */
888
- unlinkEmail(bearerToken: string, body: ApiAccountEmail, options?: any): Promise<any>;
889
- /** Remove Facebook from the social profiles on the current user's account. */
890
- unlinkFacebook(bearerToken: string, body: ApiAccountFacebook, options?: any): Promise<any>;
891
- /** Remove Facebook Instant Game profile from the social profiles on the current user's account. */
892
- unlinkFacebookInstantGame(bearerToken: string, body: ApiAccountFacebookInstantGame, options?: any): Promise<any>;
893
- /** Remove Apple's GameCenter from the social profiles on the current user's account. */
894
- unlinkGameCenter(bearerToken: string, body: ApiAccountGameCenter, options?: any): Promise<any>;
895
- /** Remove Google from the social profiles on the current user's account. */
896
- unlinkGoogle(bearerToken: string, body: ApiAccountGoogle, options?: any): Promise<any>;
897
- /** Remove Steam from the social profiles on the current user's account. */
898
- unlinkSteam(bearerToken: string, body: ApiAccountSteam, options?: any): Promise<any>;
899
- /** Add a new apps. */
900
- addApp(bearerToken: string, body: ApiAddAppRequest, options?: any): Promise<any>;
901
- /** List (and optionally filter) accounts. */
902
- listApps(bearerToken: string, filter?: string, tombstones?: boolean, cursor?: string, options?: any): Promise<ApiAppList>;
903
- /** Delete all information stored for an app. */
904
- deleteApp(bearerToken: string, id: string, recordDeletion?: boolean, options?: any): Promise<any>;
905
- /** Get detailed app information. */
906
- getApp(bearerToken: string, id: string, options?: any): Promise<ApiApp>;
907
- /** Update one or more fields on a app. */
908
- updateApp(bearerToken: string, id: string, body: MezonUpdateAppBody, options?: any): Promise<any>;
909
- /** Ban a app. */
910
- banApp(bearerToken: string, id: string, options?: any): Promise<any>;
911
- /** Unban an app. */
912
- unbanApp(bearerToken: string, id: string, options?: any): Promise<any>;
913
- /** Authenticate a app with a token against the server. */
914
- authenticate(basicAuthUsername: string, basicAuthPassword: string, body: ApiAuthenticateRequest, options?: any): Promise<ApiSession>;
915
- /** Delete messages. */
916
- deleteChannelMessages(bearerToken: string, before?: string, ids?: Array<string>, options?: any): Promise<ApiDeleteChannelMessagesResponse>;
917
- /** */
918
- listCategoryDescs(bearerToken: string, clanId: string, creatorId?: string, categoryName?: string, categoryId?: string, options?: any): Promise<ApiCategoryDescList>;
919
- /** List a channel's message history. */
920
- listChannelMessages(bearerToken: string, channelId: string, messageId?: string, limit?: number, direction?: number, options?: any): Promise<ApiChannelMessageList>;
921
- /** Add users to a channel. */
922
- addChannelUsers(bearerToken: string, channelId: string, userIds?: Array<string>, options?: any): Promise<any>;
923
- /** List all attachment that are part of a channel. */
924
- listChannelAttachment(bearerToken: string, channelId: string, clanId?: string, fileType?: string, limit?: number, state?: number, cursor?: string, options?: any): Promise<ApiChannelAttachmentList>;
925
- /** Leave a channel the user is a member of. */
926
- leaveChannel(bearerToken: string, channelId: string, options?: any): Promise<any>;
927
- /** Kick a set of users from a channel. */
928
- removeChannelUsers(bearerToken: string, channelId: string, userIds?: Array<string>, options?: any): Promise<any>;
929
- /** List all users that are part of a channel. */
930
- listChannelUsers(bearerToken: string, channelId: string, clanId?: string, channelType?: number, limit?: number, state?: number, cursor?: string, options?: any): Promise<ApiChannelUserList>;
931
- /** List user channels */
932
- listChannelDescs(bearerToken: string, limit?: number, state?: number, cursor?: string, clanId?: string, channelType?: number, options?: any): Promise<ApiChannelDescList>;
933
- /** Create a new channel with the current user as the owner. */
934
- createChannelDesc(bearerToken: string, body: ApiCreateChannelDescRequest, options?: any): Promise<ApiChannelDescription>;
935
- /** Delete a channel by ID. */
936
- deleteChannelDesc(bearerToken: string, channelId: string, options?: any): Promise<any>;
937
- /** Update fields in a given channel. */
938
- updateChannelDesc(bearerToken: string, channelId: string, body: MezonUpdateChannelDescBody, options?: any): Promise<any>;
939
- /** List all users that are part of a channel. */
940
- listChannelVoiceUsers(bearerToken: string, clanId?: string, channelId?: string, channelType?: number, limit?: number, state?: number, cursor?: string, options?: any): Promise<ApiVoiceChannelUserList>;
941
- /** List clans */
942
- listClanDescs(bearerToken: string, limit?: number, state?: number, cursor?: string, options?: any): Promise<ApiClanDescList>;
943
- /** Create a clan */
944
- createClanDesc(bearerToken: string, body: ApiCreateClanDescRequest, options?: any): Promise<ApiClanDesc>;
945
- /** Delete a clan desc by ID. */
946
- deleteClanDesc(bearerToken: string, clanDescId: string, options?: any): Promise<any>;
947
- /** Update fields in a given clan. */
948
- updateClanDesc(bearerToken: string, clanId: string, body: MezonUpdateClanDescBody, options?: any): Promise<any>;
949
- /** Kick a set of users from a clan. */
950
- removeClanUsers(bearerToken: string, clanId: string, userIds?: Array<string>, options?: any): Promise<any>;
951
- /** List all users that are part of a clan. */
952
- listClanUsers(bearerToken: string, clanId: string, options?: any): Promise<ApiClanUserList>;
953
- /** check duplicate clan name */
954
- checkDuplicateClanName(bearerToken: string, clanName: string, options?: any): Promise<ApiCheckDuplicateClanNameResponse>;
955
- /** Get a clan desc profile */
956
- getClanDescProfile(bearerToken: string, clanId: string, options?: any): Promise<ApiClanDescProfile>;
957
- /** Update fields in a given clan profile. */
958
- updateClanDescProfile(bearerToken: string, clanId: string, body: MezonUpdateClanDescProfileBody, options?: any): Promise<any>;
959
- /** */
960
- createCategoryDesc(bearerToken: string, body: ApiCreateCategoryDescRequest, options?: any): Promise<ApiCategoryDesc>;
961
- /** */
962
- deleteCategoryDesc(bearerToken: string, creatorId: string, options?: any): Promise<any>;
963
- /** regist fcm device token */
964
- registFCMDeviceToken(bearerToken: string, token?: string, deviceId?: string, platform?: string, options?: any): Promise<any>;
965
- /** close direct message. */
966
- closeDirectMess(bearerToken: string, body: ApiDeleteChannelDescRequest, options?: any): Promise<any>;
967
- /** open direct message. */
968
- openDirectMess(bearerToken: string, body: ApiDeleteChannelDescRequest, options?: any): Promise<any>;
969
- /** Post clan Emoji /v2/emoji/create */
970
- createClanEmoji(bearerToken: string, body: ApiClanEmojiCreateRequest, options?: any): Promise<any>;
971
- /** Delete a emoji by ID. */
972
- deleteByIdClanEmoji(bearerToken: string, id: string, clanId?: string, options?: any): Promise<any>;
973
- /** Update ClanEmoj By id */
974
- updateClanEmojiById(bearerToken: string, id: string, body: MezonUpdateClanEmojiByIdBody, options?: any): Promise<any>;
975
- /** Search message from elasticsearch service. */
976
- searchMessage(bearerToken: string, body: ApiSearchMessageRequest, options?: any): Promise<ApiSearchMessageResponse>;
977
- /** Submit an event for processing in the server's registered runtime custom events handler. */
978
- event(bearerToken: string, body: MezonapiEvent, options?: any): Promise<any>;
979
- /** List user events */
980
- listEvents(bearerToken: string, clanId?: string, options?: any): Promise<ApiEventList>;
981
- /** Create a new event for clan. */
982
- createEvent(bearerToken: string, body: ApiCreateEventRequest, options?: any): Promise<ApiEventManagement>;
983
- /** Update fields in a given event. */
984
- updateEventUser(bearerToken: string, body: ApiDeleteEventRequest, options?: any): Promise<any>;
985
- /** Delete a event by ID. */
986
- deleteEvent(bearerToken: string, eventId: string, options?: any): Promise<any>;
987
- /** Update fields in a given event. */
988
- updateEvent(bearerToken: string, eventId: string, body: MezonUpdateEventBody, options?: any): Promise<any>;
989
- /** Delete one or more users by ID or username. */
990
- deleteFriends(bearerToken: string, ids?: Array<string>, usernames?: Array<string>, options?: any): Promise<any>;
991
- /** List all friends for the current user. */
992
- listFriends(bearerToken: string, limit?: number, state?: number, cursor?: string, options?: any): Promise<ApiFriendList>;
993
- /** Add friends by ID or username to a user's account. */
994
- addFriends(bearerToken: string, ids?: Array<string>, usernames?: Array<string>, options?: any): Promise<any>;
995
- /** Block one or more users by ID or username. */
996
- blockFriends(bearerToken: string, ids?: Array<string>, usernames?: Array<string>, options?: any): Promise<any>;
997
- /** Import Facebook friends and add them to a user's account. */
998
- importFacebookFriends(bearerToken: string, account: ApiAccountFacebook, reset?: boolean, options?: any): Promise<any>;
999
- /** Import Steam friends and add them to a user's account. */
1000
- importSteamFriends(bearerToken: string, account: ApiAccountSteam, reset?: boolean, options?: any): Promise<any>;
1001
- /** */
1002
- getUserProfileOnClan(bearerToken: string, clanId: string, options?: any): Promise<ApiClanProfile>;
1003
- /** Add users to a channel. */
1004
- createLinkInviteUser(bearerToken: string, body: ApiLinkInviteUserRequest, options?: any): Promise<ApiLinkInviteUser>;
1005
- /** Add users to a channel. */
1006
- getLinkInvite(bearerToken: string, inviteId: string, options?: any): Promise<ApiInviteUserRes>;
1007
- /** Add users to a channel. */
1008
- inviteUser(bearerToken: string, inviteId: string, options?: any): Promise<ApiInviteUserRes>;
1009
- /** set mute notification user channel. */
1010
- setMuteNotificationChannel(bearerToken: string, body: ApiSetMuteNotificationRequest, options?: any): Promise<any>;
1011
- /** Delete one or more notifications for the current user. */
1012
- deleteNotifications(bearerToken: string, ids?: Array<string>, options?: any): Promise<any>;
1013
- /** Fetch list of notifications. */
1014
- listNotifications(bearerToken: string, limit?: number, clanId?: string, cacheableCursor?: string, options?: any): Promise<ApiNotificationList>;
1015
- /** set notification user channel. */
1016
- setNotificationChannelSetting(bearerToken: string, body: ApiSetNotificationRequest, options?: any): Promise<any>;
1017
- /** set notification user channel. */
1018
- setNotificationClanSetting(bearerToken: string, body: ApiSetDefaultNotificationRequest, options?: any): Promise<any>;
1019
- /** set notification user channel. */
1020
- setNotificationCategorySetting(bearerToken: string, body: ApiSetNotificationRequest, options?: any): Promise<any>;
1021
- /** */
1022
- deleteNotificationCategorySetting(bearerToken: string, categoryId?: string, options?: any): Promise<any>;
1023
- /** */
1024
- deleteNotificationChannel(bearerToken: string, channelId?: string, options?: any): Promise<any>;
1025
- /** notification category, channel selected */
1026
- getChannelCategoryNotiSettingsList(bearerToken: string, clanId?: string, options?: any): Promise<ApiNotificationChannelCategoySettingsList>;
1027
- /** */
1028
- deleteNotiReactMessage(bearerToken: string, channelId?: string, options?: any): Promise<any>;
1029
- /** */
1030
- setNotificationReactMessage(bearerToken: string, body: ApiNotificationChannel, options?: any): Promise<any>;
1031
- /** set permission role channel. */
1032
- setRoleChannelPermission(bearerToken: string, body: ApiUpdateRoleChannelRequest, options?: any): Promise<any>;
1033
- /** Get permission list */
1034
- getListPermission(bearerToken: string, options?: any): Promise<ApiPermissionList>;
1035
- /** */
1036
- getPermissionOfUserInTheClan(bearerToken: string, clanId: string, options?: any): Promise<ApiPermissionList>;
1037
- /** */
1038
- deletePinMessage(bearerToken: string, messageId?: string, options?: any): Promise<any>;
1039
- /** */
1040
- getPinMessagesList(bearerToken: string, channelId?: string, options?: any): Promise<ApiPinMessagesList>;
1041
- /** set notification user channel. */
1042
- createPinMessage(bearerToken: string, body: ApiPinMessageRequest, options?: any): Promise<any>;
1043
- /** */
1044
- addRolesChannelDesc(bearerToken: string, body: ApiAddRoleChannelDescRequest, options?: any): Promise<any>;
1045
- /** update the category of a channel */
1046
- changeChannelCategory(bearerToken: string, newCategoryId: string, body: MezonChangeChannelCategoryBody, options?: any): Promise<any>;
1047
- /** Update a role when Delete a role by ID. */
1048
- deleteRoleChannelDesc(bearerToken: string, body: ApiDeleteRoleRequest, options?: any): Promise<any>;
1049
- /** List user roles */
1050
- listRoles(bearerToken: string, limit?: number, state?: number, cursor?: string, clanId?: string, options?: any): Promise<ApiRoleList>;
1051
- /** Create a new role for clan. */
1052
- createRole(bearerToken: string, body: ApiCreateRoleRequest, options?: any): Promise<ApiRole>;
1053
- /** Update a role when Delete a role by ID. */
1054
- updateRoleDelete(bearerToken: string, roleId: string, body: MezonUpdateRoleDeleteBody, options?: any): Promise<any>;
1055
- /** Delete a role by ID. */
1056
- deleteRole(bearerToken: string, roleId: string, channelId?: string, clanId?: string, options?: any): Promise<any>;
1057
- /** Update fields in a given role. */
1058
- updateRole(bearerToken: string, roleId: string, body: MezonUpdateRoleBody, options?: any): Promise<any>;
1059
- /** List role permissions */
1060
- listRolePermissions(bearerToken: string, roleId: string, options?: any): Promise<ApiPermissionList>;
1061
- /** List role permissions */
1062
- listRoleUsers(bearerToken: string, roleId: string, limit?: number, cursor?: string, options?: any): Promise<ApiRoleUserList>;
1063
- /** Execute a Lua function on the server. */
1064
- rpcFunc2(bearerToken: string, basicAuthUsername: string, basicAuthPassword: string, id: string, payload?: string, httpKey?: string, options?: any): Promise<ApiRpc>;
1065
- /** Execute a Lua function on the server. */
1066
- rpcFunc(bearerToken: string, basicAuthUsername: string, basicAuthPassword: string, id: string, payload: string, httpKey?: string, options?: any): Promise<ApiRpc>;
1067
- /** Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user. */
1068
- sessionLogout(bearerToken: string, body: ApiSessionLogoutRequest, options?: any): Promise<any>;
1069
- /** Add a new sticker */
1070
- addClanSticker(bearerToken: string, body: ApiClanStickerAddRequest, options?: any): Promise<any>;
1071
- /** Delete a sticker by ID */
1072
- deleteClanStickerById(bearerToken: string, id: string, clanId?: string, options?: any): Promise<any>;
1073
- /** Update a sticker by ID */
1074
- updateClanStickerById(bearerToken: string, id: string, body: MezonUpdateClanStickerByIdBody, options?: any): Promise<any>;
1075
- /** Update fields in a given category. */
1076
- updateCategory(bearerToken: string, body: ApiUpdateCategoryDescRequest, options?: any): Promise<any>;
1077
- /** Update channel private. */
1078
- updateChannelPrivate(bearerToken: string, body: ApiChangeChannelPrivateRequest, options?: any): Promise<any>;
1079
- /** */
1080
- updateUserProfileByClan(bearerToken: string, clanId: string, body: MezonUpdateUserProfileByClanBody, options?: any): Promise<any>;
1081
- /** Upload attachment */
1082
- uploadAttachmentFile(bearerToken: string, body: ApiUploadAttachmentRequest, options?: any): Promise<ApiUploadAttachment>;
1083
- /** Fetch zero or more users by ID and/or username. */
1084
- getUsers(bearerToken: string, ids?: Array<string>, usernames?: Array<string>, facebookIds?: Array<string>, options?: any): Promise<ApiUsers>;
1085
- /** */
1086
- updateUser(bearerToken: string, body: ApiUpdateUsersRequest, options?: any): Promise<any>;
1087
- /** create webhook */
1088
- generateWebhook(bearerToken: string, body: ApiWebhookCreateRequest, options?: any): Promise<ApiWebhookGenerateResponse>;
1089
- /** update webhook name by id */
1090
- updateWebhookById(bearerToken: string, id: string, body: MezonUpdateWebhookByIdBody, options?: any): Promise<any>;
1091
- /** list webhook belong to the channel */
1092
- listWebhookByChannelId(bearerToken: string, channelId: string, clanId?: string, options?: any): Promise<ApiWebhookListResponse>;
1093
- /** disabled webhook */
1094
- deleteWebhookById(bearerToken: string, id: string, body: MezonDeleteWebhookByIdBody, options?: any): Promise<any>;
1095
- buildFullUrl(basePath: string, fragment: string, queryParams: Map<string, any>): string;
1096
- }