mezon-js 2.13.78 → 2.13.80

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.
Files changed (38) hide show
  1. package/client.ts +3279 -2482
  2. package/dist/client.d.ts +163 -349
  3. package/dist/gateway.api.d.ts +33 -0
  4. package/dist/index.d.ts +2 -4
  5. package/dist/{api.gen.d.ts → mezon-js/api.gen.d.ts} +1 -0
  6. package/dist/mezon-js/client.d.ts +347 -0
  7. package/dist/mezon-js/gateway.api.d.ts +33 -0
  8. package/dist/mezon-js/index.d.ts +23 -0
  9. package/dist/mezon-js/session.d.ts +61 -0
  10. package/dist/mezon-js/socket.d.ts +1212 -0
  11. package/dist/mezon-js/types/index.d.ts +2212 -0
  12. package/dist/mezon-js/utils.d.ts +6 -0
  13. package/dist/mezon-js/web_socket_adapter.d.ts +83 -0
  14. package/dist/mezon-js.cjs.js +9038 -21145
  15. package/dist/mezon-js.esm.mjs +9038 -21145
  16. package/dist/mezon-js.esm.mjs.map +1 -0
  17. package/dist/session.d.ts +11 -11
  18. package/dist/socket.d.ts +385 -386
  19. package/dist/types/index.d.ts +2212 -0
  20. package/dist/utils.d.ts +2 -0
  21. package/dist/webrpc/index.d.ts +3 -0
  22. package/gateway.api.ts +577 -0
  23. package/index.ts +2 -5
  24. package/package.json +3 -2
  25. package/rollup.config.js +64 -30
  26. package/session.ts +22 -22
  27. package/socket.ts +921 -846
  28. package/types/index.ts +3883 -0
  29. package/utils.ts +107 -47
  30. package/api/api.ts +0 -39185
  31. package/api.gen.ts +0 -11777
  32. package/google/protobuf/struct.ts +0 -554
  33. package/google/protobuf/timestamp.ts +0 -223
  34. package/google/protobuf/wrappers.ts +0 -670
  35. /package/dist/{api → mezon-js/api}/api.d.ts +0 -0
  36. /package/dist/{google → mezon-js/google}/protobuf/struct.d.ts +0 -0
  37. /package/dist/{google → mezon-js/google}/protobuf/timestamp.d.ts +0 -0
  38. /package/dist/{google → mezon-js/google}/protobuf/wrappers.d.ts +0 -0
