-
Notifications
You must be signed in to change notification settings - Fork 548
Expand file tree
/
Copy pathopenapi.ts
More file actions
5455 lines (5446 loc) · 153 KB
/
Copy pathopenapi.ts
File metadata and controls
5455 lines (5446 loc) · 153 KB
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.
*/
/** OneOf type helpers */
type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
type XOR<T, U> = (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
type OneOf<T extends any[]> = T extends [infer Only] ? Only : T extends [infer A, infer B, ...infer Rest] ? OneOf<[XOR<A, B>, ...Rest]> : never;
export type paths = {
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/avatar": {
/** Get the avatar of a room */
get: operations["avatar-get-avatar"];
/** Upload an avatar for a room */
post: operations["avatar-upload-avatar"];
/** Delete the avatar of a room */
delete: operations["avatar-delete-avatar"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/avatar/emoji": {
/** Set an emoji as avatar */
post: operations["avatar-emoji-avatar"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/avatar/dark": {
/** Get the dark mode avatar of a room */
get: operations["avatar-get-avatar-dark"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/bot/{token}": {
/** List bots */
get: operations["bot-list-bots"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/bot/{token}/{botId}": {
/** Enables a bot */
post: operations["bot-enable-bot"];
/** Disables a bot */
delete: operations["bot-disable-bot"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/breakout-rooms/{token}": {
/** Configure the breakout rooms */
post: operations["breakout_room-configure-breakout-rooms"];
/** Remove the breakout rooms */
delete: operations["breakout_room-remove-breakout-rooms"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/breakout-rooms/{token}/broadcast": {
/** Broadcast a chat message to all breakout rooms */
post: operations["breakout_room-broadcast-chat-message"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/breakout-rooms/{token}/attendees": {
/** Apply an attendee map to the breakout rooms */
post: operations["breakout_room-apply-attendee-map"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/breakout-rooms/{token}/request-assistance": {
/** Request assistance */
post: operations["breakout_room-request-assistance"];
/** Reset the request for assistance */
delete: operations["breakout_room-reset-request-for-assistance"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/breakout-rooms/{token}/rooms": {
/** Start the breakout rooms */
post: operations["breakout_room-start-breakout-rooms"];
/** Stop the breakout rooms */
delete: operations["breakout_room-stop-breakout-rooms"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/breakout-rooms/{token}/switch": {
/** Switch to another breakout room */
post: operations["breakout_room-switch-breakout-room"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/call/{token}": {
/** Get the peers for a call */
get: operations["call-get-peers-for-call"];
/** Update the in-call flags */
put: operations["call-update-call-flags"];
/** Join a call */
post: operations["call-join-call"];
/** Leave a call */
delete: operations["call-leave-call"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/call/{token}/ring/{attendeeId}": {
/** Ring an attendee */
post: operations["call-ring-attendee"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/call/{token}/dialout/{attendeeId}": {
/** Call a SIP dial-out attendee */
post: operations["call-sip-dial-out"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}": {
/**
* Receives chat messages from the given room
* @description - Receiving the history ($lookIntoFuture=0): The next $limit messages after $lastKnownMessageId will be returned. The new $lastKnownMessageId for the follow up query is available as `X-Chat-Last-Given` header.
* - Looking into the future ($lookIntoFuture=1): If there are currently no messages the response will not be sent immediately. Instead, HTTP connection will be kept open waiting for new messages to arrive and, when they do, then the response will be sent. The connection will not be kept open indefinitely, though; the number of seconds to wait for new messages to arrive can be set using the timeout parameter; the default timeout is 30 seconds, maximum timeout is 60 seconds. If the timeout ends a successful but empty response will be sent. If messages have been returned (status=200) the new $lastKnownMessageId for the follow up query is available as `X-Chat-Last-Given` header.
* The limit specifies the maximum number of messages that will be returned, although the actual number of returned messages could be lower if some messages are not visible to the participant. Note that if none of the messages are visible to the participant the returned number of messages will be 0, yet the status will still be 200. Also note that `X-Chat-Last-Given` may reference a message not visible and thus not returned, but it should be used nevertheless as the $lastKnownMessageId for the follow-up query.
*/
get: operations["chat-receive-messages"];
/**
* Sends a new chat message to the given room
* @description The author and timestamp are automatically set to the current user/guest and time.
*/
post: operations["chat-send-message"];
/** Clear the chat history */
delete: operations["chat-clear-history"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/{messageId}": {
/** Edit a chat message */
put: operations["chat-edit-message"];
/** Delete a chat message */
delete: operations["chat-delete-message"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/{messageId}/context": {
/** Get the context of a message */
get: operations["chat-get-message-context"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/{messageId}/reminder": {
/** Get the reminder for a chat message */
get: operations["chat-get-reminder"];
/** Set a reminder for a chat message */
post: operations["chat-set-reminder"];
/** Delete a chat reminder */
delete: operations["chat-delete-reminder"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/read": {
/** Set the read marker to a specific message */
post: operations["chat-set-read-marker"];
/** Mark a chat as unread */
delete: operations["chat-mark-unread"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/mentions": {
/** Search for mentions */
get: operations["chat-mentions"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/share": {
/** Get objects that are shared in the room */
get: operations["chat-get-objects-shared-in-room"];
/**
* Sends a rich-object to the given room
* @description The author and timestamp are automatically set to the current user/guest and time.
*/
post: operations["chat-share-object-to-chat"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/share/overview": {
/** Get objects that are shared in the room overview */
get: operations["chat-get-objects-shared-in-room-overview"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/file/{fileId}": {
/**
* Get the token of the room associated to the given file id
* @description This is the counterpart of self::getRoomByShareToken() for file ids instead of share tokens, although both return the same room token if the given file id and share token refer to the same file.
* If there is no room associated to the given file id a new room is created; the new room is a public room associated with a "file" object with the given file id. Unlike normal rooms in which the owner is the user that created the room these are special rooms without owner (although self joined users with direct access to the file become persistent participants automatically when they join until they explicitly leave or no longer have access to the file).
* In any case, to create or even get the token of the room, the file must be shared and the user must be the owner of a public share of the file (like a link share, for example) or have direct access to that file; an error is returned otherwise. A user has direct access to a file if she has access to it (or to an ancestor) through a user, group, circle or room share (but not through a link share, for example), or if she is the owner of such a file.
*/
get: operations["files_integration-get-room-by-file-id"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/publicshare/{shareToken}": {
/**
* Returns the token of the room associated to the file of the given share token
* @description This is the counterpart of self::getRoomByFileId() for share tokens instead of file ids, although both return the same room token if the given file id and share token refer to the same file.
* If there is no room associated to the file id of the given share token a new room is created; the new room is a public room associated with a "file" object with the file id of the given share token. Unlike normal rooms in which the owner is the user that created the room these are special rooms without owner (although self joined users with direct access to the file become persistent participants automatically when they join until they explicitly leave or no longer have access to the file).
* In any case, to create or even get the token of the room, the file must be publicly shared (like a link share, for example); an error is returned otherwise.
* Besides the token of the room this also returns the current user ID and display name, if any; this is needed by the Talk sidebar to know the actual current user, as the public share page uses the incognito mode and thus logged-in users as seen as guests.
*/
get: operations["files_integration-get-room-by-share-token"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/guest/{token}/name": {
/** Set the display name as a guest */
post: operations["guest-set-display-name"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/bridge/{token}": {
/** Get bridge information of one room */
get: operations["matterbridge-get-bridge-of-room"];
/** Edit bridge information of one room */
put: operations["matterbridge-edit-bridge-of-room"];
/** Delete bridge of one room */
delete: operations["matterbridge-delete-bridge-of-room"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/bridge/{token}/process": {
/** Get bridge process information */
get: operations["matterbridge-get-bridge-process-state"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/poll/{token}": {
/** Create a poll */
post: operations["poll-create-poll"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/poll/{token}/{pollId}": {
/** Get a poll */
get: operations["poll-show-poll"];
/** Vote on a poll */
post: operations["poll-vote-poll"];
/** Close a poll */
delete: operations["poll-close-poll"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/publicshareauth": {
/**
* Creates a new room for video verification (requesting the password of a share)
* @description The new room is a public room associated with a "share:password" object with the ID of the share token. Unlike normal rooms in which the owner is the user that created the room these are special rooms always created by a guest or user on behalf of a registered user, the sharer, who will be the owner of the room.
* The share must have "send password by Talk" enabled; an error is returned otherwise.
*/
post: operations["files_integration-create-room"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/reaction/{token}/{messageId}": {
/** Get a list of reactions for a message */
get: operations["reaction-get-reactions"];
/** Add a reaction to a message */
post: operations["reaction-react"];
/** Delete a reaction from a message */
delete: operations["reaction-delete"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/recording/{token}": {
/** Start the recording */
post: operations["recording-start"];
/** Stop the recording */
delete: operations["recording-stop"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/recording/{token}/notification": {
/** Dismiss the store call recording notification */
delete: operations["recording-notification-dismiss"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/recording/{token}/share-chat": {
/** Share the recorded file to the chat */
post: operations["recording-share-to-chat"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room": {
/** Get all currently existent rooms which the user has joined */
get: operations["room-get-rooms"];
/** Create a room with a user, a group or a circle */
post: operations["room-create-room"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/listed-room": {
/** Get listed rooms with optional search term */
get: operations["room-get-listed-rooms"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/note-to-self": {
/**
* Get the "Note to self" conversation for the user
* @description It will be automatically created when it is currently missing
*/
get: operations["room-get-note-to-self-conversation"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}": {
/** Get a room */
get: operations["room-get-single-room"];
/** Rename a room */
put: operations["room-rename-room"];
/** Delete a room */
delete: operations["room-delete-room"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/breakout-rooms": {
/**
* Get breakout rooms
* @description All for moderators and in case of "free selection", or the assigned breakout room for other participants
*/
get: operations["room-get-breakout-rooms"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/public": {
/** Allowed guests to join conversation */
post: operations["room-make-public"];
/** Disallowed guests to join conversation */
delete: operations["room-make-private"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/description": {
/** Update the description of a room */
put: operations["room-set-description"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/read-only": {
/** Set read-only state of a room */
put: operations["room-set-read-only"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/listable": {
/** Make a room listable */
put: operations["room-set-listable"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/password": {
/** Set a password for a room */
put: operations["room-set-password"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/permissions/{mode}": {
/** Update the permissions of a room */
put: operations["room-set-permissions"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/participants": {
/** Get a list of participants for a room */
get: operations["room-get-participants"];
/** Add a participant to a room */
post: operations["room-add-participant-to-room"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/breakout-rooms/participants": {
/** Get the breakout room participants for a room */
get: operations["room-get-breakout-room-participants"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/participants/self": {
/** Remove the current user from a room */
delete: operations["room-remove-self-from-room"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/attendees": {
/** Remove an attendee from a room */
delete: operations["room-remove-attendee-from-room"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/attendees/permissions": {
/** Update the permissions of an attendee */
put: operations["room-set-attendee-permissions"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/attendees/permissions/all": {
/** Update the permissions of all attendees */
put: operations["room-set-all-attendees-permissions"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/participants/active": {
/** Join a room */
post: operations["room-join-room"];
/** Leave a room */
delete: operations["room-leave-room"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/participants/resend-invitations": {
/** Resend invitations */
post: operations["room-resend-invitations"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/participants/state": {
/** Set active state for a session */
put: operations["room-set-session-state"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/moderators": {
/** Promote an attendee to moderator */
post: operations["room-promote-moderator"];
/** Demote an attendee from moderator */
delete: operations["room-demote-moderator"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/favorite": {
/** Add a room to the favorites */
post: operations["room-add-to-favorites"];
/** Remove a room from the favorites */
delete: operations["room-remove-from-favorites"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/notify": {
/** Update the notification level for a room */
post: operations["room-set-notification-level"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/notify-calls": {
/** Update call notifications */
post: operations["room-set-notification-calls"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/webinar/lobby": {
/** Update the lobby state for a room */
put: operations["room-set-lobby"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/webinar/sip": {
/** Update SIP enabled state */
put: operations["room-setsip-enabled"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/recording-consent": {
/** Set recording consent requirement for this conversation */
put: operations["room-set-recording-consent"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/message-expiration": {
/** Update message expiration time */
post: operations["room-set-message-expiration"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/room/{token}/capabilities": {
/**
* Get capabilities for a room
* @description See "Capability handling in federated conversations" in https://github.com/nextcloud/spreed/issues/10680 to learn which capabilities should be considered from the local server or from the remote server.
*/
get: operations["room-get-capabilities"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/settings/user": {
/** Update user setting */
post: operations["settings-set-user-setting"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/signaling/settings": {
/** Get the signaling settings */
get: operations["internal_signaling-external_signaling-get-settings"];
};
"/ocs/v2.php/apps/spreed/api/{apiVersion}/signaling/{token}": {
/** Get signaling messages */
get: operations["internal_signaling-pull-messages"];
/** Send signaling messages */
post: operations["internal_signaling-send-messages"];
};
"/ocs/v2.php/apps/spreed/temp-user-avatar": {
/** Upload your avatar as a user */
post: operations["user_avatar-post-avatar"];
/** Delete your avatar as a user */
delete: operations["user_avatar-delete-avatar"];
};
};
export type webhooks = Record<string, never>;
export type components = {
schemas: {
Bot: {
description: string | null;
/** Format: int64 */
id: number;
name: string;
/** Format: int64 */
state: number;
};
CallPeer: {
actorId: string;
actorType: string;
displayName: string;
/** Format: int64 */
lastPing: number;
sessionId: string;
token: string;
};
Capabilities: {
features: string[];
config: {
attachments: {
allowed: boolean;
folder?: string;
};
call: {
enabled: boolean;
"breakout-rooms": boolean;
recording: boolean;
/** Format: int64 */
"recording-consent": number;
"supported-reactions": string[];
"predefined-backgrounds": string[];
"can-upload-background": boolean;
"sip-enabled": boolean;
"sip-dialout-enabled": boolean;
"can-enable-sip": boolean;
};
chat: {
/** Format: int64 */
"max-length": number;
/** Format: int64 */
"read-privacy": number;
"has-translation-providers": boolean;
/** Format: int64 */
"typing-privacy": number;
};
conversations: {
"can-create": boolean;
};
federation: {
enabled: boolean;
"incoming-enabled": boolean;
"outgoing-enabled": boolean;
"only-trusted-servers": boolean;
};
previews: {
/** Format: int64 */
"max-gif-size": number;
};
signaling: {
/** Format: int64 */
"session-ping-limit": number;
"hello-v2-token-key"?: string;
};
};
version: string;
};
ChatMentionSuggestion: {
id: string;
label: string;
source: string;
mentionId: string;
status: string | null;
/** Format: int64 */
statusClearAt: number | null;
statusIcon: string | null;
statusMessage: string | null;
};
ChatMessage: {
actorDisplayName: string;
actorId: string;
actorType: string;
/** @enum {boolean} */
deleted?: true;
/** Format: int64 */
expirationTimestamp: number;
/** Format: int64 */
id: number;
isReplyable: boolean;
markdown: boolean;
message: string;
messageParameters: {
[key: string]: components["schemas"]["RichObjectParameter"];
};
messageType: string;
reactions: {
[key: string]: number;
};
referenceId: string;
systemMessage: string;
/** Format: int64 */
timestamp: number;
token: string;
lastEditActorDisplayName?: string;
lastEditActorId?: string;
lastEditActorType?: string;
/** Format: int64 */
lastEditTimestamp?: number;
silent?: boolean;
};
ChatMessageWithParent: components["schemas"]["ChatMessage"] & {
parent?: components["schemas"]["ChatMessage"];
};
ChatReminder: {
/** Format: int64 */
messageId: number;
/** Format: int64 */
timestamp: number;
token: string;
userId: string;
};
Matterbridge: {
enabled: boolean;
parts: components["schemas"]["MatterbridgeConfigFields"];
/** Format: int64 */
pid: number;
};
MatterbridgeConfigFields: {
[key: string]: Record<string, never>;
}[];
MatterbridgeProcessState: {
log: string;
running: boolean;
};
MatterbridgeWithProcessState: components["schemas"]["Matterbridge"] & components["schemas"]["MatterbridgeProcessState"];
OCSMeta: {
status: string;
statuscode: number;
message?: string;
totalitems?: string;
itemsperpage?: string;
};
Participant: {
actorId: string;
actorType: string;
/** Format: int64 */
attendeeId: number;
/** Format: int64 */
attendeePermissions: number;
attendeePin: string;
displayName: string;
/** Format: int64 */
inCall: number;
/** Format: int64 */
lastPing: number;
/** Format: int64 */
participantType: number;
/** Format: int64 */
permissions: number;
roomToken: string;
sessionIds: string[];
status?: string;
/** Format: int64 */
statusClearAt?: number | null;
statusIcon?: string | null;
statusMessage?: string | null;
phoneNumber?: string | null;
callId?: string | null;
};
Poll: {
actorDisplayName: string;
actorId: string;
actorType: string;
details?: components["schemas"]["PollVote"][];
/** Format: int64 */
id: number;
/** Format: int64 */
maxVotes: number;
/** Format: int64 */
numVoters?: number;
options: string[];
question: string;
/** Format: int64 */
resultMode: number;
/** Format: int64 */
status: number;
votedSelf?: number[];
votes?: {
[key: string]: number;
};
};
PollVote: {
actorDisplayName: string;
actorId: string;
actorType: string;
/** Format: int64 */
optionId: number;
};
PublicCapabilities: OneOf<[{
spreed: components["schemas"]["Capabilities"];
}, unknown[]]>;
Reaction: {
actorDisplayName: string;
actorId: string;
actorType: string;
/** Format: int64 */
timestamp: number;
};
RichObjectParameter: {
type: string;
id: string;
name: string;
server?: string;
link?: string;
/** @enum {string} */
"call-type"?: "one2one" | "group" | "public";
"icon-url"?: string;
"message-id"?: string;
boardname?: string;
stackname?: string;
size?: string;
path?: string;
mimetype?: string;
/** @enum {string} */
"preview-available"?: "yes" | "no";
mtime?: string;
latitude?: string;
longitude?: string;
description?: string;
thumb?: string;
website?: string;
/** @enum {string} */
visibility?: "0" | "1";
/** @enum {string} */
assignable?: "0" | "1";
conversation?: string;
};
Room: {
actorId: string;
actorType: string;
/** Format: int64 */
attendeeId: number;
/** Format: int64 */
attendeePermissions: number;
attendeePin: string | null;
avatarVersion: string;
/** Format: int64 */
breakoutRoomMode: number;
/** Format: int64 */
breakoutRoomStatus: number;
/** Format: int64 */
callFlag: number;
/** Format: int64 */
callPermissions: number;
/** Format: int64 */
callRecording: number;
/** Format: int64 */
callStartTime: number;
canDeleteConversation: boolean;
canEnableSIP: boolean;
canLeaveConversation: boolean;
canStartCall: boolean;
/** Format: int64 */
defaultPermissions: number;
description: string;
displayName: string;
hasCall: boolean;
hasPassword: boolean;
/** Format: int64 */
id: number;
isCustomAvatar: boolean;
isFavorite: boolean;
/** Format: int64 */
lastActivity: number;
/** Format: int64 */
lastCommonReadMessage: number;
lastMessage: components["schemas"]["RoomLastMessage"] | unknown[];
/** Format: int64 */
lastPing: number;
/** Format: int64 */
lastReadMessage: number;
/** Format: int64 */
listable: number;
/** Format: int64 */
lobbyState: number;
/** Format: int64 */
lobbyTimer: number;
/** Format: int64 */
messageExpiration: number;
name: string;
/** Format: int64 */
notificationCalls: number;
/** Format: int64 */
notificationLevel: number;
objectId: string;
objectType: string;
/** Format: int64 */
participantFlags: number;
/** Format: int64 */
participantType: number;
/** Format: int64 */
permissions: number;
/** Format: int64 */
readOnly: number;
/** Format: int64 */
recordingConsent: number;
sessionId: string;
/** Format: int64 */
sipEnabled: number;
status?: string;
/** Format: int64 */
statusClearAt?: number | null;
statusIcon?: string | null;
statusMessage?: string | null;
token: string;
/** Format: int64 */
type: number;
unreadMention: boolean;
unreadMentionDirect: boolean;
/** Format: int64 */
unreadMessages: number;
};
RoomLastMessage: components["schemas"]["ChatMessage"] | components["schemas"]["RoomProxyMessage"];
RoomProxyMessage: {
actorDisplayName: string;
actorId: string;
actorType: string;
/** Format: int64 */
expirationTimestamp: number;
message: string;
messageParameters: {
[key: string]: components["schemas"]["RichObjectParameter"];
};
messageType: string;
systemMessage: string;
};
SignalingSession: {
/** Format: int64 */
inCall: number;
/** Format: int64 */
lastPing: number;
/** Format: int64 */
participantPermissions: number;
/** Format: int64 */
roomId: number;
sessionId: string;
userId: string;
};
SignalingSettings: {
helloAuthParams: {
"1.0": {
userid: string | null;
ticket: string;
};
"2.0": {
token: string;
};
};
hideWarning: boolean;
server: string;
signalingMode: string;
sipDialinInfo: string;
stunservers: {
urls: string[];
}[];
ticket: string;
turnservers: {
urls: string[];
username: string;
credential: Record<string, never>;
}[];
userId: string | null;
};
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
};
export type $defs = Record<string, never>;
export type external = Record<string, never>;
export type operations = {
/** Get the avatar of a room */
"avatar-get-avatar": {
parameters: {
query?: {
/** @description Theme used for background */
darkTheme?: 0 | 1;
};
header: {
/** @description Required to be true for the API request to pass */
"OCS-APIRequest": boolean;
};
path: {
apiVersion: "v1";
token: string;
};
};
responses: {
/** @description Room avatar returned */
200: {
content: {
"*/*": string;
};
};
};
};
/** Upload an avatar for a room */
"avatar-upload-avatar": {
parameters: {
header: {
/** @description Required to be true for the API request to pass */
"OCS-APIRequest": boolean;
};
path: {
apiVersion: "v1";
token: string;
};
};
responses: {
/** @description Avatar uploaded successfully */
200: {
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: components["schemas"]["Room"];
};
};
};
};
/** @description Avatar invalid */
400: {
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: {
message: string;
};
};
};
};
};
};
};
/** Delete the avatar of a room */
"avatar-delete-avatar": {
parameters: {
header: {
/** @description Required to be true for the API request to pass */
"OCS-APIRequest": boolean;
};
path: {
apiVersion: "v1";
token: string;
};
};
responses: {
/** @description Avatar removed successfully */
200: {
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: components["schemas"]["Room"];
};
};
};
};
};
};
/** Set an emoji as avatar */
"avatar-emoji-avatar": {
parameters: {
query: {
/** @description Emoji */
emoji: string;
/** @description Color of the emoji */
color?: string | null;
};
header: {
/** @description Required to be true for the API request to pass */
"OCS-APIRequest": boolean;
};
path: {
apiVersion: "v1";
token: string;
};
};
responses: {
/** @description Avatar set successfully */
200: {
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: components["schemas"]["Room"];
};
};
};
};
/** @description Setting emoji avatar is not possible */
400: {
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: {
message: string;
};
};
};
};
};
};
};
/** Get the dark mode avatar of a room */
"avatar-get-avatar-dark": {
parameters: {
header: {
/** @description Required to be true for the API request to pass */
"OCS-APIRequest": boolean;
};
path: {
apiVersion: "v1";
token: string;
};
};
responses: {
/** @description Room avatar returned */
200: {
content: {
"*/*": string;
};
};
};
};
/** List bots */
"bot-list-bots": {
parameters: {
header: {
/** @description Required to be true for the API request to pass */
"OCS-APIRequest": boolean;
};
path: {
apiVersion: "v1";
token: string;
};
};
responses: {
/** @description Bot list returned */
200: {
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: components["schemas"]["Bot"][];
};
};
};
};
};
};
/** Enables a bot */
"bot-enable-bot": {
parameters: {
header: {
/** @description Required to be true for the API request to pass */
"OCS-APIRequest": boolean;
};
path: {
apiVersion: "v1";
token: string;
/** @description ID of the bot */
botId: number;
};
};
responses: {
/** @description Bot already enabled */
200: {
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: components["schemas"]["Bot"];
};
};
};
};
/** @description Bot enabled successfully */
201: {
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: components["schemas"]["Bot"];
};
};
};
};
/** @description Enabling bot errored */
400: {
content: {
"application/json": {
ocs: {
meta: components["schemas"]["OCSMeta"];
data: {