-
Notifications
You must be signed in to change notification settings - Fork 0
/
schema.ts
3523 lines (3519 loc) · 93.9 KB
/
schema.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/": {
/** Fetch the server configuration for this Revolt instance. */
get: operations["root_root"];
};
"/users/@me": {
/** Retrieve your user information. */
get: operations["fetch_self_req"];
/** Edit currently authenticated user. */
patch: operations["edit_user_req"];
};
"/users/{target}": {
/** Retrieve a user's information. */
get: operations["fetch_user_req"];
};
"/users/@me/username": {
/** Change your username. */
patch: operations["change_username_req"];
};
"/users/{target}/default_avatar": {
/** This returns a default avatar based on the given id. */
get: operations["get_default_avatar_req"];
};
"/users/{target}/profile": {
/**
* Retrieve a user's profile data.
*
* Will fail if you do not have permission to access the other user's profile.
*/
get: operations["fetch_profile_req"];
};
"/users/dms": {
/** This fetches your direct messages, including any DM and group DM conversations. */
get: operations["fetch_dms_req"];
};
"/users/{target}/dm": {
/**
* Open a DM with another user.
*
* If the target is oneself, a saved messages channel is returned.
*/
get: operations["open_dm_req"];
};
"/users/{target}/mutual": {
/** Retrieve a list of mutual friends and servers with another user. */
get: operations["find_mutual_req"];
};
"/users/{username}/friend": {
/** Send a friend request to another user or accept another user's friend request. */
put: operations["add_friend_req"];
};
"/users/{target}/friend": {
/** Denies another user's friend request or removes an existing friend. */
delete: operations["remove_friend_req"];
};
"/users/{target}/block": {
/** Block another user by their id. */
put: operations["block_user_req"];
/** Unblock another user by their id. */
delete: operations["unblock_user_req"];
};
"/bots/create": {
/** Create a new Revolt bot. */
post: operations["create_create_bot"];
};
"/bots/{target}/invite": {
/** Fetch details of a public (or owned) bot by its id. */
get: operations["fetch_public_fetch_public_bot"];
/** Invite a bot to a server or group by its id.` */
post: operations["invite_invite_bot"];
};
"/bots/{target}": {
/** Fetch details of a bot you own by its id. */
get: operations["fetch_fetch_bot"];
/** Delete a bot by its id. */
delete: operations["delete_delete_bot"];
/** Edit bot details by its id. */
patch: operations["edit_edit_bot"];
};
"/bots/@me": {
/** Fetch all of the bots that you have control over. */
get: operations["fetch_owned_fetch_owned_bots"];
};
"/channels/{target}/ack/{message}": {
/** Lets the server and all other clients know that we've seen this message id in this channel. */
put: operations["channel_ack_req"];
};
"/channels/{target}": {
/** Fetch channel by its id. */
get: operations["channel_fetch_req"];
/** Deletes a server channel, leaves a group or closes a group. */
delete: operations["channel_delete_req"];
/** Edit a channel object by its id. */
patch: operations["channel_edit_req"];
};
"/channels/{target}/members": {
/** Retrieves all users who are part of this group. */
get: operations["members_fetch_req"];
};
"/channels/{target}/invites": {
/**
* Creates an invite to this channel.
*
* Channel must be a `TextChannel`.
*/
post: operations["invite_create_req"];
};
"/channels/{target}/messages": {
/** Fetch multiple messages. */
get: operations["message_query_req"];
/** Sends a message to the given channel. */
post: operations["message_send_message_send"];
};
"/channels/{target}/search": {
/** This route searches for messages within the given parameters. */
post: operations["message_search_req"];
};
"/channels/{_target}/messages/stale": {
/**
* This route returns any changed message objects and tells you if any have been deleted.
*
* Don't actually poll this route, instead use this to update your local database.
*
* **DEPRECATED**
*/
post: operations["message_query_stale_req"];
};
"/channels/{target}/messages/{msg}": {
/** Retrieves a message by its id. */
get: operations["message_fetch_req"];
/** Delete a message you've sent or one you have permission to delete. */
delete: operations["message_delete_req"];
/** Edits a message that you've previously sent. */
patch: operations["message_edit_req"];
};
"/channels/create": {
/** Create a new group channel. */
post: operations["group_create_req"];
};
"/channels/{target}/recipients/{member}": {
/** Adds another user to the group. */
put: operations["group_add_member_req"];
/** Removes a user from the group. */
delete: operations["group_remove_member_req"];
};
"/channels/{_target}/join_call": {
/** Asks the voice server for a token to join the call. */
post: operations["voice_join_req"];
};
"/channels/{target}/permissions/{role_id}": {
/**
* Sets permissions for the specified role in this channel.
*
* Channel must be a `TextChannel` or `VoiceChannel`.
*/
put: operations["permissions_set_req"];
};
"/channels/{target}/permissions/default": {
/**
* Sets permissions for the default role in this channel.
*
* Channel must be a `Group`, `TextChannel` or `VoiceChannel`.
*/
put: operations["permissions_set_default_req"];
};
"/servers/create": {
/** Create a new server. */
post: operations["server_create_req"];
};
"/servers/{target}": {
/** Fetch a server by its id. */
get: operations["server_fetch_req"];
/** Deletes a server if owner otherwise leaves. */
delete: operations["server_delete_req"];
/** Edit a server by its id. */
patch: operations["server_edit_req"];
};
"/servers/{target}/ack": {
/** Mark all channels in a server as read. */
put: operations["server_ack_req"];
};
"/servers/{target}/channels": {
/** Create a new Text or Voice channel. */
post: operations["channel_create_req"];
};
"/servers/{target}/members": {
/** Fetch all server members. */
get: operations["member_fetch_all_req"];
};
"/servers/{target}/members/{member}": {
/** Retrieve a member. */
get: operations["member_fetch_req"];
/** Removes a member from the server. */
delete: operations["member_remove_req"];
};
"/servers/{server}/members/{target}": {
/** Edit a member by their id. */
patch: operations["member_edit_req"];
};
"/servers/{server}/bans/{target}": {
/** Ban a user by their id. */
put: operations["ban_create_req"];
/** Remove a user's ban. */
delete: operations["ban_remove_req"];
};
"/servers/{target}/bans": {
/** Fetch all bans on a server. */
get: operations["ban_list_req"];
};
"/servers/{target}/invites": {
/** Fetch all server invites. */
get: operations["invites_fetch_req"];
};
"/servers/{target}/roles": {
/** Creates a new server role. */
post: operations["roles_create_req"];
};
"/servers/{target}/roles/{role_id}": {
/** Delete a server role by its id. */
delete: operations["roles_delete_req"];
/** Edit a role by its id. */
patch: operations["roles_edit_req"];
};
"/servers/{target}/permissions/{role_id}": {
/** Sets permissions for the specified role in the server. */
put: operations["permissions_set_req"];
};
"/servers/{target}/permissions/default": {
/** Sets permissions for the default role in this server. */
put: operations["permissions_set_default_req"];
};
"/invites/{target}": {
/** Fetch an invite by its id. */
get: operations["invite_fetch_req"];
/** Join an invite by its ID. */
post: operations["invite_join_req"];
/** Delete an invite by its id. */
delete: operations["invite_delete_req"];
};
"/auth/account/create": {
/** Create a new account. */
post: operations["create_account_create_account"];
};
"/auth/account/reverify": {
/** Resend account creation verification email. */
post: operations["resend_verification_resend_verification"];
};
"/auth/account/": {
/** Fetch account information from the current session. */
get: operations["fetch_account_fetch_account"];
};
"/auth/account/change/password": {
/** Change the current account password. */
patch: operations["change_password_change_password"];
};
"/auth/account/change/email": {
/** Change the associated account email. */
patch: operations["change_email_change_email"];
};
"/auth/account/verify/{code}": {
/** Verify an email address. */
post: operations["verify_email_verify_email"];
};
"/auth/account/reset_password": {
/** Send an email to reset account password. */
post: operations["send_password_reset_send_password_reset"];
/** Confirm password reset and change the password. */
patch: operations["password_reset_password_reset"];
};
"/auth/session/login": {
/** Login to an account. */
post: operations["login_login"];
};
"/auth/session/logout": {
/** Delete current session. */
post: operations["logout_logout"];
};
"/auth/session/all": {
/** Fetch all sessions associated with this account. */
get: operations["fetch_all_fetch_all"];
/** Delete all active sessions, optionally including current one. */
delete: operations["revoke_all_revoke_all"];
};
"/auth/session/{id}": {
/** Delete a specific active session. */
delete: operations["revoke_revoke"];
/** Edit current session information. */
patch: operations["edit_edit"];
};
"/onboard/hello": {
/** This will tell you whether the current account requires onboarding or whether you can continue to send requests as usual. You may skip calling this if you're restoring an existing session. */
get: operations["hello_req"];
};
"/onboard/complete": {
/** This sets a new username, completes onboarding and allows a user to start using Revolt. */
post: operations["complete_req"];
};
"/push/subscribe": {
/**
* Create a new Web Push subscription.
*
* If an existing subscription exists on this session, it will be removed.
*/
post: operations["subscribe_req"];
};
"/push/unsubscribe": {
/** Remove the Web Push subscription associated with the current session. */
post: operations["unsubscribe_req"];
};
"/sync/settings/fetch": {
/**
* Fetch settings from server filtered by keys.
*
* This will return an object with the requested keys, each value is a tuple of `(timestamp, value)`, the value is the previously uploaded data.
*/
post: operations["get_settings_req"];
};
"/sync/settings/set": {
/** Upload data to save to settings. */
post: operations["set_settings_req"];
};
"/sync/unreads": {
/** Fetch information about unread state on channels. */
get: operations["get_unreads_req"];
};
}
export interface components {
schemas: {
/** Server Configuration */
RevoltConfig: {
/** @description Revolt API Version */
revolt: string;
/** @description Features enabled on this Revolt node */
features: components["schemas"]["RevoltFeatures"];
/** @description WebSocket URL */
ws: string;
/** @description URL pointing to the client serving this node */
app: string;
/** @description Web Push VAPID public key */
vapid: string;
};
/** Feature Configuration */
RevoltFeatures: {
/** @description hCaptcha configuration */
captcha: components["schemas"]["CaptchaFeature"];
/** @description Whether email verification is enabled */
email: boolean;
/** @description Whether this server is invite only */
invite_only: boolean;
/** @description File server service configuration */
autumn: components["schemas"]["Feature"];
/** @description Proxy service configuration */
january: components["schemas"]["Feature"];
/** @description Voice server configuration */
voso: components["schemas"]["VoiceFeature"];
};
/** hCaptcha Configuration */
CaptchaFeature: {
/** @description Whether captcha is enabled */
enabled: boolean;
/** @description Client key used for solving captcha */
key: string;
};
/** Generic Service Configuration */
Feature: {
/** @description Whether the service is enabled */
enabled: boolean;
/** @description URL pointing to the service */
url: string;
};
/** Voice Server Configuration */
VoiceFeature: {
/** @description Whether voice is enabled */
enabled: boolean;
/** @description URL pointing to the voice API */
url: string;
/** @description URL pointing to the voice WebSocket server */
ws: string;
};
/**
* @description Permission value on Revolt
*
* This should be restricted to the lower 52 bits to prevent any potential issues with Javascript. Also leave empty spaces for future permission flags to be added.
* @enum {string}
*/
Permission:
| "ManageChannel"
| "ManageServer"
| "ManagePermissions"
| "ManageRole"
| "KickMembers"
| "BanMembers"
| "TimeoutMembers"
| "AssignRoles"
| "ChangeNickname"
| "ManageNicknames"
| "ChangeAvatar"
| "RemoveAvatars"
| "ViewChannel"
| "ReadMessageHistory"
| "SendMessage"
| "ManageMessages"
| "ManageWebhooks"
| "InviteOthers"
| "SendEmbeds"
| "UploadFiles"
| "Masquerade"
| "Connect"
| "Speak"
| "Video"
| "MuteMembers"
| "DeafenMembers"
| "MoveMembers"
| "GrantAllSafe"
| "GrantAll";
/** @enum {string} */
UserPermission: "Access" | "ViewProfile" | "SendMessage" | "Invite";
/** Error */
Error:
| {
/** @enum {string} */
type: "LabelMe";
}
| {
/** @enum {string} */
type: "AlreadyOnboarded";
}
| {
/** @enum {string} */
type: "UsernameTaken";
}
| {
/** @enum {string} */
type: "UnknownUser";
}
| {
/** @enum {string} */
type: "AlreadyFriends";
}
| {
/** @enum {string} */
type: "AlreadySentRequest";
}
| {
/** @enum {string} */
type: "Blocked";
}
| {
/** @enum {string} */
type: "BlockedByOther";
}
| {
/** @enum {string} */
type: "NotFriends";
}
| {
/** @enum {string} */
type: "UnknownChannel";
}
| {
/** @enum {string} */
type: "UnknownAttachment";
}
| {
/** @enum {string} */
type: "UnknownMessage";
}
| {
/** @enum {string} */
type: "CannotEditMessage";
}
| {
/** @enum {string} */
type: "CannotJoinCall";
}
| {
/** @enum {string} */
type: "TooManyAttachments";
}
| {
/** @enum {string} */
type: "TooManyReplies";
}
| {
/** @enum {string} */
type: "EmptyMessage";
}
| {
/** @enum {string} */
type: "CannotRemoveYourself";
}
| {
/** @enum {string} */
type: "GroupTooLarge";
/** Format: uint */
max: number;
}
| {
/** @enum {string} */
type: "AlreadyInGroup";
}
| {
/** @enum {string} */
type: "NotInGroup";
}
| {
/** @enum {string} */
type: "UnknownServer";
}
| {
/** @enum {string} */
type: "InvalidRole";
}
| {
/** @enum {string} */
type: "Banned";
}
| {
/** @enum {string} */
type: "TooManyServers";
/** Format: uint */
max: number;
}
| {
/** @enum {string} */
type: "ReachedMaximumBots";
}
| {
/** @enum {string} */
type: "IsBot";
}
| {
/** @enum {string} */
type: "BotIsPrivate";
}
| {
/** @enum {string} */
type: "MissingPermission";
permission: components["schemas"]["Permission"];
}
| {
/** @enum {string} */
type: "MissingUserPermission";
permission: components["schemas"]["UserPermission"];
}
| {
/** @enum {string} */
type: "NotElevated";
}
| {
/** @enum {string} */
type: "CannotGiveMissingPermissions";
}
| {
/** @enum {string} */
type: "DatabaseError";
operation: string;
with: string;
}
| {
/** @enum {string} */
type: "InternalError";
}
| {
/** @enum {string} */
type: "InvalidOperation";
}
| {
/** @enum {string} */
type: "InvalidCredentials";
}
| {
/** @enum {string} */
type: "InvalidSession";
}
| {
/** @enum {string} */
type: "DuplicateNonce";
}
| {
/** @enum {string} */
type: "VosoUnavailable";
}
| {
/** @enum {string} */
type: "NotFound";
}
| {
/** @enum {string} */
type: "NoEffect";
}
| {
/** @enum {string} */
type: "FailedValidation";
};
/** @description Representiation of a User on Revolt. */
User: {
/** @description Unique Id */
_id: string;
/** @description Username */
username: string;
/** @description Avatar attachment */
avatar?: components["schemas"]["File"] | null;
/** @description Relationships with other users */
relations?: components["schemas"]["Relationship"][] | null;
/**
* Format: int32
* @description Bitfield of user badges
*/
badges?: number | null;
/** @description User's current status */
status?: components["schemas"]["UserStatus"] | null;
/** @description User's profile page */
profile?: components["schemas"]["UserProfile"] | null;
/**
* Format: int32
* @description Enum of user flags
*/
flags?: number | null;
/** @description Bot information */
bot?: components["schemas"]["BotInformation"] | null;
/** @description Current session user's relationship with this user */
relationship?: components["schemas"]["RelationshipStatus"] | null;
/** @description Whether this user is currently online */
online?: boolean | null;
};
/** @description Representation of a File on Revolt Generated by Autumn */
File: {
/** @description Unique Id */
_id: string;
/** @description Tag / bucket this file was uploaded to */
tag: string;
/** @description Original filename */
filename: string;
/** @description Parsed metadata of this file */
metadata: components["schemas"]["Metadata"];
/** @description Raw content type of this file */
content_type: string;
/**
* Format: int
* @description Size of this file (in bytes)
*/
size: number;
/** @description Whether this file was deleted */
deleted?: boolean | null;
/** @description Whether this file was reported */
reported?: boolean | null;
message_id?: string | null;
user_id?: string | null;
server_id?: string | null;
/** @description Id of the object this file is associated with */
object_id?: string | null;
};
/** @description Metadata associated with file */
Metadata:
| {
/** @enum {string} */
type: "File";
}
| {
/** @enum {string} */
type: "Text";
}
| {
/** @enum {string} */
type: "Image";
/** Format: int */
width: number;
/** Format: int */
height: number;
}
| {
/** @enum {string} */
type: "Video";
/** Format: int */
width: number;
/** Format: int */
height: number;
}
| {
/** @enum {string} */
type: "Audio";
};
/** @description Relationship entry indicating current status with other user */
Relationship: {
_id: string;
status: components["schemas"]["RelationshipStatus"];
};
/**
* @description User's relationship with another user (or themselves)
* @enum {string}
*/
RelationshipStatus:
| "None"
| "User"
| "Friend"
| "Outgoing"
| "Incoming"
| "Blocked"
| "BlockedOther";
/** @description User's active status */
UserStatus: {
/** @description Custom status text */
text?: string | null;
/** @description Current presence option */
presence?: components["schemas"]["Presence"] | null;
};
/**
* @description Presence status
* @enum {string}
*/
Presence: "Online" | "Idle" | "Busy" | "Invisible";
/** @description User's profile */
UserProfile: {
/** @description Text content on user's profile */
content?: string | null;
/** @description Background visible on user's profile */
background?: components["schemas"]["File"] | null;
};
/** @description Bot information for if the user is a bot */
BotInformation: {
/** @description Id of the owner of this bot */
owner: string;
};
Id: string;
/** User Data */
DataEditUser: {
/** @description New user status */
status?: components["schemas"]["UserStatus"] | null;
/**
* @description New user profile data
*
* This is applied as a partial.
*/
profile?: components["schemas"]["UserProfileData"] | null;
/** @description Attachment Id for avatar */
avatar?: string | null;
/** @description Fields to remove from user object */
remove?: components["schemas"]["FieldsUser"][] | null;
};
/** Profile Data */
UserProfileData: {
/** @description Text to set as user profile description */
content?: string | null;
/** @description Attachment Id for background */
background?: string | null;
};
/**
* @description Optional fields on user object
* @enum {string}
*/
FieldsUser:
| "Avatar"
| "StatusText"
| "StatusPresence"
| "ProfileContent"
| "ProfileBackground";
/** Username Information */
DataChangeUsername: {
/** @description New username */
username: string;
/** @description Current account password */
password: string;
};
/** @description Representation of a channel on Revolt */
Channel:
| {
/** @enum {string} */
channel_type: "SavedMessages";
/** @description Unique Id */
_id: string;
/** @description Id of the user this channel belongs to */
user: string;
}
| {
/** @enum {string} */
channel_type: "DirectMessage";
/** @description Unique Id */
_id: string;
/** @description Whether this direct message channel is currently open on both sides */
active: boolean;
/** @description 2-tuple of user ids participating in direct message */
recipients: string[];
/** @description Id of the last message sent in this channel */
last_message_id?: string | null;
}
| {
/** @enum {string} */
channel_type: "Group";
/** @description Unique Id */
_id: string;
/** @description Display name of the channel */
name: string;
/** @description User id of the owner of the group */
owner: string;
/** @description Channel description */
description?: string | null;
/** @description Array of user ids participating in channel */
recipients: string[];
/** @description Custom icon attachment */
icon?: components["schemas"]["File"] | null;
/** @description Id of the last message sent in this channel */
last_message_id?: string | null;
/**
* Format: int64
* @description Permissions assigned to members of this group (does not apply to the owner of the group)
*/
permissions?: number | null;
/** @description Whether this group is marked as not safe for work */
nsfw?: boolean;
}
| {
/** @enum {string} */
channel_type: "TextChannel";
/** @description Unique Id */
_id: string;
/** @description Id of the server this channel belongs to */
server: string;
/** @description Display name of the channel */
name: string;
/** @description Channel description */
description?: string | null;
/** @description Custom icon attachment */
icon?: components["schemas"]["File"] | null;
/** @description Id of the last message sent in this channel */
last_message_id?: string | null;
/** @description Default permissions assigned to users in this channel */
default_permissions?: components["schemas"]["OverrideField"] | null;
/** @description Permissions assigned based on role to this channel */
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
/** @description Whether this channel is marked as not safe for work */
nsfw?: boolean;
}
| {
/** @enum {string} */
channel_type: "VoiceChannel";
/** @description Unique Id */
_id: string;
/** @description Id of the server this channel belongs to */
server: string;
/** @description Display name of the channel */
name: string;
/** @description Channel description */
description?: string | null;
/** @description Custom icon attachment */
icon?: components["schemas"]["File"] | null;
/** @description Default permissions assigned to users in this channel */
default_permissions?: components["schemas"]["OverrideField"] | null;
/** @description Permissions assigned based on role to this channel */
role_permissions?: {
[key: string]: components["schemas"]["OverrideField"];
};
/** @description Whether this channel is marked as not safe for work */
nsfw?: boolean;
};
/** @description Representation of a single permission override as it appears on models and in the database */
OverrideField: {
/**
* Format: int64
* @description Allow bit flags
*/
a: number;
/**
* Format: int64
* @description Disallow bit flags
*/
d: number;
/**
* Format: int64
* @description Ranking of this override
*/
r?: number | null;
};
/** Mutual Friends and Servers Response */
MutualResponse: {
/** @description Array of mutual user IDs that both users are friends with */
users: string[];
/** @description Array of mutual server IDs that both users are in */
servers: string[];
};
/** @description Representation of a bot on Revolt */
Bot: {
/**
* @description Bot Id
*
* This equals the associated bot user's id.
*/
_id: string;
/** @description User Id of the bot owner */
owner: string;
/** @description Token used to authenticate requests for this bot */
token: string;
/** @description Whether the bot is public (may be invited by anyone) */
public: boolean;
/** @description Whether to enable analytics */
analytics?: boolean;
/** @description Whether this bot should be publicly discoverable */
discoverable?: boolean;
/** @description Reserved; URL for handling interactions */
interactions_url?: string | null;
};
/** Bot Details */
DataCreateBot: {
/** @description Bot username */
name: string;
};
/** Invite Destination */
InviteBotDestination: Partial<{
/** @description Server Id */
server: string;
}> &
Partial<{
/** @description Group Id */
group: string;
}>;
/** Public Bot */
PublicBot: {
/** @description Bot Id */
_id: string;
/** @description Bot Username */
username: string;
/** @description Profile Avatar */
avatar?: components["schemas"]["File"] | null;
/** @description Profile Description */
description?: string | null;
};
/** Bot Response */
BotResponse: {
/** @description Bot object */
bot: components["schemas"]["Bot"];
/** @description User object */
user: components["schemas"]["User"];
};
/**
* Owned Bots Response
* @description Both lists are sorted by their IDs.
*/
OwnedBotsResponse: {
/** @description Bot objects */
bots: components["schemas"]["Bot"][];
/** @description User objects */
users: components["schemas"]["User"][];
};
/** Bot Details */
DataEditBot: {
/** @description Bot username */
name?: string | null;
/** @description Whether the bot can be added by anyone */
public?: boolean | null;
/**
* @description Whether analytics should be gathered for this bot
*
* Must be enabled in order to show up on [Revolt Discover](https://rvlt.gg).
*/
analytics?: boolean | null;
/** @description Interactions URL */
interactions_url?: string | null;
/** @description Fields to remove from bot object */
remove?: components["schemas"]["FieldsBot"][] | null;
};
/**
* @description Optional fields on bot object
* @enum {string}
*/
FieldsBot: "Token" | "InteractionsURL";
/** Channel Details */
DataEditChannel: {
/** @description Channel name */
name?: string | null;
/** @description Channel description */
description?: string | null;
/**
* @description Icon
*
* Provide an Autumn attachment Id.
*/
icon?: string | null;
/** @description Whether this channel is age-restricted */
nsfw?: boolean | null;
remove?: components["schemas"]["FieldsChannel"][] | null;
};
/**
* @description Optional fields on channel object
* @enum {string}
*/
FieldsChannel: "Description" | "Icon" | "DefaultPermissions";
/** @description Representation of an invite to a channel on Revolt */
Invite:
| {
/** @enum {string} */
type: "Server";
/** @description Invite code */