package/types/index.ts ADDED
@@ -0,0 +1,3883 @@
1
+ import _m0 from "protobufjs/minimal";
2
+
3
+ /** A user's session used to authenticate messages. */
4
+ export interface Session {
5
+ /** True if the corresponding account was just created, false otherwise. */
6
+ created: boolean;
7
+ /** Authentication credentials. */
8
+ token: string;
9
+ /** Refresh token that can be used for session token renewal. */
10
+ refreshToken: string;
11
+ /** User id */
12
+ userId: string;
13
+ /** Whether to enable "Remember Me" for extended session duration. */
14
+ isRemember: boolean;
15
+ /** api url */
16
+ apiUrl: string;
17
+ /** id token for zklogin */
18
+ idToken: string;
19
+ }
20
+
21
+ /** A single user-role pair. */
22
+ export interface ChannelUserListChannelUser {
23
+ //
24
+ clanAvatar?: string;
25
+ //
26
+ clanId?: string;
27
+ //
28
+ clanNick?: string;
29
+ //
30
+ id?: string;
31
+ //Their relationship to the role.
32
+ roleId?: Array<string>;
33
+ //
34
+ threadId?: string;
35
+ //User.
36
+ userId?: string;
37
+ //Added by
38
+ addedBy?: string;
39
+ // is banned
40
+ isBanned?: boolean;
41
+ // expired time
42
+ expiredBanTime?: number;
43
+ }
44
+
45
+ /** */
46
+ export interface ApiBannedUser {
47
+ //
48
+ banTime?: number;
49
+ //The banned user.
50
+ bannedId?: string;
51
+ //
52
+ bannerId?: string;
53
+ //
54
+ channelId?: string;
55
+ //
56
+ reason?: string;
57
+ }
58
+
59
+ /** */
60
+ export interface ApiBannedUserList {
61
+ //
62
+ bannedUsers?: Array<ApiBannedUser>;
63
+ }
64
+
65
+ /** A single user-role pair. */
66
+ export interface ClanUserListClanUser {
67
+ //from the `avatarUrl` field in the `clan_desc_profile` table.
68
+ clanAvatar?: string;
69
+ //
70
+ clanId?: string;
71
+ //from the `nickName` field in the `clan_desc_profile` table.
72
+ clanNick?: string;
73
+ //Their relationship to the role.
74
+ roleId?: Array<string>;
75
+ //User.
76
+ user?: ApiUser;
77
+ }
78
+
79
+ /** */
80
+ export interface GetPubKeysResponseUserPubKey {
81
+ //
82
+ PK?: ApiPubKey;
83
+ //
84
+ userId?: string;
85
+ }
86
+
87
+ /** */
88
+ export interface CountClanBadgeResponseBadge {
89
+ //
90
+ clanId?: string;
91
+ //
92
+ count?: number;
93
+ }
94
+
95
+ /** */
96
+ export interface MezonChangeChannelCategoryBody {
97
+ //
98
+ channelId?: string;
99
+ //
100
+ clanId?:string;
101
+ }
102
+
103
+ /** */
104
+ export interface MezonSetChanEncryptionMethodBody {
105
+ //
106
+ method?: string;
107
+ }
108
+
109
+ /** */
110
+ export interface MezonDeleteWebhookByIdBody {
111
+ //
112
+ channelId?: string;
113
+ //
114
+ clanId?: string;
115
+ }
116
+
117
+ /** Update app information. */
118
+ export interface MezonUpdateAppBody {
119
+ //about the app.
120
+ about?: string;
121
+ //App url.
122
+ appUrl?: string;
123
+ //Avatar URL.
124
+ applogo?: string;
125
+ //Username.
126
+ appname?: string;
127
+ //Metadata.
128
+ metadata?: string;
129
+ //Token.
130
+ token?: string;
131
+ //Shadow true|false
132
+ isShadow?:string;
133
+ }
134
+
135
+ /** */
136
+ export interface MezonUpdateCategoryBody {
137
+ //The ID of the group to update.
138
+ categoryId?: string;
139
+ //
140
+ categoryName?: string;
141
+ }
142
+
143
+ /** */
144
+ export interface ApiAddAppRequest {
145
+ //
146
+ aboutMe?: string;
147
+ //
148
+ appLogo?: string;
149
+ //App url.
150
+ appUrl?: string;
151
+ //The appname.
152
+ appname?: string;
153
+ //Creator of the app.
154
+ creatorId?: string;
155
+ //Is shadow.
156
+ isShadow?: boolean;
157
+ //Role of this app.
158
+ role?: number;
159
+ //The password.
160
+ token?: string;
161
+ }
162
+
163
+ /**
164
+ * - USER_ROLE_ADMIN: All access
165
+ - USER_ROLE_DEVELOPER: Best for developers, also enables APIs and API explorer
166
+ - USER_ROLE_MAINTAINER: Best for users who regularly update player information.
167
+ - USER_ROLE_READONLY: Read-only role for those only need to view data
168
+ */
169
+ export enum ApiAppRole {
170
+ /* */
171
+ USER_ROLE_UNKNOWN = 0,
172
+ /* */
173
+ USER_ROLE_ADMIN = 1, // All access
174
+ USER_ROLE_DEVELOPER = 2, // Best for developers, also enables APIs and API explorer
175
+ USER_ROLE_MAINTAINER = 3, // Best for users who regularly update player information.
176
+ USER_ROLE_READONLY = 4, // Read-only role for those only need to view data
177
+ }
178
+
179
+ /** Update fields in a given channel. */
180
+ export interface MezonUpdateChannelDescBody {
181
+ //
182
+ ageRestricted?: number;
183
+ //
184
+ appUrl?: string;
185
+ //
186
+ categoryId?: string;
187
+ //
188
+ channelLabel?: string;
189
+ //
190
+ e2ee?: number;
191
+ //
192
+ topic?: string;
193
+ }
194
+
195
+
196
+ /** */
197
+ export interface ApiLogedDevice {
198
+ //
199
+ deviceId?: string;
200
+ //
201
+ deviceName?: string;
202
+ //
203
+ ip?: string;
204
+ //
205
+ lastActive?: string;
206
+ //
207
+ loginAt?: string;
208
+ //
209
+ platform?: string;
210
+ //
211
+ status?: number;
212
+ //
213
+ location?: string;
214
+ //
215
+ isCurrent?: boolean;
216
+ }
217
+
218
+ /** */
219
+ export interface ApiLogedDeviceList {
220
+ //
221
+ devices?: Array<ApiLogedDevice>;
222
+ }
223
+
224
+ /** */
225
+ export interface MezonUpdateClanDescBody {
226
+ //
227
+ banner?: string;
228
+ //
229
+ clanName?: string;
230
+ //
231
+ creatorId?: string;
232
+ //
233
+ logo?: string;
234
+ //
235
+ status?: number;
236
+ // is onboarding.
237
+ isOnboarding?: boolean;
238
+ // welcome channel id.
239
+ welcomeChannelId?: string;
240
+ //Onboarding_banner.
241
+ onboardingBanner?: string;
242
+ // is community.
243
+ isCommunity?: boolean;
244
+ // community banner
245
+ communityBanner?: string;
246
+ // description
247
+ description?: string;
248
+ // about
249
+ about?: string;
250
+ // short url for community
251
+ shortUrl?: string;
252
+ // prevent anonymous
253
+ preventAnonymous?: boolean;
254
+ }
255
+
256
+ /** */
257
+ export interface MezonUpdateClanDescProfileBody {
258
+ //
259
+ avatarUrl?: string;
260
+ //
261
+ nickName?: string;
262
+ //
263
+ profileBanner?: string;
264
+ //
265
+ profileTheme?: string;
266
+ }
267
+
268
+ /** */
269
+ export interface MezonUpdateClanEmojiByIdBody {
270
+ //
271
+ category?: string;
272
+ //
273
+ clanId?: string;
274
+ //
275
+ shortname?: string;
276
+ //
277
+ source?: string;
278
+ }
279
+
280
+ /** */
281
+ export interface MezonUpdateClanStickerByIdBody {
282
+ //
283
+ category?: string;
284
+ //
285
+ clanId?: string;
286
+ //
287
+ shortname?: string;
288
+ //
289
+ source?: string;
290
+ }
291
+
292
+ /** update a event within clan. */
293
+ export interface MezonUpdateEventBody {
294
+ //
295
+ eventId?: string;
296
+ //
297
+ address?: string;
298
+ //
299
+ channelId?: string;
300
+ //
301
+ channelVoiceId?: string;
302
+ //
303
+ clanId?: string;
304
+ //
305
+ creatorId?: string;
306
+ //
307
+ description?: string;
308
+ //
309
+ endTime?: string;
310
+ //
311
+ logo?: string;
312
+ //
313
+ startTime?: string;
314
+ //
315
+ title?: string;
316
+ //
317
+ channelIdOld?: string;
318
+ //
319
+ repeatType?: number;
320
+ }
321
+
322
+ /** Update fields in a given role. */
323
+ export interface MezonUpdateRoleBody {
324
+ //The permissions to add.
325
+ activePermissionIds?: Array<string>;
326
+ //The users to add.
327
+ addUserIds?: Array<string>;
328
+ //
329
+ allowMention?: number;
330
+ //
331
+ clanId?: string;
332
+ //
333
+ color?: string;
334
+ //
335
+ description?: string;
336
+ //
337
+ displayOnline?: number;
338
+ //
339
+ maxPermissionId: string;
340
+ //The permissions to remove.
341
+ removePermissionIds?: Array<string>;
342
+ //The users to remove.
343
+ removeUserIds?: Array<string>;
344
+ //
345
+ roleIcon?: string;
346
+ //
347
+ title?: string;
348
+ }
349
+
350
+ /** Delete a role the user has access to. */
351
+ export interface MezonUpdateRoleDeleteBody {
352
+ //
353
+ clanId?: string;
354
+ }
355
+
356
+ /** Request to get system message by clan and channel IDs. */
357
+ export interface MezonUpdateSystemMessageBody {
358
+ //
359
+ boostMessage?: string;
360
+ //
361
+ channelId?: string;
362
+ //
363
+ hideAuditLog?: string;
364
+ //
365
+ setupTips?: string;
366
+ //
367
+ welcomeRandom?: string;
368
+ //
369
+ welcomeSticker?: string;
370
+ }
371
+
372
+ /** */
373
+ export interface MezonUpdateUserProfileByClanBody {
374
+ //
375
+ avatar?: string;
376
+ //
377
+ nickName?: string;
378
+ }
379
+
380
+ /** */
381
+ export interface MezonUpdateWebhookByIdBody {
382
+ //
383
+ avatar?: string;
384
+ //
385
+ channelId?: string;
386
+ //
387
+ channelIdUpdate?: string;
388
+ //
389
+ clanId?: string;
390
+ //
391
+ webhookName?: string;
392
+ }
393
+
394
+ /** A single user-role pair. */
395
+ export interface RoleUserListRoleUser {
396
+ //A URL for an avatar image.
397
+ avatarUrl?: string;
398
+ //The display name of the user.
399
+ displayName?: string;
400
+ //The id of the user's account.
401
+ id?: string;
402
+ //The language expected to be a tag which follows the BCP-47 spec.
403
+ langTag?: string;
404
+ //The location set by the user.
405
+ location?: string;
406
+ //The timezone set by the user.
407
+ online?: boolean;
408
+ //The username of the user's account.
409
+ username?: string;
410
+ }
411
+
412
+ /** */
413
+ export interface UpdateClanOrderRequestClanOrder {
414
+ //
415
+ clanId?: string;
416
+ //
417
+ order?: number;
418
+ }
419
+
420
+ /** */
421
+ export interface ApiUpdateClanOrderRequest {
422
+ //
423
+ clansOrder?: Array<UpdateClanOrderRequestClanOrder>;
424
+ }
425
+
426
+ /** A user with additional account details. Always the current user. */
427
+ export interface ApiAccount {
428
+ //The custom id in the user's account.
429
+ customId?: string;
430
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the user's account was disabled/banned.
431
+ disableTime?: string;
432
+ //The email address of the user.
433
+ email?: string;
434
+ //
435
+ encryptPrivateKey?: string;
436
+ //
437
+ logo?: string;
438
+ //
439
+ splashScreen?: string;
440
+ //The user object.
441
+ user?: ApiUser;
442
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the user's email was verified.
443
+ verifyTime?: string;
444
+ //The user's wallet data.
445
+ wallet?: number;
446
+ //Password is setted
447
+ passwordSetted?: boolean;
448
+ }
449
+
450
+ /** Send a app token to the server. Used with authenticate/link/unlink. */
451
+ export interface ApiAccountApp {
452
+ //
453
+ appid?: string;
454
+ //
455
+ appname?: string;
456
+ //The account token when create apps to access their profile API.
457
+ token?: string;
458
+ //Extra information that will be bundled in the session token.
459
+ vars?: Record<string, string>;
460
+ }
461
+
462
+ export interface ApiAccountSMS {
463
+ phoneno: string;
464
+ //Extra information that will be bundled in the session token.
465
+ vars?: Record<string, string>;
466
+ }
467
+
468
+ /** Send an email with password to the server. Used with authenticate/link/unlink. */
469
+ export interface ApiAccountEmail {
470
+ //A valid RFC-5322 email address.
471
+ email?: string;
472
+ //A password for the user account. Ignored with unlink operations.
473
+ password?: string;
474
+ // Old email
475
+ prevEmail?: string;
476
+ //Extra information that will be bundled in the session token.
477
+ vars?: Record<string, string>;
478
+ }
479
+
480
+ /** Send a Mezon token to the server. Used with authenticate/link/unlink. */
481
+ export interface ApiAccountMezon {
482
+ //The phone number
483
+ token?: string;
484
+ //Extra information that will be bundled in the session token.
485
+ vars?: Record<string, string>;
486
+ }
487
+
488
+ /** Send a Mezon token to the server. Used with authenticate/link/unlink. */
489
+ export interface ApiLinkAccountMezon {
490
+ //The phone number
491
+ phoneNumber?: string;
492
+ //Extra information that will be bundled in the session token.
493
+ vars?: Record<string, string>;
494
+ }
495
+
496
+
497
+ /** */
498
+ export interface ApiAddFavoriteChannelRequest {
499
+ //
500
+ channelId?: string;
501
+ //
502
+ clanId?: string;
503
+ }
504
+
505
+ /** */
506
+ export interface ApiAddFavoriteChannelResponse {
507
+ //
508
+ channelId?: string;
509
+ }
510
+
511
+ /** Add a role for channel. */
512
+ export interface ApiAddRoleChannelDescRequest {
513
+ //
514
+ channelId?: string;
515
+ //
516
+ roleIds?: Array<string>;
517
+ }
518
+
519
+ /** */
520
+ export interface ApiAllUsersAddChannelResponse {
521
+ //
522
+ channelId?: string;
523
+ //
524
+ limit?: number;
525
+ //
526
+ userIds?: Array<string>;
527
+ //
528
+ usernames?: Array<string>;
529
+ //
530
+ displayNames?: Array<string>;
531
+ //
532
+ avatars?: Array<string>;
533
+ //
534
+ onlines?: Array<boolean>;
535
+ }
536
+
537
+ /** */
538
+ export interface ApiAllUserClans {
539
+ //
540
+ users?: Array<ApiUser>;
541
+ }
542
+
543
+ /** App information. */
544
+ export interface ApiApp {
545
+ //
546
+ about?: string;
547
+ //
548
+ appUrl?: string;
549
+ //
550
+ applogo?: string;
551
+ //
552
+ appname?: string;
553
+ //
554
+ creatorId?: string;
555
+ //The UNIX time when the app was disabled.
556
+ disableTime?: string;
557
+ //The UNIX time when the app was created.
558
+ createTime?: string;
559
+ //
560
+ id?: string;
561
+ //
562
+ isShadow?: boolean;
563
+ //
564
+ role?: number;
565
+ //
566
+ token?: string;
567
+ }
568
+
569
+ /** A list of apps. */
570
+ export interface ApiAppList {
571
+ //A list of apps.
572
+ apps?: Array<ApiApp>;
573
+ //Next cursor.
574
+ nextCursor?: string;
575
+ //Approximate total number of apps.
576
+ totalCount?: number;
577
+ }
578
+
579
+ /** */
580
+ export interface ApiAuditLog {
581
+ //
582
+ actionLog?: string;
583
+ //
584
+ channelId?: string;
585
+ //
586
+ channelLabel?: string;
587
+ //
588
+ clanId?: string;
589
+ //
590
+ details?: string;
591
+ //
592
+ entityId?: string;
593
+ //
594
+ entityName?: string;
595
+ //
596
+ id?: string;
597
+ //
598
+ timeLog?: string;
599
+ //
600
+ userId?: string;
601
+ }
602
+
603
+ /** Authenticate against the server with email+password. */
604
+ export interface ApiAuthenticateSMSRequest {
605
+ //The email account details.
606
+ account?: ApiAccountSMS;
607
+ //Register the account if the user does not already exist.
608
+ create?: boolean;
609
+ //Set the username on the account at register. Must be unique.
610
+ username?: string;
611
+ }
612
+
613
+ /** Authenticate against the server with email+password. */
614
+ export interface ApiAuthenticateEmailRequest {
615
+ //The email account details.
616
+ account?: ApiAccountEmail;
617
+ //Register the account if the user does not already exist.
618
+ create?: boolean;
619
+ //Set the username on the account at register. Must be unique.
620
+ username?: string;
621
+ }
622
+
623
+ /** */
624
+ export interface ApiCategoryDesc {
625
+ //
626
+ categoryId?: string;
627
+ //
628
+ categoryName?: string;
629
+ //
630
+ categoryOrder?: number;
631
+ //
632
+ clanId?: string;
633
+ //
634
+ creatorId?: string;
635
+ }
636
+
637
+ /** */
638
+ export interface ApiCategoryDescList {
639
+ //A list of channel.
640
+ categorydesc?: Array<ApiCategoryDesc>;
641
+ }
642
+
643
+ /** */
644
+ export interface ApiUpdateUsernameRequest {
645
+ //
646
+ username?: string;
647
+ }
648
+
649
+ /** */
650
+ export interface ApiCategoryOrderUpdate {
651
+ //
652
+ categoryId?: string;
653
+ //
654
+ order?: number;
655
+ }
656
+
657
+ /** */
658
+ export interface ApiChanEncryptionMethod {
659
+ //
660
+ channelId?: string;
661
+ //
662
+ method?: string;
663
+ }
664
+
665
+ export interface ApiListChannelAppsResponse {
666
+ //
667
+ channelApps?: Array<ApiChannelAppResponse>;
668
+ }
669
+
670
+ /** Update fields in a given channel. */
671
+ export interface ApiChangeChannelPrivateRequest {
672
+ //The clan id
673
+ clanId?: string;
674
+ //The ID of the channel to update.
675
+ channelId?: string;
676
+ //
677
+ channelPrivate?: number;
678
+ //
679
+ roleIds?: Array<string>;
680
+ //The users to add.
681
+ userIds?: Array<string>;
682
+ }
683
+
684
+ /** */
685
+ export interface ApiChannelAppResponse {
686
+ //
687
+ appId?: string;
688
+ //
689
+ channelId?: string;
690
+ //
691
+ clanId?: string;
692
+ //
693
+ id?: string;
694
+ //
695
+ appUrl?: string;
696
+ //
697
+ appName?: string;
698
+ //
699
+ appLogo?: string;
700
+ }
701
+
702
+ /** */
703
+ export interface ApiChannelAttachment {
704
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was created.
705
+ createTime?: string;
706
+ //
707
+ filename?: string;
708
+ //
709
+ filesize?: string;
710
+ //
711
+ filetype?: string;
712
+ //
713
+ id?: string;
714
+ //
715
+ uploader?: string;
716
+ //
717
+ url?: string;
718
+ //message id.
719
+ messageId?: string;
720
+ //width.
721
+ width?: number;
722
+ //height.
723
+ height?: number;
724
+ }
725
+
726
+ /** */
727
+ export interface ApiChannelAttachmentList {
728
+ //
729
+ attachments?: Array<ApiChannelAttachment>;
730
+ }
731
+
732
+ /** */
733
+ export interface ApiChannelCanvasDetailResponse {
734
+ //
735
+ content?: string;
736
+ //
737
+ creatorId?: string;
738
+ //
739
+ editorId?: string;
740
+ //
741
+ id?: string;
742
+ //
743
+ isDefault?: boolean;
744
+ //
745
+ title?: string;
746
+ }
747
+
748
+ /** */
749
+ export interface ApiChannelCanvasItem {
750
+ //
751
+ content?: string;
752
+ //
753
+ creatorId?: string;
754
+ //
755
+ id?: string;
756
+ //
757
+ isDefault?: boolean;
758
+ //
759
+ title?: string;
760
+ // update time
761
+ updateTime?: string;
762
+ // create time
763
+ createTime?: string;
764
+ }
765
+
766
+ /** */
767
+ export interface ApiChannelCanvasListResponse {
768
+ //
769
+ channelCanvases?: Array<ApiChannelCanvasItem>;
770
+ //
771
+ channelId?: string;
772
+ //
773
+ clanId?: string;
774
+ //
775
+ count?: number;
776
+ }
777
+
778
+ /** */
779
+ export interface ApiEditChannelCanvasRequest {
780
+ //
781
+ channelId?: string;
782
+ //
783
+ clanId?: string;
784
+ //
785
+ content?: string;
786
+ //
787
+ id?: string;
788
+ //
789
+ isDefault?: boolean;
790
+ //
791
+ title?: string;
792
+ //
793
+ status?: number;
794
+ }
795
+
796
+ /** */
797
+ export interface ApiEditChannelCanvasResponse {
798
+ //
799
+ id?: string;
800
+ }
801
+
802
+ /** A list of channel description, usually a result of a list operation. */
803
+ export interface ApiChannelDescList {
804
+ //Cacheable cursor to list newer channel description. Durable and designed to be stored, unlike next/prev cursors.
805
+ cacheableCursor?: string;
806
+ //A list of channel.
807
+ channeldesc?: Array<ApiChannelDescription>;
808
+ //The cursor to send when retrieving the next page, if any.
809
+ nextCursor?: string;
810
+ //
811
+ page?: number;
812
+ //The cursor to send when retrieving the previous page, if any.
813
+ prevCursor?: string;
814
+ }
815
+
816
+ /** */
817
+ export interface ApiAddChannelAppRequest {
818
+ //App url.
819
+ appUrl?: string;
820
+ //The appname.
821
+ appname?: string;
822
+ //Creator of the app.
823
+ creatorId?: string;
824
+ //Role of this app.
825
+ role?: number;
826
+ //The password.
827
+ token?: string;
828
+ }
829
+
830
+ /** */
831
+ export interface ApiChannelDescription {
832
+ //
833
+ active?: number;
834
+ //
835
+ ageRestricted?: number;
836
+ //
837
+ categoryId?: string;
838
+ //
839
+ categoryName?: string;
840
+ //The channel this message belongs to.
841
+ channelId?: string;
842
+ //
843
+ channelLabel?: string;
844
+ //
845
+ channelPrivate?: number;
846
+ //
847
+ clanId?: string;
848
+ //
849
+ clanName?: string;
850
+ //
851
+ countMessUnread?: number;
852
+ //
853
+ createTimeSeconds?: number;
854
+ //creator ID.
855
+ creatorId?: string;
856
+ //
857
+ creatorName?: string;
858
+ //
859
+ e2ee?: number;
860
+ //
861
+ isMute?: boolean;
862
+ //
863
+ lastPinMessage?: string;
864
+ //
865
+ lastSeenMessage?: ApiChannelMessageHeader;
866
+ //
867
+ lastSentMessage?: ApiChannelMessageHeader;
868
+ //
869
+ meetingCode?: string;
870
+ //
871
+ channelAvatar?: string;
872
+ //The parent channel this message belongs to.
873
+ parentId?: string;
874
+ //The channel type.
875
+ type?: number;
876
+ //
877
+ updateTimeSeconds?: number;
878
+ //
879
+ appId?: string;
880
+ //
881
+ topic?: string;
882
+ //
883
+ userIds?: Array<string>;
884
+ //
885
+ usernames?: Array<string>;
886
+ //
887
+ displayNames?: Array<string>;
888
+ //
889
+ onlines?: Array<boolean>;
890
+ // DM status
891
+ avatars?: Array<string>;
892
+ // member count
893
+ memberCount?: number;
894
+ }
895
+
896
+ /** A message sent on a channel. */
897
+ export interface ApiChannelMessage {
898
+ // id
899
+ id: string;
900
+ //
901
+ attachments?: string;
902
+ //
903
+ avatar?: string;
904
+ //
905
+ categoryName?: string;
906
+ //The channel this message belongs to.
907
+ channelId: string;
908
+ //The name of the chat room, or an empty string if this message was not sent through a chat room.
909
+ channelLabel: string;
910
+ //The clan this message belong to.
911
+ clanId?: string;
912
+ //
913
+ clanLogo?: string;
914
+ //
915
+ clanNick?: string;
916
+ //
917
+ clanAvatar?: string;
918
+ //The code representing a message type or category.
919
+ code: number;
920
+ //The content payload.
921
+ content: string;
922
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was created.
923
+ createTime?: string;
924
+ //
925
+ createTimeSeconds?: number;
926
+ //
927
+ displayName?: string;
928
+ //
929
+ mentions?: string;
930
+ //The unique ID of this message.
931
+ messageId: string;
932
+ //
933
+ reactions?: string;
934
+ //
935
+ referencedMessage?: string;
936
+ //
937
+ references?: string;
938
+ //Message sender, usually a user ID.
939
+ senderId: string;
940
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was last updated.
941
+ updateTime?: string;
942
+ //
943
+ updateTimeSeconds?: number;
944
+ //The username of the message sender, if any.
945
+ username?: string;
946
+ // channel mode
947
+ mode?: number;
948
+ // hide editted
949
+ hideEditted?: boolean;
950
+ //
951
+ topicId?: string;
952
+ }
953
+
954
+ /** */
955
+ export interface ApiChannelMessageHeader {
956
+ //
957
+ attachment?: string;
958
+ //
959
+ content?: string;
960
+ //
961
+ id?: string;
962
+ //
963
+ mention?: string;
964
+ //
965
+ reaction?: string;
966
+ //
967
+ reference?: string;
968
+ //
969
+ repliers?: Array<string>;
970
+ //
971
+ senderId?: string;
972
+ //
973
+ timestampSeconds?: number;
974
+ }
975
+
976
+ /** A list of channel messages, usually a result of a list operation. */
977
+ export interface ApiChannelMessageList {
978
+ //
979
+ lastSeenMessage?: ApiChannelMessageHeader;
980
+ //
981
+ lastSentMessage?: ApiChannelMessageHeader;
982
+ //A list of messages.
983
+ messages?: Array<ApiChannelMessage>;
984
+ }
985
+
986
+ /** */
987
+ export interface ApiChannelSettingItem {
988
+ //
989
+ active?: number;
990
+ //
991
+ categoryId?: string;
992
+ //
993
+ channelLabel?: string;
994
+ //
995
+ channelPrivate?: number;
996
+ //
997
+ channelType?: number;
998
+ //
999
+ creatorId?: string;
1000
+ //
1001
+ id?: string;
1002
+ //
1003
+ lastSentMessage?: ApiChannelMessageHeader;
1004
+ //
1005
+ meetingCode?: string;
1006
+ //
1007
+ messageCount?: string;
1008
+ //
1009
+ parentId?: string;
1010
+ //
1011
+ userIds?: Array<string>;
1012
+ }
1013
+
1014
+ /** */
1015
+ export interface ApiChannelSettingListResponse {
1016
+ //
1017
+ channelCount?: number;
1018
+ //
1019
+ channelSettingList?: Array<ApiChannelSettingItem>;
1020
+ //
1021
+ clanId?: string;
1022
+ //
1023
+ threadCount?: number;
1024
+ }
1025
+
1026
+ /** A list of users belonging to a channel, along with their role. */
1027
+ export interface ApiChannelUserList {
1028
+ //
1029
+ channelId?: string;
1030
+ //User-role pairs for a channel.
1031
+ channelUsers?: Array<ChannelUserListChannelUser>;
1032
+ //Cursor for the next page of results, if any.
1033
+ cursor?: string;
1034
+ }
1035
+
1036
+ /** */
1037
+ export interface ApiCheckDuplicateClanNameResponse {
1038
+ //
1039
+ isDuplicate?: boolean;
1040
+ }
1041
+
1042
+ /** */
1043
+ export interface ApiClanDesc {
1044
+ //
1045
+ banner?: string;
1046
+ //
1047
+ clanId?: string;
1048
+ //
1049
+ clanName?: string;
1050
+ //
1051
+ creatorId?: string;
1052
+ //
1053
+ logo?: string;
1054
+ //
1055
+ status?: number;
1056
+ //
1057
+ badgeCount?: number;
1058
+ // is onboarding.
1059
+ isOnboarding?: boolean;
1060
+ // welcome channel id.
1061
+ welcomeChannelId?: string;
1062
+ //Onboarding_banner.
1063
+ onboardingBanner?: string;
1064
+ // is community.
1065
+ isCommunity?: boolean;
1066
+ // community banner
1067
+ communityBanner?: string;
1068
+ // description
1069
+ description?: string;
1070
+ // about
1071
+ about?: string;
1072
+ // short url for community
1073
+ shortUrl?: string;
1074
+ // prevent anonymous
1075
+ preventAnonymous?: boolean;
1076
+ // has unread message
1077
+ hasUnreadMessage?: boolean;
1078
+ }
1079
+
1080
+ /** */
1081
+ export interface ApiClanDescList {
1082
+ //A list of channel.
1083
+ clandesc?: Array<ApiClanDesc>;
1084
+ }
1085
+
1086
+ /** */
1087
+ export interface ApiClanEmoji {
1088
+ //
1089
+ category?: string;
1090
+ //
1091
+ clanId?: string;
1092
+ //
1093
+ clanName?: string;
1094
+ //
1095
+ creatorId?: string;
1096
+ //
1097
+ id?: string;
1098
+ //
1099
+ logo?: string;
1100
+ //
1101
+ shortname?: string;
1102
+ //
1103
+ src?: string;
1104
+ //
1105
+ isForSale?: boolean;
1106
+ }
1107
+
1108
+ /** */
1109
+ export interface ApiClanEmojiCreateRequest {
1110
+ //
1111
+ category?: string;
1112
+ //
1113
+ clanId?: string;
1114
+ //
1115
+ id?: string;
1116
+ //
1117
+ shortname?: string;
1118
+ //
1119
+ source?: string;
1120
+ //
1121
+ isForSale?: boolean;
1122
+ }
1123
+
1124
+ /** Get clan profile. */
1125
+ export interface ApiClanProfile {
1126
+ //
1127
+ avatar?: string;
1128
+ //
1129
+ clanId?: string;
1130
+ //
1131
+ nickName?: string;
1132
+ //
1133
+ userId?: string;
1134
+ //
1135
+ about?: string;
1136
+ }
1137
+
1138
+ /** */
1139
+ export interface ApiClanSticker {
1140
+ //
1141
+ category?: string;
1142
+ //
1143
+ clanId?: string;
1144
+ //
1145
+ clanName?: string;
1146
+ //
1147
+ createTime?: string;
1148
+ //
1149
+ creatorId?: string;
1150
+ //
1151
+ id?: string;
1152
+ //
1153
+ logo?: string;
1154
+ //
1155
+ shortname?: string;
1156
+ //
1157
+ source?: string;
1158
+ //
1159
+ mediaType?: number;
1160
+ //
1161
+ isForSale?: boolean;
1162
+ }
1163
+
1164
+ /** */
1165
+ export interface ApiClanStickerAddRequest {
1166
+ //
1167
+ category?: string;
1168
+ //
1169
+ clanId?: string;
1170
+ //
1171
+ id?: string;
1172
+ //
1173
+ shortname?: string;
1174
+ //
1175
+ source?: string;
1176
+ //
1177
+ mediaType?: number;
1178
+ //
1179
+ isForSale?: boolean;
1180
+ }
1181
+
1182
+ /** A list of users belonging to a clan, along with their role. */
1183
+ export interface ApiClanUserList {
1184
+ //
1185
+ clanId?: string;
1186
+ //User-role pairs for a clan.
1187
+ clanUsers?: Array<ClanUserListClanUser>;
1188
+ //Cursor for the next page of results, if any.
1189
+ cursor?: string;
1190
+ }
1191
+
1192
+ /** */
1193
+ export interface ApiConfirmLoginRequest {
1194
+ //Whether to enable "Remember Me" for extended session duration.
1195
+ isRemember?: boolean;
1196
+ //
1197
+ loginId?: string;
1198
+ }
1199
+
1200
+ /** */
1201
+ export interface ApiCreateActivityRequest {
1202
+ //
1203
+ activityDescription?: string;
1204
+ //
1205
+ activityName?: string;
1206
+ //
1207
+ activityType?: number;
1208
+ //
1209
+ applicationId?: string;
1210
+ //
1211
+ startTime?: string;
1212
+ //
1213
+ status?: number;
1214
+ }
1215
+
1216
+ /** */
1217
+ export interface ApiCreateCategoryDescRequest {
1218
+ //
1219
+ categoryName?: string;
1220
+ //
1221
+ clanId?: string;
1222
+ }
1223
+
1224
+ /** Create a channel within clan. */
1225
+ export interface ApiCreateChannelDescRequest {
1226
+ //
1227
+ appId?: string;
1228
+ //
1229
+ categoryId?: string;
1230
+ //The channel this message belongs to.
1231
+ channelId?: string;
1232
+ //
1233
+ channelLabel?: string;
1234
+ //
1235
+ channelPrivate?: number;
1236
+ //
1237
+ clanId?: string;
1238
+ //The parent channel this message belongs to.
1239
+ parentId?: string;
1240
+ //The channel type.
1241
+ type?: number;
1242
+ //The users to add.
1243
+ userIds?: Array<string>;
1244
+ }
1245
+
1246
+ /** */
1247
+ export interface ApiCreateClanDescRequest {
1248
+ //
1249
+ banner?: string;
1250
+ //
1251
+ clanName?: string;
1252
+ //
1253
+ creatorId?: string;
1254
+ //
1255
+ logo?: string;
1256
+ }
1257
+
1258
+ /** Create a event within clan. */
1259
+ export interface ApiCreateEventRequest {
1260
+ //
1261
+ address?: string;
1262
+ //
1263
+ channelVoiceId?: string;
1264
+ //
1265
+ clanId?: string;
1266
+ //
1267
+ description?: string;
1268
+ //
1269
+ endTime?: string;
1270
+ //
1271
+ logo?: string;
1272
+ //
1273
+ startTime?: string;
1274
+ //
1275
+ title?: string;
1276
+ //
1277
+ channelId?: string;
1278
+ //
1279
+ action?: number;
1280
+ //
1281
+ eventStatus?: number;
1282
+ //
1283
+ repeatType?: number;
1284
+ //
1285
+ creatorId?: number;
1286
+ //
1287
+ userId?: string;
1288
+ //
1289
+ isPrivate?: boolean;
1290
+ //
1291
+ meetRoom?: ApiGenerateMezonMeetResponse;
1292
+ }
1293
+
1294
+ /** Create a event within clan. */
1295
+ export interface ApiUpdateEventRequest {
1296
+ //
1297
+ address?: string;
1298
+ //
1299
+ channelId?: string;
1300
+ //
1301
+ eventId?: string;
1302
+ //
1303
+ description?: string;
1304
+ //
1305
+ endTime?: string;
1306
+ //
1307
+ logo?: string;
1308
+ //
1309
+ startTime?: string;
1310
+ //
1311
+ title?: string;
1312
+ //
1313
+ clanId?: string;
1314
+ }
1315
+
1316
+ /** Create a role within clan. */
1317
+ export interface ApiCreateRoleRequest {
1318
+ //The permissions to add.
1319
+ activePermissionIds?: Array<string>;
1320
+ //The users to add.
1321
+ addUserIds?: Array<string>;
1322
+ //
1323
+ allowMention?: number;
1324
+ //
1325
+ clanId?: string;
1326
+ //
1327
+ color?: string;
1328
+ //
1329
+ description?: string;
1330
+ //
1331
+ displayOnline?: number;
1332
+ //
1333
+ maxPermissionId: string;
1334
+ //
1335
+ roleIcon?: string;
1336
+ //
1337
+ title?: string;
1338
+ //
1339
+ orderRole?: number;
1340
+ }
1341
+
1342
+ /** Delete a channel the user has access to. */
1343
+ export interface ApiDeleteChannelDescRequest {
1344
+ //The clan id
1345
+ clanId?: string;
1346
+ //The id of a channel.
1347
+ channelId?: string;
1348
+ }
1349
+
1350
+ /** */
1351
+ export interface ApiDeleteEventRequest {
1352
+ //
1353
+ channelId?: string;
1354
+ //
1355
+ clanId?: string;
1356
+ //
1357
+ creatorId?: string;
1358
+ //The id of a event.
1359
+ eventId?: string;
1360
+ //
1361
+ eventLabel?: string;
1362
+ }
1363
+
1364
+ /** Delete a role the user has access to. */
1365
+ export interface ApiDeleteRoleRequest {
1366
+ //
1367
+ channelId?: string;
1368
+ //
1369
+ clanId?: string;
1370
+ //The id of a role.
1371
+ roleId?: string;
1372
+ //
1373
+ roleLabel?: string;
1374
+ }
1375
+
1376
+ /** Storage objects to delete. */
1377
+ export interface ApiDeleteStorageObjectId {
1378
+ //The collection which stores the object.
1379
+ collection?: string;
1380
+ //The key of the object within the collection.
1381
+ key?: string;
1382
+ //The version hash of the object.
1383
+ version?: string;
1384
+ }
1385
+
1386
+ /** Batch delete storage objects. */
1387
+ export interface ApiDeleteStorageObjectsRequest {
1388
+ //Batch of storage objects.
1389
+ objectIds?: Array<ApiDeleteStorageObjectId>;
1390
+ }
1391
+
1392
+ /** Represents an event to be passed through the server to registered event handlers. */
1393
+ export interface ApiEvent {
1394
+ //True if the event came directly from a client call, false otherwise.
1395
+ external?: boolean;
1396
+ //An event name, type, category, or identifier.
1397
+ name?: string;
1398
+ //Arbitrary event property values.
1399
+ properties?: Record<string, string>;
1400
+ //The time when the event was triggered.
1401
+ timestamp?: string;
1402
+ }
1403
+
1404
+ /** */
1405
+ export interface ApiRegisterStreamingChannelRequest {
1406
+ //
1407
+ channelId?: string;
1408
+ //
1409
+ clanId?: string;
1410
+ }
1411
+
1412
+ /** */
1413
+ export interface ApiRegisterStreamingChannelResponse {
1414
+ //
1415
+ channelId?: string;
1416
+ //
1417
+ clanId?: string;
1418
+ //
1419
+ streamingUrl?: string;
1420
+ }
1421
+
1422
+ /** */
1423
+ export interface ApiListStreamingChannelsResponse {
1424
+ //
1425
+ streamingChannels?: Array<ApiStreamingChannelResponse>;
1426
+ }
1427
+
1428
+ export interface ApiEmojiListedResponse {
1429
+ //
1430
+ emojiList?: Array<ApiClanEmoji>;
1431
+ }
1432
+
1433
+ /** */
1434
+ export interface ApiEmojiRecent {
1435
+ //ID of the emoji.
1436
+ emojiRecentsId?: string;
1437
+ //
1438
+ emojiId?: string;
1439
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the emoji was created.
1440
+ updateTime?: string;
1441
+ }
1442
+
1443
+ export interface ApiAddFriendsResponse {
1444
+ ids?: Array<string>;
1445
+ usernames?: Array<string>;
1446
+ }
1447
+
1448
+ /** */
1449
+ export interface ApiEventList {
1450
+ //A list of event.
1451
+ events?: Array<ApiEventManagement>;
1452
+ }
1453
+
1454
+ /** */
1455
+ export interface ApiEventManagement {
1456
+ //
1457
+ active?: number;
1458
+ //
1459
+ address?: string;
1460
+ //
1461
+ channelVoiceId?: string;
1462
+ //
1463
+ clanId?: string;
1464
+ //
1465
+ creatorId?: string;
1466
+ //
1467
+ description?: string;
1468
+ //
1469
+ endTime?: string;
1470
+ //
1471
+ id?: string;
1472
+ //
1473
+ logo?: string;
1474
+ //
1475
+ maxPermission?: number;
1476
+ //
1477
+ startEvent?: number;
1478
+ //
1479
+ startTime?: string;
1480
+ //
1481
+ title?: string;
1482
+ //
1483
+ userIds?: Array<string>;
1484
+ //
1485
+ createTime?: string;
1486
+ //
1487
+ channelId?: string;
1488
+ //
1489
+ eventStatus?: number;
1490
+ //
1491
+ repeatType?: number;
1492
+ //
1493
+ isPrivate?: boolean;
1494
+ //
1495
+ meetRoom?: ApiGenerateMezonMeetResponse;
1496
+ }
1497
+
1498
+ /** */
1499
+ export interface ApiListFavoriteChannelResponse {
1500
+ //
1501
+ channelIds?: Array<string>;
1502
+ }
1503
+
1504
+ /** */
1505
+ export interface ApiFilterParam {
1506
+ //
1507
+ fieldName?: string;
1508
+ //
1509
+ fieldValue?: string;
1510
+ }
1511
+
1512
+ /** A friend of a user. */
1513
+ export interface ApiFriend {
1514
+ //The friend status. one of "Friend.State".
1515
+ state?: number;
1516
+ //Time of the latest relationship update.
1517
+ updateTime?: string;
1518
+ //The user object.
1519
+ user?: ApiUser;
1520
+ //Source ID
1521
+ sourceId?: string;
1522
+ }
1523
+
1524
+ /** A collection of zero or more friends of the user. */
1525
+ export interface ApiFriendList {
1526
+ //Cursor for the next page of results, if any.
1527
+ cursor?: string;
1528
+ //The Friend objects.
1529
+ friends?: Array<ApiFriend>;
1530
+ }
1531
+
1532
+ /** */
1533
+ export interface ApiGetKeyServerResp {
1534
+ //
1535
+ url?: string;
1536
+ }
1537
+
1538
+ /** */
1539
+ export interface ApiGenerateMezonMeetResponse {
1540
+ //
1541
+ meetId?: string;
1542
+ //
1543
+ roomName?: string;
1544
+ //
1545
+ externalLink?: string;
1546
+ //
1547
+ creatorId?: string;
1548
+ //
1549
+ eventId?: string;
1550
+ }
1551
+
1552
+ /** */
1553
+ export interface ApiGenerateMeetTokenExternalResponse {
1554
+ //
1555
+ guestUserId?: string;
1556
+ //
1557
+ token?: string;
1558
+ //
1559
+ guestAccessToken?: string;
1560
+ }
1561
+
1562
+ /** */
1563
+ export interface ApiMeetParticipantRequest {
1564
+ //
1565
+ roomName?: string;
1566
+ //
1567
+ username?: string;
1568
+ //
1569
+ channelId?: string;
1570
+ //
1571
+ clanId?: string;
1572
+ }
1573
+
1574
+ /** */
1575
+ export interface ApiGetPubKeysResponse {
1576
+ //
1577
+ pubKeys?: Array<GetPubKeysResponseUserPubKey>;
1578
+ }
1579
+
1580
+ /** */
1581
+ export interface ApiGiveCoffeeEvent {
1582
+ //
1583
+ channelId?: string;
1584
+ //
1585
+ clanId?: string;
1586
+ //
1587
+ messageRefId?: string;
1588
+ //
1589
+ receiverId?: string;
1590
+ //
1591
+ senderId?: string;
1592
+ //
1593
+ tokenCount?: number;
1594
+ }
1595
+
1596
+ /** */
1597
+ export interface ApiHashtagDm {
1598
+ //The channel id.
1599
+ channelId?: string;
1600
+ //
1601
+ channelLabel?: string;
1602
+ //
1603
+ channelPrivate?: number;
1604
+ //
1605
+ clanId?: string;
1606
+ //
1607
+ clanName?: string;
1608
+ //
1609
+ meetingCode?: string;
1610
+ //
1611
+ parentId?: string;
1612
+ //
1613
+ type?: number;
1614
+ }
1615
+
1616
+ /** */
1617
+ export interface ApiHashtagDmList {
1618
+ //
1619
+ hashtagDm?: Array<ApiHashtagDm>;
1620
+ }
1621
+
1622
+ /** Add link invite users to. */
1623
+ export interface ApiInviteUserRes {
1624
+ //
1625
+ channelDesc?: ApiChannelDescription;
1626
+ //id channel to add link to.
1627
+ channelId?: string;
1628
+ //
1629
+ channelLabel?: string;
1630
+ //id clan to add link to .
1631
+ clanId?: string;
1632
+ //
1633
+ clanName?: string;
1634
+ //
1635
+ userJoined?: boolean;
1636
+ //
1637
+ expiryTime?: string;
1638
+ //
1639
+ clanLogo: string;
1640
+ //
1641
+ memberCount: number;
1642
+ }
1643
+
1644
+ /** Add link invite users to. */
1645
+ export interface ApiLinkInviteUser {
1646
+ //
1647
+ channelId?: string;
1648
+ //
1649
+ clanId?: string;
1650
+ //
1651
+ createTime?: string;
1652
+ //The user to add.
1653
+ creatorId?: string;
1654
+ //
1655
+ expiryTime?: string;
1656
+ //
1657
+ id?: string;
1658
+ //
1659
+ inviteLink?: string;
1660
+ }
1661
+
1662
+ /** Add link invite users to. */
1663
+ export interface ApiLinkInviteUserRequest {
1664
+ //id channel to add link to.
1665
+ channelId?: string;
1666
+ //id clan to add link to .
1667
+ clanId?: string;
1668
+ //
1669
+ expiryTime?: number;
1670
+ }
1671
+
1672
+ export interface ApiNotifiReactMessage {
1673
+ //
1674
+ channelId?: string;
1675
+ //
1676
+ id?: string;
1677
+ //
1678
+ userId?: string;
1679
+ }
1680
+
1681
+ /** */
1682
+ export interface ApiMessage2InboxRequest {
1683
+ //
1684
+ attachments?: string;
1685
+ //
1686
+ avatar?: string;
1687
+ //
1688
+ channelId?: string;
1689
+ //
1690
+ clanId?: string;
1691
+ //
1692
+ content?: string;
1693
+ //
1694
+ mentions?: string;
1695
+ //
1696
+ messageId?: string;
1697
+ //
1698
+ reactions?: string;
1699
+ //
1700
+ references?: string;
1701
+ }
1702
+
1703
+ /** */
1704
+ export interface ApiMessageAttachment {
1705
+ //
1706
+ filename?: string;
1707
+ //
1708
+ filetype?: string;
1709
+ //
1710
+ height?: number;
1711
+ //
1712
+ size?: number;
1713
+ //
1714
+ url?: string;
1715
+ //
1716
+ width?: number;
1717
+ //
1718
+ thumbnail?: string;
1719
+ // The channel this message belongs to.
1720
+ channelId?: string;
1721
+ // The mode
1722
+ mode?: number;
1723
+ // The channel label
1724
+ channelLabel?: string;
1725
+ // The message that user react
1726
+ messageId?: string;
1727
+ // Message sender, usually a user ID.
1728
+ senderId?: string;
1729
+ // duration for video in seconds
1730
+ duration?: number;
1731
+ }
1732
+
1733
+ /** */
1734
+ export interface ApiMessageDeleted {
1735
+ //
1736
+ deletor?: string;
1737
+ //
1738
+ messageId?: string;
1739
+ }
1740
+
1741
+ /** */
1742
+ export interface ApiListUserActivity {
1743
+ //
1744
+ activities?: Array<ApiUserActivity>;
1745
+ }
1746
+ /** */
1747
+ export interface ApiLoginIDResponse {
1748
+ //
1749
+ address?: string;
1750
+ //
1751
+ createTimeSecond?: string;
1752
+ //
1753
+ loginId?: string;
1754
+ //
1755
+ platform?: string;
1756
+ //
1757
+ status?: number;
1758
+ //
1759
+ userId?: string;
1760
+ //
1761
+ username?: string;
1762
+ }
1763
+
1764
+ /** */
1765
+ export interface ApiMarkAsReadRequest {
1766
+ //
1767
+ categoryId?: string;
1768
+ //
1769
+ channelId?: string;
1770
+ //
1771
+ clanId?: string;
1772
+ }
1773
+
1774
+ /** */
1775
+ export interface ApiMessageMention {
1776
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was created.
1777
+ createTime?: string;
1778
+ //
1779
+ id?: string;
1780
+ //
1781
+ userId?: string;
1782
+ //
1783
+ username?: string;
1784
+ // role id
1785
+ roleId?: string;
1786
+ // role name
1787
+ rolename?: string;
1788
+ // start position
1789
+ s?: number;
1790
+ // end position
1791
+ e?: number;
1792
+ /** The channel this message belongs to. */
1793
+ channelId?: string;
1794
+ // The mode
1795
+ mode?: number;
1796
+ // The channel label
1797
+ channelLabel?: string;
1798
+ /** The message that user react */
1799
+ messageId?: string;
1800
+ /** Message sender, usually a user ID. */
1801
+ senderId?: string;
1802
+ }
1803
+
1804
+ /** */
1805
+ export interface ApiLoginRequest {
1806
+ //
1807
+ address?: string;
1808
+ //
1809
+ platform?: string;
1810
+ }
1811
+
1812
+ /** */
1813
+ export interface ApiMessageReaction {
1814
+ //
1815
+ action?: boolean;
1816
+ //
1817
+ emojiId: string;
1818
+ //
1819
+ emoji: string;
1820
+ //
1821
+ id?: string;
1822
+ //
1823
+ senderId?: string;
1824
+ //
1825
+ senderName?: string;
1826
+ //
1827
+ senderAvatar?: string;
1828
+ // count of emoji
1829
+ count: number;
1830
+ /** The channel this message belongs to. */
1831
+ channelId: string;
1832
+ // The mode
1833
+ mode: number;
1834
+ // Is public
1835
+ isPublic: boolean;
1836
+ // The channel label
1837
+ channelLabel: string;
1838
+ /** The message that user react */
1839
+ messageId: string;
1840
+ //
1841
+ topicId?: string;
1842
+ //
1843
+ emojiRecentId?: string;
1844
+ }
1845
+
1846
+ export interface ApiListChannelAppsResponse {
1847
+ //
1848
+ channelApps?: Array<ApiChannelAppResponse>;
1849
+ }
1850
+
1851
+ /** */
1852
+ export interface ApiListStreamingChannelsResponse {
1853
+ //
1854
+ streamingChannels?: Array<ApiStreamingChannelResponse>;
1855
+ }
1856
+
1857
+ /** */
1858
+ export interface ApiMezonOauthClient {
1859
+ //
1860
+ accessTokenStrategy?: string;
1861
+ //
1862
+ allowedCorsOrigins?: Array<string>;
1863
+ //
1864
+ audience?: Array<string>;
1865
+ //
1866
+ authorizationCodeGrantAccessTokenLifespan?: string;
1867
+ //
1868
+ authorizationCodeGrantIdTokenLifespan?: string;
1869
+ //
1870
+ authorizationCodeGrantRefreshTokenLifespan?: string;
1871
+ //
1872
+ backchannelLogoutSessionRequired?: boolean;
1873
+ //
1874
+ backchannelLogoutUri?: string;
1875
+ //
1876
+ clientCredentialsGrantAccessTokenLifespan?: string;
1877
+ //
1878
+ clientId?: string;
1879
+ //
1880
+ clientName?: string;
1881
+ //
1882
+ clientSecret?: string;
1883
+ //
1884
+ clientSecretExpiresAt?: number;
1885
+ //
1886
+ clientUri?: string;
1887
+ //
1888
+ contacts?: Array<string>;
1889
+ //
1890
+ createdAt?: string;
1891
+ //
1892
+ frontchannelLogoutSessionRequired?: boolean;
1893
+ //
1894
+ frontchannelLogoutUri?: string;
1895
+ //
1896
+ grantTypes?: Array<string>;
1897
+ //
1898
+ implicitGrantAccessTokenLifespan?: string;
1899
+ //
1900
+ implicitGrantIdTokenLifespan?: string;
1901
+ //
1902
+ jwks?: Array<string>;
1903
+ //
1904
+ jwksUri?: string;
1905
+ //
1906
+ jwtBearerGrantAccessTokenLifespan?: string;
1907
+ //
1908
+ logoUri?: string;
1909
+ //
1910
+ owner?: string;
1911
+ //
1912
+ policyUri?: string;
1913
+ //
1914
+ postLogoutRedirectUris?: Array<string>;
1915
+ //
1916
+ redirectUris?: Array<string>;
1917
+ //
1918
+ refreshTokenGrantAccessTokenLifespan?: string;
1919
+ //
1920
+ refreshTokenGrantIdTokenLifespan?: string;
1921
+ //
1922
+ refreshTokenGrantRefreshTokenLifespan?: string;
1923
+ //
1924
+ registrationAccessToken?: string;
1925
+ //
1926
+ registrationClientUri?: string;
1927
+ //
1928
+ requestObjectSigningAlg?: string;
1929
+ //
1930
+ requestUris?: Array<string>;
1931
+ //
1932
+ responseTypes?: Array<string>;
1933
+ //
1934
+ scope?: string;
1935
+ //
1936
+ sectorIdentifierUri?: string;
1937
+ //
1938
+ skipConsent?: boolean;
1939
+ //
1940
+ skipLogoutConsent?: boolean;
1941
+ //
1942
+ subjectType?: string;
1943
+ //
1944
+ tokenEndpointAuthMethod?: string;
1945
+ //
1946
+ tokenEndpointAuthSigningAlg?: string;
1947
+ //
1948
+ tosUri?: string;
1949
+ //
1950
+ updatedAt?: string;
1951
+ //
1952
+ userinfoSignedResponseAlg?: string;
1953
+ }
1954
+
1955
+ /** */
1956
+ export interface ApiMezonOauthClientList {
1957
+ //
1958
+ listMezonOauthClient?: Array<ApiMezonOauthClient>;
1959
+ }
1960
+
1961
+ /** */
1962
+ export interface ApiMessageRef {
1963
+ //
1964
+ messageId?: string;
1965
+ //
1966
+ messageRefId?: string;
1967
+ //
1968
+ refType?: number;
1969
+ //
1970
+ messageSenderId?: string;
1971
+ // original message sendre username
1972
+ messageSenderUsername?: string;
1973
+ // original message sender avatar
1974
+ mesagesSenderAvatar?: string;
1975
+ // original sender clan nick name
1976
+ messageSenderClanNick?: string;
1977
+ // original sender display name
1978
+ messageSenderDisplayName?: string;
1979
+ //
1980
+ content?: string;
1981
+ //
1982
+ hasAttachment: boolean;
1983
+ /** The channel this message belongs to. */
1984
+ channelId: string;
1985
+ // The mode
1986
+ mode: number;
1987
+ // The channel label
1988
+ channelLabel: string;
1989
+ }
1990
+
1991
+ /** A notification in the server. */
1992
+ export interface ApiNotification {
1993
+ //
1994
+ avatarUrl?: string;
1995
+ //
1996
+ channelId?: string;
1997
+ //
1998
+ channelType?: number;
1999
+ //
2000
+ clanId?: string;
2001
+ //Category code for this notification.
2002
+ code?: number;
2003
+ //Content of the notification in JSON.
2004
+ content?: string;
2005
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the notification was created.
2006
+ createTime?: string;
2007
+ //ID of the Notification.
2008
+ id?: string;
2009
+ //True if this notification was persisted to the database.
2010
+ persistent?: boolean;
2011
+ //ID of the sender, if a user. Otherwise 'null'.
2012
+ senderId?: string;
2013
+ //Subject of the notification.
2014
+ subject?: string;
2015
+ //category.
2016
+ category?: number;
2017
+ //
2018
+ topicId?: string;
2019
+ //
2020
+ channel?: ApiChannelDescription;
2021
+ }
2022
+
2023
+ /** */
2024
+ export interface ApiNotificationChannel {
2025
+ //
2026
+ channelId?: string;
2027
+ }
2028
+
2029
+ /** */
2030
+ export interface ApiNotificationChannelCategorySetting {
2031
+ //
2032
+ action?: number;
2033
+ //
2034
+ channelCategoryLabel?: string;
2035
+ //
2036
+ channelCategoryTitle?: string;
2037
+ //
2038
+ id?: string;
2039
+ //
2040
+ notificationSettingType?: number;
2041
+ }
2042
+
2043
+ /** */
2044
+ export interface ApiNotificationChannelCategorySettingList {
2045
+ //
2046
+ notificationChannelCategorySettingsList?: Array<ApiNotificationChannelCategorySetting>;
2047
+ }
2048
+
2049
+ /** A collection of zero or more notifications. */
2050
+ export interface ApiNotificationList {
2051
+ //Use this cursor to paginate notifications. Cache this to catch up to new notifications.
2052
+ cacheableCursor?: string;
2053
+ //Collection of notifications.
2054
+ notifications?: Array<ApiNotification>;
2055
+ }
2056
+
2057
+ /** */
2058
+ export interface ApiNotificationSetting {
2059
+ //
2060
+ id?: string;
2061
+ //
2062
+ notificationSettingType?: number;
2063
+ }
2064
+
2065
+ /** */
2066
+ export interface ApiNotificationUserChannel {
2067
+ //
2068
+ active?: number;
2069
+ //
2070
+ id?: string;
2071
+ //
2072
+ notificationSettingType?: number;
2073
+ //
2074
+ timeMute?: string;
2075
+ //
2076
+ channelId?: string;
2077
+ }
2078
+
2079
+ /** */
2080
+ export interface ApiStreamHttpCallbackRequest {
2081
+ //
2082
+ action?: string;
2083
+ //
2084
+ app?: string;
2085
+ //
2086
+ clientId?: string;
2087
+ //
2088
+ ip?: string;
2089
+ //
2090
+ pageUrl?: string;
2091
+ //
2092
+ param?: string;
2093
+ //
2094
+ serverId?: string;
2095
+ //
2096
+ serviceId?: string;
2097
+ //
2098
+ stream?: string;
2099
+ //
2100
+ streamId?: string;
2101
+ //
2102
+ streamUrl?: string;
2103
+ //
2104
+ tcUrl?: string;
2105
+ //
2106
+ vhost?: string;
2107
+ }
2108
+
2109
+ /** */
2110
+ export interface ApiStreamHttpCallbackResponse {
2111
+ //
2112
+ code?: number;
2113
+ //
2114
+ msg?: string;
2115
+ }
2116
+
2117
+ /** */
2118
+ export interface ApiPermission {
2119
+ //
2120
+ active?: number;
2121
+ //
2122
+ description?: string;
2123
+ //
2124
+ id?: string;
2125
+ //
2126
+ level?: number;
2127
+ //
2128
+ scope?: number;
2129
+ //
2130
+ slug?: string;
2131
+ //
2132
+ title?: string;
2133
+ }
2134
+
2135
+ /** A list of permission description, usually a result of a list operation. */
2136
+ export interface ApiPermissionList {
2137
+ //
2138
+ maxLevelPermission?: number;
2139
+ //A list of permission.
2140
+ permissions?: Array<ApiPermission>;
2141
+ }
2142
+
2143
+ /** */
2144
+ export interface ApiPermissionRoleChannel {
2145
+ //
2146
+ active?: boolean;
2147
+ //
2148
+ permissionId?: string;
2149
+ }
2150
+
2151
+ /** */
2152
+ export interface ApiPermissionRoleChannelListEventResponse {
2153
+ //
2154
+ channelId?: string;
2155
+ //
2156
+ permissionRoleChannel?: Array<ApiPermissionRoleChannel>;
2157
+ //
2158
+ roleId?: string;
2159
+ //
2160
+ userId?: string;
2161
+ }
2162
+
2163
+ /** */
2164
+ export interface ApiPermissionUpdate {
2165
+ //
2166
+ permissionId?: string;
2167
+ //
2168
+ slug?: string;
2169
+ //
2170
+ type?: number;
2171
+ }
2172
+
2173
+ /** */
2174
+ export interface ApiPinMessage {
2175
+ //
2176
+ avatar?: string;
2177
+ //
2178
+ channelId?: string;
2179
+ //
2180
+ content?: string;
2181
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was created.
2182
+ createTime?: string;
2183
+ //
2184
+ createTimeSeconds?: number;
2185
+ //
2186
+ id?: string;
2187
+ //
2188
+ messageId?: string;
2189
+ //
2190
+ senderId?: string;
2191
+ //
2192
+ username?: string;
2193
+ //
2194
+ attachment?: string;
2195
+ }
2196
+
2197
+ /** */
2198
+ export interface ApiPinMessageRequest {
2199
+ //
2200
+ channelId?: string;
2201
+ //
2202
+ clanId?: string;
2203
+ //
2204
+ messageId?: string;
2205
+ }
2206
+
2207
+ /** */
2208
+ export interface ApiPinMessagesList {
2209
+ //
2210
+ pinMessagesList?: Array<ApiPinMessage>;
2211
+ }
2212
+
2213
+ /** */
2214
+ export interface ApiPubKey {
2215
+ //
2216
+ encr?: string;
2217
+ //
2218
+ sign?: string;
2219
+ }
2220
+
2221
+ /** */
2222
+ export interface ApiPushPubKeyRequest {
2223
+ //
2224
+ PK?: ApiPubKey;
2225
+ }
2226
+
2227
+ /** */
2228
+ export interface ApiRegistFcmDeviceTokenResponse {
2229
+ //
2230
+ deviceId?: string;
2231
+ //
2232
+ platform?: string;
2233
+ //
2234
+ token?: string;
2235
+ }
2236
+
2237
+ /** */
2238
+ export interface ApiRegisterStreamingChannelRequest {
2239
+ //
2240
+ channelId?: string;
2241
+ //
2242
+ clanId?: string;
2243
+ }
2244
+
2245
+ /** */
2246
+ export interface ApiRegisterStreamingChannelResponse {
2247
+ //
2248
+ channelId?: string;
2249
+ //
2250
+ clanId?: string;
2251
+ //
2252
+ streamingUrl?: string;
2253
+ }
2254
+
2255
+ /** Storage objects to get. */
2256
+ export interface ApiReadStorageObjectId {
2257
+ //The collection which stores the object.
2258
+ collection?: string;
2259
+ //The key of the object within the collection.
2260
+ key?: string;
2261
+ //The user owner of the object.
2262
+ userId?: string;
2263
+ }
2264
+
2265
+ /** Batch get storage objects. */
2266
+ export interface ApiReadStorageObjectsRequest {
2267
+ //Batch of storage objects.
2268
+ objectIds?: Array<ApiReadStorageObjectId>;
2269
+ }
2270
+
2271
+ /** */
2272
+ export interface ApiRegistrationEmailRequest {
2273
+ //
2274
+ avatarUrl?: string;
2275
+ //
2276
+ displayName?: string;
2277
+ //
2278
+ dob?: string;
2279
+ //A valid RFC-5322 email address.
2280
+ email?: string;
2281
+ //A password for the user account.
2282
+ password?: string;
2283
+ //A old password for the user account.
2284
+ oldPassword?: string;
2285
+ //Set the username on the account at register. Must be unique.
2286
+ username?: string;
2287
+ //Extra information that will be bundled in the session token.
2288
+ vars?: Record<string, string>;
2289
+ }
2290
+
2291
+ /** */
2292
+ export interface ApiUpdateRoleOrderRequest {
2293
+ //
2294
+ clanId?: string;
2295
+ //
2296
+ roles?: Array<ApiRoleOrderUpdate>;
2297
+ }
2298
+
2299
+ /** */
2300
+ export interface ApiRoleOrderUpdate {
2301
+ //
2302
+ order?: number;
2303
+ //
2304
+ roleId?: string;
2305
+ }
2306
+
2307
+ /** */
2308
+ export interface ApiRole {
2309
+ //
2310
+ active?: number;
2311
+ //
2312
+ allowMention?: number;
2313
+ //
2314
+ channelIds?: Array<string>;
2315
+ //
2316
+ clanId?: string;
2317
+ //
2318
+ color?: string;
2319
+ //
2320
+ creatorId?: string;
2321
+ //
2322
+ description?: string;
2323
+ //
2324
+ displayOnline?: number;
2325
+ //
2326
+ id?: string;
2327
+ //
2328
+ maxLevelPermission?: number;
2329
+ //
2330
+ permissionList?: ApiPermissionList;
2331
+ //
2332
+ roleChannelActive?: number;
2333
+ //
2334
+ roleIcon?: string;
2335
+ //
2336
+ roleUserList?: ApiRoleUserList;
2337
+ //
2338
+ slug?: string;
2339
+ //
2340
+ title?: string;
2341
+ //
2342
+ orderRole?: number;
2343
+ }
2344
+
2345
+ /** */
2346
+ export interface ApiIsBannedResponse {
2347
+ //
2348
+ isBanned?: boolean;
2349
+ expiredBanTime?: number;
2350
+ }
2351
+
2352
+ /** A list of role description, usually a result of a list operation. */
2353
+ export interface ApiRoleList {
2354
+ maxLevelPermission?: number;
2355
+ //A list of role.
2356
+ roles?: Array<ApiRole>;
2357
+ }
2358
+
2359
+ /** */
2360
+ export interface ApiRoleListEventResponse {
2361
+ //
2362
+ clanId?: string;
2363
+ //
2364
+ cursor?: string;
2365
+ //
2366
+ limit?: number;
2367
+ //
2368
+ roles?: ApiRoleList;
2369
+ //
2370
+ state?: string;
2371
+ }
2372
+
2373
+ /** */
2374
+ export interface ApiRoleUserList {
2375
+ //Cursor for the next page of results, if any.
2376
+ cursor?: string;
2377
+ //roleUsers pairs for a clan.
2378
+ roleUsers?: Array<RoleUserListRoleUser>;
2379
+ }
2380
+
2381
+ /** Execute an Lua function on the server. */
2382
+ export interface ApiRpc {
2383
+ //The authentication key used when executed as a non-client HTTP request.
2384
+ httpKey?: string;
2385
+ //The identifier of the function.
2386
+ id?: string;
2387
+ //The payload of the function which must be a JSON object.
2388
+ payload?: string;
2389
+ }
2390
+
2391
+ /** */
2392
+ export interface ApiSdTopic {
2393
+ //
2394
+ channelId?: string;
2395
+ //
2396
+ clanId?: string;
2397
+ //
2398
+ createTime?: string;
2399
+ //
2400
+ creatorId?: string;
2401
+ //
2402
+ id?: string;
2403
+ //
2404
+ lastSentMessage?: ApiChannelMessageHeader;
2405
+ //
2406
+ messageId?: string;
2407
+ //
2408
+ status?: number;
2409
+ //
2410
+ updateTime?: string;
2411
+ //
2412
+ message?: ApiChannelMessage;
2413
+ }
2414
+
2415
+ /** */
2416
+ export interface ApiSdTopicList {
2417
+ //
2418
+ count?: number;
2419
+ //
2420
+ topics?: Array<ApiSdTopic>;
2421
+ }
2422
+
2423
+ /** */
2424
+ export interface ApiSdTopicRequest {
2425
+ //
2426
+ channelId?: string;
2427
+ //
2428
+ clanId?: string;
2429
+ //
2430
+ messageId?: string;
2431
+ }
2432
+
2433
+ /** */
2434
+ export interface ApiSearchMessageDocument {
2435
+ //
2436
+ attachments?: Array<ApiMessageAttachment>;
2437
+ //
2438
+ avatarUrl?: string;
2439
+ //The channel ID.
2440
+ channelId?: string;
2441
+ //
2442
+ channelLabel?: string;
2443
+ //
2444
+ channelType?: number;
2445
+ //The clan ID.
2446
+ clanId?: string;
2447
+ //
2448
+ clanName?: string;
2449
+ //
2450
+ content?: string;
2451
+ //
2452
+ createTime?: string;
2453
+ //
2454
+ displayName?: string;
2455
+ //
2456
+ mentions?: string;
2457
+ //The message ID.
2458
+ messageId?: string;
2459
+ //
2460
+ reactions?: string;
2461
+ //
2462
+ references?: string;
2463
+ //The user ID of sender.
2464
+ senderId?: string;
2465
+ //
2466
+ updateTime?: string;
2467
+ //
2468
+ username?: string;
2469
+ }
2470
+
2471
+ /** */
2472
+ export interface ApiSearchMessageRequest {
2473
+ //
2474
+ filters?: Array<ApiFilterParam>;
2475
+ //
2476
+ from?: number;
2477
+ //
2478
+ size?: number;
2479
+ //
2480
+ sorts?: Array<ApiSortParam>;
2481
+ }
2482
+
2483
+ /** */
2484
+ export interface ApiSearchMessageResponse {
2485
+ //List of paged messages.
2486
+ messages?: Array<ApiSearchMessageDocument>;
2487
+ //The total number of messages.
2488
+ total?: number;
2489
+ }
2490
+
2491
+ /** A user's session used to authenticate messages. */
2492
+ export interface ApiSession {
2493
+ //True if the corresponding account was just created, false otherwise.
2494
+ created?: boolean;
2495
+ //Refresh token that can be used for session token renewal.
2496
+ refreshToken?: string;
2497
+ //Authentication credentials.
2498
+ token?: string;
2499
+ // Whether to enable "Remember Me" for extended session duration.
2500
+ isRemember?: boolean;
2501
+ // endpoint url that belong to user
2502
+ apiUrl?: string;
2503
+ // id token for zklogin
2504
+ idToken?: string;
2505
+ }
2506
+
2507
+ /** Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user. */
2508
+ export interface ApiSessionLogoutRequest {
2509
+ //Refresh token to invalidate.
2510
+ refreshToken?: string;
2511
+ //Session token to log out.
2512
+ token?: string;
2513
+ // deviceId to log out.
2514
+ deviceId?: string;
2515
+ // platform
2516
+ platform?: string;
2517
+ }
2518
+
2519
+ /** Authenticate against the server with a refresh token. */
2520
+ export interface ApiSessionRefreshRequest {
2521
+ //Whether to enable "Remember Me" for extended session duration.
2522
+ isRemember?: boolean;
2523
+ //Refresh token.
2524
+ token?: string;
2525
+ //Extra information that will be bundled in the session token.
2526
+ vars?: Record<string, string>;
2527
+ }
2528
+
2529
+ /** */
2530
+ export interface ApiSetDefaultNotificationRequest {
2531
+ //
2532
+ categoryId?: string;
2533
+ //
2534
+ clanId?: string;
2535
+ //
2536
+ notificationType?: number;
2537
+ }
2538
+
2539
+ /** */
2540
+ export interface ApiSetMuteRequest {
2541
+ //
2542
+ active?: number;
2543
+ //
2544
+ id?: string;
2545
+ //
2546
+ muteTime?: number;
2547
+ //
2548
+ clanId?: string;
2549
+ }
2550
+
2551
+ /** */
2552
+ export interface ApiSetNotificationRequest {
2553
+ //
2554
+ channelCategoryId?: string;
2555
+ //
2556
+ notificationType?: number;
2557
+ // clanId
2558
+ clanId?: string;
2559
+ }
2560
+
2561
+ /** */
2562
+ export interface ApiSortParam {
2563
+ //
2564
+ fieldName?: string;
2565
+ //
2566
+ order?: string;
2567
+ }
2568
+
2569
+ /** */
2570
+ export interface ApiStickerListedResponse {
2571
+ //
2572
+ stickers?: Array<ApiClanSticker>;
2573
+ }
2574
+
2575
+ /** */
2576
+ export interface ApiStreamingChannelResponse {
2577
+ //
2578
+ channelId?: string;
2579
+ //
2580
+ clanId?: string;
2581
+ //
2582
+ isStreaming?: boolean;
2583
+ //
2584
+ streamingUrl?: string;
2585
+ }
2586
+
2587
+ /** A list of users belonging to a channel, along with their role. */
2588
+ export interface ApiStreamingChannelUser {
2589
+ //
2590
+ channelId?: string;
2591
+ //
2592
+ id?: string;
2593
+ //
2594
+ participant?: string;
2595
+ //user for a channel.
2596
+ userId?: string;
2597
+ }
2598
+
2599
+ /** A list of users belonging to a channel, along with their role. */
2600
+ export interface ApiStreamingChannelUserList {
2601
+ //
2602
+ streamingChannelUsers?: Array<ApiStreamingChannelUser>;
2603
+ }
2604
+
2605
+ /** System message details. */
2606
+ export interface ApiSystemMessage {
2607
+ //
2608
+ boostMessage?: string;
2609
+ //
2610
+ channelId?: string;
2611
+ //
2612
+ clanId?: string;
2613
+ //
2614
+ hideAuditLog?: string;
2615
+ //
2616
+ id?: string;
2617
+ //
2618
+ setupTips?: string;
2619
+ //
2620
+ welcomeRandom?: string;
2621
+ //
2622
+ welcomeSticker?: string;
2623
+ }
2624
+
2625
+ /** Request to get system message by clan and channel IDs. */
2626
+ export interface ApiSystemMessageRequest {
2627
+ //
2628
+ boostMessage?: string;
2629
+ //
2630
+ channelId?: string;
2631
+ //
2632
+ clanId?: string;
2633
+ //
2634
+ hideAuditLog?: string;
2635
+ //
2636
+ setupTips?: string;
2637
+ //
2638
+ welcomeRandom?: string;
2639
+ //
2640
+ welcomeSticker?: string;
2641
+ }
2642
+
2643
+ /** List of system message. */
2644
+ export interface ApiSystemMessagesList {
2645
+ //
2646
+ systemMessagesList?: Array<ApiSystemMessage>;
2647
+ }
2648
+
2649
+ /** */
2650
+ export interface ApiTokenSentEvent {
2651
+ //
2652
+ amount?: number;
2653
+ //
2654
+ note?: string;
2655
+ //
2656
+ receiverId?: string;
2657
+ //
2658
+ senderId?: string;
2659
+ //
2660
+ senderName?: string;
2661
+ //
2662
+ extraAttribute?: string;
2663
+ //
2664
+ transactionId?: string;
2665
+ }
2666
+
2667
+ /** */
2668
+ export interface ApiTransactionDetail {
2669
+ //
2670
+ amount?: number;
2671
+ //
2672
+ createTime?: string;
2673
+ //
2674
+ updateTime?: string;
2675
+ //
2676
+ receiverId?: string;
2677
+ //
2678
+ receiverUsername?: string;
2679
+ //
2680
+ senderId?: string;
2681
+ //
2682
+ senderUsername?: string;
2683
+ //
2684
+ metadata?: string;
2685
+ //
2686
+ transId?: string;
2687
+ }
2688
+
2689
+ /** Update a user's account details. */
2690
+ export interface ApiUpdateAccountRequest {
2691
+ //
2692
+ aboutMe?: string;
2693
+ //A URL for an avatar image.
2694
+ avatarUrl?: string;
2695
+ //The display name of the user.
2696
+ displayName?: string;
2697
+ //
2698
+ dob?: string;
2699
+ //The email of the user's account.
2700
+ email?: string;
2701
+ //
2702
+ encryptPrivateKey?: string;
2703
+ //The language expected to be a tag which follows the BCP-47 spec.
2704
+ langTag?: string;
2705
+ //The location set by the user.
2706
+ location?: string;
2707
+ //
2708
+ logo?: string;
2709
+ //
2710
+ splashScreen?: string;
2711
+ //The timezone set by the user.
2712
+ timezone?: string;
2713
+ }
2714
+
2715
+ /** */
2716
+ export interface ApiUpdateCategoryDescRequest {
2717
+ //The ID of the group to update.
2718
+ categoryId?: string;
2719
+ //
2720
+ categoryName?: string;
2721
+ // clan ID
2722
+ ClanId: string;
2723
+ }
2724
+ /** */
2725
+ export interface ApiUpdateCategoryOrderRequest {
2726
+ //
2727
+ categories?: Array<ApiCategoryOrderUpdate>;
2728
+ //
2729
+ clanId?: string;
2730
+ }
2731
+
2732
+ /** */
2733
+ export interface ApiUpdateRoleChannelRequest {
2734
+ //
2735
+ channelId: string;
2736
+ //
2737
+ maxPermissionId: string;
2738
+ //The permissions to add.
2739
+ permissionUpdate?: Array<ApiPermissionUpdate>;
2740
+ //The ID of the role to update.
2741
+ roleId?: string;
2742
+ //
2743
+ roleLabel?: string;
2744
+ //The ID of the role to update.
2745
+ userId?: string;
2746
+ }
2747
+
2748
+ /** Fetch a batch of zero or more users from the server. */
2749
+ export interface ApiUpdateUsersRequest {
2750
+ //The avarar_url of a user.
2751
+ avatarUrl?: string;
2752
+ //The account username of a user.
2753
+ displayName?: string;
2754
+ }
2755
+
2756
+ /** */
2757
+ export interface ApiUploadAttachment {
2758
+ //
2759
+ filename?: string;
2760
+ //
2761
+ url?: string;
2762
+ }
2763
+
2764
+ /** */
2765
+ export interface ApiUploadAttachmentRequest {
2766
+ //
2767
+ filename?: string;
2768
+ //
2769
+ filetype?: string;
2770
+ //
2771
+ height?: number;
2772
+ //
2773
+ size?: number;
2774
+ //
2775
+ width?: number;
2776
+ }
2777
+
2778
+ /** A user in the server. */
2779
+ export interface ApiUser {
2780
+ //
2781
+ aboutMe?: string;
2782
+ //A URL for an avatar image.
2783
+ avatarUrl?: string;
2784
+ //
2785
+ dob?: string;
2786
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the user was created.
2787
+ createTime?: string;
2788
+ //The display name of the user.
2789
+ displayName?: string;
2790
+ //Number of related edges to this user.
2791
+ edgeCount?: number;
2792
+ //The id of the user's account.
2793
+ id?: string;
2794
+ //
2795
+ isMobile?: boolean;
2796
+ //
2797
+ joinTime?: string;
2798
+ //The language expected to be a tag which follows the BCP-47 spec.
2799
+ langTag?: string;
2800
+ //The location set by the user.
2801
+ location?: string;
2802
+ //Additional information stored as a JSON object.
2803
+ userStatus?: string;
2804
+ // online, offline, invisible, idle, do not disturb
2805
+ status?: string;
2806
+ //Indicates whether the user is currently online.
2807
+ online?: boolean;
2808
+ //The timezone set by the user.
2809
+ timezone?: string;
2810
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the user was last updated.
2811
+ updateTime?: string;
2812
+ //The username of the user's account.
2813
+ username?: string;
2814
+ // mezonId
2815
+ mezonId?: string;
2816
+ // list nick name
2817
+ listNickNames?: Array<string>;
2818
+ // phone number
2819
+ phoneNumber?: string;
2820
+ }
2821
+
2822
+ /** */
2823
+ export interface ApiUserActivity {
2824
+ //
2825
+ activityDescription?: string;
2826
+ //
2827
+ activityName?: string;
2828
+ //
2829
+ activityType?: number;
2830
+ //
2831
+ applicationId?: string;
2832
+ //
2833
+ endTime?: string;
2834
+ //
2835
+ startTime?: string;
2836
+ //
2837
+ status?: number;
2838
+ //
2839
+ userId?: string;
2840
+ }
2841
+
2842
+ /** */
2843
+ export interface ApiQuickMenuAccess {
2844
+ //
2845
+ actionMsg?: string;
2846
+ //
2847
+ background?: string;
2848
+ //
2849
+ botId?: string;
2850
+ //
2851
+ channelId?: string;
2852
+ //
2853
+ clanId?:string;
2854
+ //
2855
+ id?: string;
2856
+ //
2857
+ menuName?: string;
2858
+ //
2859
+ menuType?: number;
2860
+ }
2861
+
2862
+ /** */
2863
+ export interface ApiQuickMenuAccessList {
2864
+ //
2865
+ listMenus?: Array<ApiQuickMenuAccess>;
2866
+ }
2867
+
2868
+ /** */
2869
+ export interface ApiQuickMenuAccessRequest {
2870
+ //
2871
+ actionMsg?: string;
2872
+ //
2873
+ background?: string;
2874
+ //
2875
+ botId?: string;
2876
+ //
2877
+ channelId?: string;
2878
+ //
2879
+ clanId?: string;
2880
+ //
2881
+ id?: string;
2882
+ //
2883
+ menuName?: string;
2884
+ //
2885
+ menuType?:number;
2886
+ }
2887
+
2888
+ /** */
2889
+ export interface ApiUserPermissionInChannelListResponse {
2890
+ //
2891
+ channelId?: string;
2892
+ //
2893
+ clanId?: string;
2894
+ //A list of permission.
2895
+ permissions?: ApiPermissionList;
2896
+ }
2897
+
2898
+ /** */
2899
+ export interface ApiUserStatus {
2900
+ //
2901
+ status?: string;
2902
+ //
2903
+ userId?: string;
2904
+ }
2905
+
2906
+ /** */
2907
+ export interface ApiUserStatusUpdate {
2908
+ //
2909
+ minutes?: number;
2910
+ //
2911
+ status?: string;
2912
+ //
2913
+ untilTurnOn?: boolean;
2914
+ }
2915
+
2916
+ /** A collection of zero or more users. */
2917
+ export interface ApiUsers {
2918
+ //The User objects.
2919
+ users?: Array<ApiUser>;
2920
+ }
2921
+
2922
+ /** A list of users belonging to a channel, along with their role. */
2923
+ export interface ApiVoiceChannelUser {
2924
+ //Cursor for the next page of results, if any.
2925
+ id?: string;
2926
+ //
2927
+ channelId?: string;
2928
+ //
2929
+ participant?: string;
2930
+ //User for a channel.
2931
+ userId?: string;
2932
+ }
2933
+
2934
+ /** A list of users belonging to a channel, along with their role. */
2935
+ export interface ApiVoiceChannelUserList {
2936
+ //
2937
+ voiceChannelUsers?: Array<ApiVoiceChannelUser>;
2938
+ }
2939
+
2940
+ /** */
2941
+ export interface ApiWebhook {
2942
+ //
2943
+ active?: number;
2944
+ //
2945
+ avatar?: string;
2946
+ //
2947
+ channelId?: string;
2948
+ //
2949
+ createTime?: string;
2950
+ //
2951
+ creatorId?: string;
2952
+ //
2953
+ id?: string;
2954
+ //
2955
+ status?: number;
2956
+ //
2957
+ updateTime?: string;
2958
+ //
2959
+ url?: string;
2960
+ //
2961
+ webhookName?: string;
2962
+ //
2963
+ clanId?: string;
2964
+ }
2965
+
2966
+ /** */
2967
+ export interface ApiWebhookCreateRequest {
2968
+ //
2969
+ avatar?: string;
2970
+ //
2971
+ channelId?: string;
2972
+ //
2973
+ clanId?: string;
2974
+ //
2975
+ webhookName?: string;
2976
+ }
2977
+
2978
+ /** */
2979
+ export interface ApiWebhookGenerateResponse {
2980
+ //
2981
+ avatar?: string;
2982
+ //
2983
+ channelId?: string;
2984
+ //
2985
+ hookName?: string;
2986
+ //
2987
+ url?: string;
2988
+ }
2989
+
2990
+ /** */
2991
+ export interface ApiWebhookListResponse {
2992
+ //
2993
+ webhooks?: Array<ApiWebhook>;
2994
+ }
2995
+
2996
+ /** A collection of zero or more notifications. */
2997
+ export interface ApiEmojiRecentList {
2998
+ //Collection of emojiRecents.
2999
+ emojiRecents?: Array<ApiEmojiRecent>;
3000
+ }
3001
+
3002
+
3003
+ /** Represents an event to be passed through the server to registered event handlers. */
3004
+ export interface MezonapiEvent {
3005
+ //True if the event came directly from a client call, false otherwise.
3006
+ external?: boolean;
3007
+ //An event name, type, category, or identifier.
3008
+ name?: string;
3009
+ //Arbitrary event property values.
3010
+ properties?: Record<string, string>;
3011
+ //The time when the event was triggered.
3012
+ timestamp?: string;
3013
+ }
3014
+
3015
+ /** */
3016
+ export interface MezonapiListAuditLog {
3017
+ //
3018
+ dateLog?: string;
3019
+ //
3020
+ logs?: Array<ApiAuditLog>;
3021
+ //
3022
+ totalCount?: number;
3023
+ }
3024
+
3025
+ /** */
3026
+ export interface ProtobufAny {
3027
+ //
3028
+ typeUrl?: string;
3029
+ //
3030
+ value?: string;
3031
+ }
3032
+
3033
+ /** */
3034
+ export interface RpcStatus {
3035
+ //
3036
+ code?: number;
3037
+ //
3038
+ details?: Array<ProtobufAny>;
3039
+ //
3040
+ message?: string;
3041
+ }
3042
+
3043
+ /** */
3044
+ export interface ApiListOnboardingResponse {
3045
+ //
3046
+ listOnboarding?: Array<ApiOnboardingItem>;
3047
+ }
3048
+
3049
+ /** */
3050
+ export interface OnboardingAnswer {
3051
+ //
3052
+ emoji?: string;
3053
+ //
3054
+ description?: string;
3055
+ //
3056
+ title?: string;
3057
+ //
3058
+ imageUrl?: string;
3059
+ }
3060
+
3061
+ /** */
3062
+ export interface ApiOnboardingContent {
3063
+ //
3064
+ answers?: Array<OnboardingAnswer>;
3065
+ //
3066
+ channelId?: string;
3067
+ //
3068
+ content?: string;
3069
+ //
3070
+ guideType?: number;
3071
+ //
3072
+ taskType?: number;
3073
+ //
3074
+ title?: string;
3075
+ //
3076
+ imageUrl?: string;
3077
+ }
3078
+
3079
+ /** */
3080
+ export interface MezonUpdateOnboardingBody {
3081
+ //
3082
+ answers?: Array<OnboardingAnswer>;
3083
+ //
3084
+ channelId?: string;
3085
+ //
3086
+ clanId?: string;
3087
+ //
3088
+ content?: string;
3089
+ //
3090
+ taskType?: number;
3091
+ //
3092
+ title?: string;
3093
+ //
3094
+ imageUrl?: string;
3095
+ }
3096
+
3097
+ /** */
3098
+ export interface ApiCreateOnboardingRequest {
3099
+ //
3100
+ clanId?: string;
3101
+ //
3102
+ contents?: Array<ApiOnboardingContent>;
3103
+ }
3104
+
3105
+ /** */
3106
+ export interface ApiOnboardingItem {
3107
+ //
3108
+ answers?: Array<OnboardingAnswer>;
3109
+ //
3110
+ channelId?: string;
3111
+ //
3112
+ clanId?: string;
3113
+ //
3114
+ content?: string;
3115
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was created.
3116
+ createTime?: string;
3117
+ //
3118
+ guideType?: number;
3119
+ //
3120
+ id?: string;
3121
+ //
3122
+ taskType?: number;
3123
+ //
3124
+ title?: string;
3125
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was last updated.
3126
+ updateTime?: string;
3127
+ //
3128
+ imageUrl?: string;
3129
+ }
3130
+
3131
+ /** */
3132
+ export interface MezonUpdateClanWebhookByIdBody {
3133
+ //avatar.
3134
+ avatar?: string;
3135
+ //clan id.
3136
+ clanId?: string;
3137
+ //reset token.
3138
+ resetToken?: boolean;
3139
+ //webhook name.
3140
+ webhookName?: string;
3141
+ }
3142
+
3143
+ /** */
3144
+ export interface ApiClanWebhook {
3145
+ //active.
3146
+ active?: number;
3147
+ //
3148
+ avatar?: string;
3149
+ //clan id.
3150
+ clanId?: string;
3151
+ //create time.
3152
+ createTime?: string;
3153
+ //creator id.
3154
+ creatorId?: string;
3155
+ //id.
3156
+ id?: string;
3157
+ //update time.
3158
+ updateTime?: string;
3159
+ //URL of the webhook, which is automatically generated and different from the avatar.
3160
+ url?: string;
3161
+ //webhook name.
3162
+ webhookName?: string;
3163
+ }
3164
+
3165
+ /** */
3166
+ export interface ApiGenerateClanWebhookRequest {
3167
+ //avatar.
3168
+ avatar?: string;
3169
+ //clan id.
3170
+ clanId?: string;
3171
+ //webhook name.
3172
+ webhookName?: string;
3173
+ }
3174
+
3175
+ /** */
3176
+ export interface ApiGenerateClanWebhookResponse {
3177
+ //avatar.
3178
+ avatar?: string;
3179
+ //clan id.
3180
+ clanId?: string;
3181
+ //url.
3182
+ url?: string;
3183
+ //webhook name.
3184
+ webhookName?: string;
3185
+ }
3186
+
3187
+ /** */
3188
+ export interface ApiListClanWebhookResponse {
3189
+ //list clan webhook.
3190
+ listClanWebhooks?: Array<ApiClanWebhook>;
3191
+ }
3192
+
3193
+ /** */
3194
+ export interface MezonUpdateOnboardingStepByClanIdBody {
3195
+ //onboarding step.
3196
+ onboardingStep?: number;
3197
+ }
3198
+
3199
+ /** */
3200
+ export interface ApiListOnboardingStepResponse {
3201
+ //list onboarding steps.
3202
+ listOnboardingStep?: Array<ApiOnboardingSteps>;
3203
+ }
3204
+
3205
+ /** */
3206
+ export interface ApiOnboardingSteps {
3207
+ //clan id.
3208
+ clanId?: string;
3209
+ //id.
3210
+ id?: string;
3211
+ //onboarding step.
3212
+ onboardingStep?: number;
3213
+ //user id.
3214
+ userId?: string;
3215
+ }
3216
+
3217
+ /** */
3218
+ export interface MezonapiCreateRoomChannelApps {
3219
+ //
3220
+ channelId?: string;
3221
+ //
3222
+ roomName?: string;
3223
+ }
3224
+
3225
+ /** */
3226
+ export interface ApiGenerateMeetTokenRequest {
3227
+ //
3228
+ channelId?: string;
3229
+ //
3230
+ roomName?: string;
3231
+ }
3232
+
3233
+ /** */
3234
+ export interface ApiGenerateMeetTokenResponse {
3235
+ //
3236
+ token?: string;
3237
+ }
3238
+
3239
+ /** */
3240
+ export interface ApiUnlockedItemRequest {
3241
+ //
3242
+ itemId?: string;
3243
+ //
3244
+ itemType?: number;
3245
+ }
3246
+
3247
+ /** */
3248
+ export interface ApiUnlockedItemResponse {
3249
+ //
3250
+ source?: string;
3251
+ }
3252
+
3253
+ /** */
3254
+ export interface ApiMezonOauthClient {
3255
+ //
3256
+ accessTokenStrategy?: string;
3257
+ //
3258
+ allowedCorsOrigins?: Array<string>;
3259
+ //
3260
+ audience?: Array<string>;
3261
+ //
3262
+ authorizationCodeGrantAccessTokenLifespan?: string;
3263
+ //
3264
+ authorizationCodeGrantIdTokenLifespan?: string;
3265
+ //
3266
+ authorizationCodeGrantRefreshTokenLifespan?: string;
3267
+ //
3268
+ backchannelLogoutSessionRequired?: boolean;
3269
+ //
3270
+ backchannelLogoutUri?: string;
3271
+ //
3272
+ clientCredentialsGrantAccessTokenLifespan?: string;
3273
+ //
3274
+ clientId?: string;
3275
+ //
3276
+ clientName?: string;
3277
+ //
3278
+ clientSecret?: string;
3279
+ //
3280
+ clientSecretExpiresAt?: number;
3281
+ //
3282
+ clientUri?: string;
3283
+ //
3284
+ contacts?: Array<string>;
3285
+ //
3286
+ createdAt?: string;
3287
+ //
3288
+ frontchannelLogoutSessionRequired?: boolean;
3289
+ //
3290
+ frontchannelLogoutUri?: string;
3291
+ //
3292
+ grantTypes?: Array<string>;
3293
+ //
3294
+ implicitGrantAccessTokenLifespan?: string;
3295
+ //
3296
+ implicitGrantIdTokenLifespan?: string;
3297
+ //
3298
+ jwks?: Array<string>;
3299
+ //
3300
+ jwksUri?: string;
3301
+ //
3302
+ jwtBearerGrantAccessTokenLifespan?: string;
3303
+ //
3304
+ logoUri?: string;
3305
+ //
3306
+ owner?: string;
3307
+ //
3308
+ policyUri?: string;
3309
+ //
3310
+ postLogoutRedirectUris?: Array<string>;
3311
+ //
3312
+ redirectUris?: Array<string>;
3313
+ //
3314
+ refreshTokenGrantAccessTokenLifespan?: string;
3315
+ //
3316
+ refreshTokenGrantIdTokenLifespan?: string;
3317
+ //
3318
+ refreshTokenGrantRefreshTokenLifespan?: string;
3319
+ //
3320
+ registrationAccessToken?: string;
3321
+ //
3322
+ registrationClientUri?: string;
3323
+ //
3324
+ requestObjectSigningAlg?: string;
3325
+ //
3326
+ requestUris?: Array<string>;
3327
+ //
3328
+ responseTypes?: Array<string>;
3329
+ //
3330
+ scope?: string;
3331
+ //
3332
+ sectorIdentifierUri?: string;
3333
+ //
3334
+ skipConsent?: boolean;
3335
+ //
3336
+ skipLogoutConsent?: boolean;
3337
+ //
3338
+ subjectType?: string;
3339
+ //
3340
+ tokenEndpointAuthMethod?: string;
3341
+ //
3342
+ tokenEndpointAuthSigningAlg?: string;
3343
+ //
3344
+ tosUri?: string;
3345
+ //
3346
+ updatedAt?: string;
3347
+ //
3348
+ userinfoSignedResponseAlg?: string;
3349
+ }
3350
+
3351
+ /** */
3352
+ export interface ApiCreateHashChannelAppsResponse {
3353
+ //
3354
+ webAppData?: string;
3355
+ }
3356
+
3357
+ /** */
3358
+ export interface ApiUserEventRequest {
3359
+ // The ID of the clan to be updated.
3360
+ clanId?: string;
3361
+ //The ID of the event to be updated.
3362
+ eventId?: string;
3363
+ }
3364
+
3365
+ /** */
3366
+ export interface ApiClanDiscover {
3367
+ //
3368
+ about?: string;
3369
+ //
3370
+ banner?: string;
3371
+ //
3372
+ clanId?: string;
3373
+ //
3374
+ clanLogo?: string;
3375
+ //
3376
+ clanName?: string;
3377
+ //
3378
+ description?: string;
3379
+ //
3380
+ inviteId?: string;
3381
+ //
3382
+ onlineMembers?: number;
3383
+ //
3384
+ totalMembers?: number;
3385
+ //
3386
+ verified?: boolean;
3387
+ //
3388
+ shortUrl?: string;
3389
+ //
3390
+ createTime?: string;
3391
+ }
3392
+
3393
+ /** */
3394
+ export interface ApiListForSaleItemsRequest {
3395
+ //
3396
+ page?: number;
3397
+ }
3398
+
3399
+ /** */
3400
+ export interface ApiForSaleItem {
3401
+ //
3402
+ previewUrl?: string;
3403
+ //
3404
+ type?: number;
3405
+ }
3406
+
3407
+ /** */
3408
+ export interface ApiForSaleItemList {
3409
+ //
3410
+ forSaleItems?: Array<ApiForSaleItem>;
3411
+ }
3412
+
3413
+ /** */
3414
+ export interface ApiListClanDiscover {
3415
+ //
3416
+ clanDiscover?: Array<ApiClanDiscover>;
3417
+ //
3418
+ page?: number;
3419
+ //
3420
+ pageCount?: number;
3421
+ }
3422
+
3423
+ /** */
3424
+ export interface ApiListClanUnreadMsgIndicatorResponse {
3425
+ //
3426
+ hasUnreadMessage?: boolean;
3427
+ }
3428
+
3429
+ /** */
3430
+ export interface ApiClanDiscoverRequest {
3431
+ //
3432
+ clanId?: string;
3433
+ //
3434
+ itemPerPage?: number;
3435
+ //
3436
+ pageNumber?: number;
3437
+ }
3438
+
3439
+ /** */
3440
+ export interface ApiIsFollowerRequest {
3441
+ //
3442
+ followId?: string;
3443
+ }
3444
+
3445
+ /** */
3446
+ export interface ApiLinkAccountConfirmRequest {
3447
+ //
3448
+ otpCode?: string;
3449
+ //
3450
+ reqId?: string;
3451
+ //
3452
+ status?: number;
3453
+ }
3454
+
3455
+ /** */
3456
+ export interface ApiIsFollowerResponse {
3457
+ //
3458
+ isFollower?: boolean;
3459
+ //
3460
+ followId?: string;
3461
+ }
3462
+
3463
+ /** */
3464
+ export interface ApiTransferOwnershipRequest {
3465
+ //
3466
+ clanId?: string;
3467
+ //
3468
+ newOwnerId?: string;
3469
+ }
3470
+
3471
+ /** */
3472
+ export interface ApiTransferOwnershipRequest {
3473
+ //
3474
+ clanId?: string;
3475
+ //
3476
+ newOwnerId?: string;
3477
+ }
3478
+
3479
+ /** A message sent on a channel. */
3480
+ export interface ChannelMessage {
3481
+ //The unique ID of this message.
3482
+ id: string;
3483
+ //
3484
+ avatar?: string;
3485
+ //The channel this message belongs to.
3486
+ channelId: string;
3487
+ //The name of the chat room, or an empty string if this message was not sent through a chat room.
3488
+ channelLabel: string;
3489
+ //The clan this message belong to.
3490
+ clanId?: string;
3491
+ //The code representing a message type or category.
3492
+ code: number;
3493
+ //The content payload.
3494
+ content: string;
3495
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was created.
3496
+ createTime: string;
3497
+ //
3498
+ reactions?: Array<ApiMessageReaction>;
3499
+ //
3500
+ mentions?: Array<ApiMessageMention>;
3501
+ //
3502
+ attachments?: Array<ApiMessageAttachment>;
3503
+ //
3504
+ references?: Array<ApiMessageRef>;
3505
+ //
3506
+ referencedMessage?: string[];
3507
+ //True if the message was persisted to the channel's history, false otherwise.
3508
+ persistent?: boolean;
3509
+ //Message sender, usually a user ID.
3510
+ senderId: string;
3511
+ //The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was last updated.
3512
+ updateTime?: string;
3513
+ //The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
3514
+ clanLogo?: string;
3515
+ //The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
3516
+ categoryName?: string;
3517
+ //The username of the message sender, if any.
3518
+ username?: string;
3519
+ // The clan nick name
3520
+ clanNick?: string;
3521
+ // The clan avatar
3522
+ clanAvatar?: string;
3523
+ //
3524
+ displayName?: string;
3525
+ //
3526
+ createTimeSeconds?: number;
3527
+ //
3528
+ updateTimeSeconds?: number;
3529
+ //
3530
+ mode?: number;
3531
+ //
3532
+ messageId?: string;
3533
+ //
3534
+ hideEditted?: boolean;
3535
+ //
3536
+ isPublic?: boolean;
3537
+ //
3538
+ topicId?: string;
3539
+ }
3540
+
3541
+ /** A list of channel messages, usually a result of a list operation. */
3542
+ export interface ChannelMessageList {
3543
+ /** Cacheable cursor to list newer messages. Durable and designed to be stored, unlike next/prev cursors. */
3544
+ cacheableCursor?: string;
3545
+ /**last seen message from user on channel */
3546
+ lastSeenMessage?: ApiChannelMessageHeader;
3547
+ /**last sent message from channel */
3548
+ lastSentMessage?: ApiChannelMessageHeader;
3549
+ /** A list of messages. */
3550
+ messages?: Array<ChannelMessage>;
3551
+ /** The cursor to send when retireving the next page, if any. */
3552
+ nextCursor?: string;
3553
+ /** The cursor to send when retrieving the previous page, if any. */
3554
+ prevCursor?: string;
3555
+ }
3556
+
3557
+ /** A collection of zero or more users. */
3558
+ export interface Users {
3559
+ /** The User objects. */
3560
+ users?: Array<ApiUser>;
3561
+ }
3562
+
3563
+ /** A collection of zero or more friends of the user. */
3564
+ export interface Friends {
3565
+ /** The Friend objects. */
3566
+ friends?: Array<ApiFriend>;
3567
+ /** Cursor for the next page of results, if any. */
3568
+ cursor?: string;
3569
+ }
3570
+
3571
+ /** A notification in the server. */
3572
+ export interface Notification {
3573
+ /** Category code for this notification. */
3574
+ code?: number;
3575
+ /** Content of the notification in JSON. */
3576
+ content?: {};
3577
+ /** The UNIX time when the notification was created. */
3578
+ createTime?: string;
3579
+ /** ID of the Notification. */
3580
+ id?: string;
3581
+ /** True if this notification was persisted to the database. */
3582
+ persistent?: boolean;
3583
+ /** ID of the sender, if a user. Otherwise 'null'. */
3584
+ senderId?: string;
3585
+ /** Subject of the notification. */
3586
+ subject?: string;
3587
+ }
3588
+
3589
+ /** A collection of zero or more notifications. */
3590
+ export interface NotificationList {
3591
+ /** Use this cursor to paginate notifications. Cache this to catch up to new notifications. */
3592
+ cacheableCursor?: string;
3593
+ /** Collection of notifications. */
3594
+ notifications?: Array<Notification>;
3595
+ }
3596
+
3597
+ /** Update fields in a given channel. */
3598
+ export interface ApiUpdateChannelDescRequest {
3599
+ /** The ID of the channel to update. */
3600
+ channelId: string;
3601
+ /** The channel lable */
3602
+ channelLabel: string | undefined;
3603
+ /** The category of channel */
3604
+ categoryId: string | undefined;
3605
+ /** The app url of channel */
3606
+ appId: string | undefined;
3607
+ //
3608
+ e2ee?: number;
3609
+ //
3610
+ topic?: string;
3611
+ //
3612
+ ageRestricted?: number;
3613
+ //
3614
+ channelAvatar?: string;
3615
+ }
3616
+
3617
+ /** Add users to a channel. */
3618
+ export interface ApiAddChannelUsersRequest {
3619
+ /** The channel to add users to. */
3620
+ channelId: string;
3621
+ /** The users to add. */
3622
+ userIds: string[];
3623
+ }
3624
+
3625
+ /** Kick a set of users from a channel. */
3626
+ export interface ApiKickChannelUsersRequest {
3627
+ /** The channel ID to kick from. */
3628
+ channelId: string;
3629
+ /** The users to kick. */
3630
+ userIds: string[];
3631
+ }
3632
+
3633
+ /** Leave a channel. */
3634
+ export interface ApiLeaveChannelRequest {
3635
+ /** The channel ID to leave. */
3636
+ channelId: string;
3637
+ }
3638
+
3639
+ /** Update Clan profile information */
3640
+ export interface ApiUpdateClanDescProfileRequest {
3641
+ /** Clan id */
3642
+ clanId: string;
3643
+ /** Clan nick name */
3644
+ nickName: string;
3645
+ /** Clan profile banner */
3646
+ profileBanner: string;
3647
+ /** Clan profile theme */
3648
+ profileTheme: string;
3649
+ /** Clan profile avatar */
3650
+ avatarUrl: string;
3651
+ }
3652
+
3653
+ export interface ApiUpdateClanProfileRequest {
3654
+ /** Clan id*/
3655
+ clanId: string;
3656
+ /** Clan nick name */
3657
+ nickName: string;
3658
+ /** Clan profile avatar */
3659
+ avatar: string;
3660
+ }
3661
+
3662
+ /** Update fields in a given role. */
3663
+ export interface ApiUpdateRoleRequest {
3664
+ /** The ID of the role to update. */
3665
+ roleId: string;
3666
+ /** The users to add. */
3667
+ addUserIds: string[];
3668
+ /** The permissions to add. */
3669
+ activePermissionIds: string[];
3670
+ /** The users to remove. */
3671
+ removeUserIds: string[];
3672
+ /** The permissions to remove. */
3673
+ removePermissionIds: string[];
3674
+ //
3675
+ clanId: string;
3676
+ maxPermissionId: string;
3677
+ title?: string | undefined;
3678
+ color?: string | undefined;
3679
+ roleIcon?: string | undefined;
3680
+ description?: string | undefined;
3681
+ displayOnline?: number | undefined;
3682
+ allowMention?: number | undefined;
3683
+ }
3684
+
3685
+ type Builtin =
3686
+ | Date
3687
+ | Function
3688
+ | Uint8Array
3689
+ | string
3690
+ | number
3691
+ | boolean
3692
+ | undefined;
3693
+
3694
+ export type DeepPartial<T> = T extends Builtin
3695
+ ? T
3696
+ : T extends globalThis.Array<infer U>
3697
+ ? globalThis.Array<DeepPartial<U>>
3698
+ : T extends ReadonlyArray<infer U>
3699
+ ? ReadonlyArray<DeepPartial<U>>
3700
+ : T extends {}
3701
+ ? { [K in keyof T]?: DeepPartial<T[K]> }
3702
+ : Partial<T>;
3703
+
3704
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
3705
+ export type Exact<P, I extends P> = P extends Builtin
3706
+ ? P
3707
+ : P & { [K in keyof P]: Exact<P[K], I[K]> } & {
3708
+ [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
3709
+ };
3710
+
3711
+ const createBaseSession = (): Session => {
3712
+ return {
3713
+ created: false,
3714
+ token: "",
3715
+ refreshToken: "",
3716
+ userId: "",
3717
+ isRemember: false,
3718
+ apiUrl: "",
3719
+ idToken: "",
3720
+ };
3721
+ };
3722
+
3723
+ const isSet = (value: any): boolean => {
3724
+ return value !== null && value !== undefined;
3725
+ };
3726
+
3727
+ export const Session = {
3728
+ encode(
3729
+ message: Session,
3730
+ writer: _m0.Writer = _m0.Writer.create()
3731
+ ): _m0.Writer {
3732
+ if (message.created !== false) {
3733
+ writer.uint32(8).bool(message.created);
3734
+ }
3735
+ if (message.token !== "") {
3736
+ writer.uint32(18).string(message.token);
3737
+ }
3738
+ if (message.refreshToken !== "") {
3739
+ writer.uint32(26).string(message.refreshToken);
3740
+ }
3741
+ if (message.userId !== "") {
3742
+ writer.uint32(34).string(message.userId);
3743
+ }
3744
+ if (message.isRemember !== false) {
3745
+ writer.uint32(40).bool(message.isRemember);
3746
+ }
3747
+ if (message.apiUrl !== "") {
3748
+ writer.uint32(50).string(message.apiUrl);
3749
+ }
3750
+ if (message.idToken !== "") {
3751
+ writer.uint32(58).string(message.idToken);
3752
+ }
3753
+ return writer;
3754
+ },
3755
+
3756
+ decode(input: _m0.Reader | Uint8Array, length?: number): Session {
3757
+ const reader =
3758
+ input instanceof _m0.Reader ? input : _m0.Reader.create(input);
3759
+ let end = length === undefined ? reader.len : reader.pos + length;
3760
+ const message = createBaseSession();
3761
+ while (reader.pos < end) {
3762
+ const tag = reader.uint32();
3763
+ switch (tag >>> 3) {
3764
+ case 1:
3765
+ if (tag !== 8) {
3766
+ break;
3767
+ }
3768
+
3769
+ message.created = reader.bool();
3770
+ continue;
3771
+ case 2:
3772
+ if (tag !== 18) {
3773
+ break;
3774
+ }
3775
+
3776
+ message.token = reader.string();
3777
+ continue;
3778
+ case 3:
3779
+ if (tag !== 26) {
3780
+ break;
3781
+ }
3782
+
3783
+ message.refreshToken = reader.string();
3784
+ continue;
3785
+ case 4:
3786
+ if (tag !== 34) {
3787
+ break;
3788
+ }
3789
+
3790
+ message.userId = reader.string();
3791
+ continue;
3792
+ case 5:
3793
+ if (tag !== 40) {
3794
+ break;
3795
+ }
3796
+
3797
+ message.isRemember = reader.bool();
3798
+ continue;
3799
+ case 6:
3800
+ if (tag !== 50) {
3801
+ break;
3802
+ }
3803
+
3804
+ message.apiUrl = reader.string();
3805
+ continue;
3806
+ case 7:
3807
+ if (tag !== 58) {
3808
+ break;
3809
+ }
3810
+
3811
+ message.idToken = reader.string();
3812
+ continue;
3813
+ }
3814
+ if ((tag & 7) === 4 || tag === 0) {
3815
+ break;
3816
+ }
3817
+ reader.skipType(tag & 7);
3818
+ }
3819
+ return message;
3820
+ },
3821
+
3822
+ fromJSON(object: any): Session {
3823
+ return {
3824
+ created: isSet(object.created)
3825
+ ? globalThis.Boolean(object.created)
3826
+ : false,
3827
+ token: isSet(object.token) ? globalThis.String(object.token) : "",
3828
+ refreshToken: isSet(object.refreshToken)
3829
+ ? globalThis.String(object.refreshToken)
3830
+ : "",
3831
+ userId: isSet(object.userId) ? globalThis.String(object.userId) : "",
3832
+ isRemember: isSet(object.isRemember)
3833
+ ? globalThis.Boolean(object.isRemember)
3834
+ : false,
3835
+ apiUrl: isSet(object.apiUrl) ? globalThis.String(object.apiUrl) : "",
3836
+ idToken: isSet(object.idToken)
3837
+ ? globalThis.String(object.idToken)
3838
+ : "",
3839
+ };
3840
+ },
3841
+
3842
+ toJSON(message: Session): unknown {
3843
+ const obj: any = {};
3844
+ if (message.created !== false) {
3845
+ obj.created = message.created;
3846
+ }
3847
+ if (message.token !== "") {
3848
+ obj.token = message.token;
3849
+ }
3850
+ if (message.refreshToken !== "") {
3851
+ obj.refreshToken = message.refreshToken;
3852
+ }
3853
+ if (message.userId !== "") {
3854
+ obj.userId = message.userId;
3855
+ }
3856
+ if (message.isRemember !== false) {
3857
+ obj.isRemember = message.isRemember;
3858
+ }
3859
+ if (message.apiUrl !== "") {
3860
+ obj.apiUrl = message.apiUrl;
3861
+ }
3862
+ if (message.idToken !== "") {
3863
+ obj.idToken = message.idToken;
3864
+ }
3865
+ return obj;
3866
+ },
3867
+
3868
+ create<I extends Exact<DeepPartial<Session>, I>>(base?: I): Session {
3869
+ return Session.fromPartial(base ?? ({} as any));
3870
+ },
3871
+
3872
+ fromPartial<I extends Exact<DeepPartial<Session>, I>>(object: I): Session {
3873
+ const message = createBaseSession();
3874
+ message.created = object.created ?? false;
3875
+ message.token = object.token ?? "";
3876
+ message.refreshToken = object.refreshToken ?? "";
3877
+ message.userId = object.userId ?? "";
3878
+ message.isRemember = object.isRemember ?? false;
3879
+ message.apiUrl = object.apiUrl ?? "";
3880
+ message.idToken = object.idToken ?? "";
3881
+ return message;
3882
+ },
3883
+ };