@stream-io/node-sdk 0.1.0

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 (101) hide show
  1. package/.readme-assets/Github-Graphic-JS.jpg +0 -0
  2. package/LICENSE +219 -0
  3. package/README.md +29 -0
  4. package/dist/__tests__/block-lists.test.d.ts +1 -0
  5. package/dist/__tests__/call-members.test.d.ts +1 -0
  6. package/dist/__tests__/call-types.test.d.ts +1 -0
  7. package/dist/__tests__/call.test.d.ts +1 -0
  8. package/dist/__tests__/channel-types.test.d.ts +1 -0
  9. package/dist/__tests__/channel.test.d.ts +1 -0
  10. package/dist/__tests__/command.test.d.ts +1 -0
  11. package/dist/__tests__/create-token.test.d.ts +1 -0
  12. package/dist/__tests__/devices-push.test.d.ts +1 -0
  13. package/dist/__tests__/messages.test.d.ts +1 -0
  14. package/dist/__tests__/permissions-app-settings.test.d.ts +1 -0
  15. package/dist/__tests__/user-compat.test.d.ts +1 -0
  16. package/dist/__tests__/users.test.d.ts +1 -0
  17. package/dist/index.cjs.js +8789 -0
  18. package/dist/index.cjs.js.map +1 -0
  19. package/dist/index.d.ts +7 -0
  20. package/dist/index.es.js +8708 -0
  21. package/dist/index.es.js.map +1 -0
  22. package/dist/src/StreamCall.d.ts +37 -0
  23. package/dist/src/StreamChannel.d.ts +39 -0
  24. package/dist/src/StreamChatClient.d.ts +31 -0
  25. package/dist/src/StreamClient.d.ts +68 -0
  26. package/dist/src/StreamVideoClient.d.ts +16 -0
  27. package/dist/src/gen/chat/apis/ChannelTypesApi.d.ts +81 -0
  28. package/dist/src/gen/chat/apis/ChannelsApi.d.ts +308 -0
  29. package/dist/src/gen/chat/apis/CustomCommandsApi.d.ts +81 -0
  30. package/dist/src/gen/chat/apis/DefaultApi.d.ts +60 -0
  31. package/dist/src/gen/chat/apis/DevicesApi.d.ts +58 -0
  32. package/dist/src/gen/chat/apis/EventsApi.d.ts +64 -0
  33. package/dist/src/gen/chat/apis/FilesApi.d.ts +81 -0
  34. package/dist/src/gen/chat/apis/GDPRApi.d.ts +114 -0
  35. package/dist/src/gen/chat/apis/ImportsApi.d.ts +67 -0
  36. package/dist/src/gen/chat/apis/MessagesApi.d.ts +370 -0
  37. package/dist/src/gen/chat/apis/ModerationApi.d.ts +271 -0
  38. package/dist/src/gen/chat/apis/PermissionsV2Api.d.ts +77 -0
  39. package/dist/src/gen/chat/apis/PushApi.d.ts +65 -0
  40. package/dist/src/gen/chat/apis/ReactionsApi.d.ts +62 -0
  41. package/dist/src/gen/chat/apis/ServerSideApi.d.ts +31 -0
  42. package/dist/src/gen/chat/apis/SettingsApi.d.ts +257 -0
  43. package/dist/src/gen/chat/apis/TasksApi.d.ts +31 -0
  44. package/dist/src/gen/chat/apis/TestingApi.d.ts +57 -0
  45. package/dist/src/gen/chat/apis/UsersApi.d.ts +313 -0
  46. package/dist/src/gen/chat/apis/index.d.ts +19 -0
  47. package/dist/src/gen/chat/index.d.ts +3 -0
  48. package/dist/src/gen/chat/models/index.d.ts +15624 -0
  49. package/dist/src/gen/chat/runtime.d.ts +180 -0
  50. package/dist/src/gen/video/apis/DefaultApi.d.ts +505 -0
  51. package/dist/src/gen/video/apis/ServerSideApi.d.ts +81 -0
  52. package/dist/src/gen/video/apis/index.d.ts +2 -0
  53. package/dist/src/gen/video/index.d.ts +3 -0
  54. package/dist/src/gen/video/models/index.d.ts +4733 -0
  55. package/dist/src/gen/video/runtime.d.ts +180 -0
  56. package/dist/src/types.d.ts +1 -0
  57. package/dist/src/utils/create-token.d.ts +3 -0
  58. package/index.ts +7 -0
  59. package/package.json +47 -0
  60. package/src/StreamCall.ts +161 -0
  61. package/src/StreamChannel.ts +165 -0
  62. package/src/StreamChatClient.ts +102 -0
  63. package/src/StreamClient.ts +440 -0
  64. package/src/StreamVideoClient.ts +63 -0
  65. package/src/gen/chat/.openapi-generator/FILES +24 -0
  66. package/src/gen/chat/.openapi-generator/VERSION +1 -0
  67. package/src/gen/chat/.openapi-generator-ignore +23 -0
  68. package/src/gen/chat/apis/ChannelTypesApi.ts +275 -0
  69. package/src/gen/chat/apis/ChannelsApi.ts +1221 -0
  70. package/src/gen/chat/apis/CustomCommandsApi.ts +276 -0
  71. package/src/gen/chat/apis/DefaultApi.ts +196 -0
  72. package/src/gen/chat/apis/DevicesApi.ts +180 -0
  73. package/src/gen/chat/apis/EventsApi.ts +220 -0
  74. package/src/gen/chat/apis/FilesApi.ts +312 -0
  75. package/src/gen/chat/apis/GDPRApi.ts +418 -0
  76. package/src/gen/chat/apis/ImportsApi.ts +222 -0
  77. package/src/gen/chat/apis/MessagesApi.ts +1475 -0
  78. package/src/gen/chat/apis/ModerationApi.ts +1038 -0
  79. package/src/gen/chat/apis/PermissionsV2Api.ts +259 -0
  80. package/src/gen/chat/apis/PushApi.ts +183 -0
  81. package/src/gen/chat/apis/ReactionsApi.ts +202 -0
  82. package/src/gen/chat/apis/ServerSideApi.ts +79 -0
  83. package/src/gen/chat/apis/SettingsApi.ts +948 -0
  84. package/src/gen/chat/apis/TasksApi.ts +75 -0
  85. package/src/gen/chat/apis/TestingApi.ts +185 -0
  86. package/src/gen/chat/apis/UsersApi.ts +1203 -0
  87. package/src/gen/chat/apis/index.ts +30 -0
  88. package/src/gen/chat/index.ts +5 -0
  89. package/src/gen/chat/models/index.ts +15541 -0
  90. package/src/gen/chat/runtime.ts +415 -0
  91. package/src/gen/video/.openapi-generator/FILES +7 -0
  92. package/src/gen/video/.openapi-generator/VERSION +1 -0
  93. package/src/gen/video/.openapi-generator-ignore +23 -0
  94. package/src/gen/video/apis/DefaultApi.ts +1997 -0
  95. package/src/gen/video/apis/ServerSideApi.ts +276 -0
  96. package/src/gen/video/apis/index.ts +4 -0
  97. package/src/gen/video/index.ts +5 -0
  98. package/src/gen/video/models/index.ts +4642 -0
  99. package/src/gen/video/runtime.ts +415 -0
  100. package/src/types.ts +1 -0
  101. package/src/utils/create-token.ts +49 -0
@@ -0,0 +1,4733 @@
1
+ /**
2
+ *
3
+ * @export
4
+ * @interface VideoAPIError
5
+ */
6
+ export interface VideoAPIError {
7
+ /**
8
+ * Response HTTP status code
9
+ * @type {number}
10
+ * @memberof VideoAPIError
11
+ */
12
+ StatusCode: number;
13
+ /**
14
+ * API error code
15
+ * @type {number}
16
+ * @memberof VideoAPIError
17
+ */
18
+ code: number;
19
+ /**
20
+ * Additional error-specific information
21
+ * @type {Array<number>}
22
+ * @memberof VideoAPIError
23
+ */
24
+ details: Array<number>;
25
+ /**
26
+ * Request duration
27
+ * @type {string}
28
+ * @memberof VideoAPIError
29
+ */
30
+ duration: string;
31
+ /**
32
+ * Additional error info
33
+ * @type {{ [key: string]: string; }}
34
+ * @memberof VideoAPIError
35
+ */
36
+ exception_fields?: {
37
+ [key: string]: string;
38
+ };
39
+ /**
40
+ * Message describing an error
41
+ * @type {string}
42
+ * @memberof VideoAPIError
43
+ */
44
+ message: string;
45
+ /**
46
+ * URL with additional information
47
+ * @type {string}
48
+ * @memberof VideoAPIError
49
+ */
50
+ more_info: string;
51
+ }
52
+ /**
53
+ *
54
+ * @export
55
+ * @interface VideoAPNS
56
+ */
57
+ export interface VideoAPNS {
58
+ /**
59
+ *
60
+ * @type {string}
61
+ * @memberof VideoAPNS
62
+ */
63
+ body: string;
64
+ /**
65
+ *
66
+ * @type {string}
67
+ * @memberof VideoAPNS
68
+ */
69
+ title: string;
70
+ }
71
+ /**
72
+ *
73
+ * @export
74
+ * @interface VideoAPNSRequest
75
+ */
76
+ export interface VideoAPNSRequest {
77
+ /**
78
+ *
79
+ * @type {string}
80
+ * @memberof VideoAPNSRequest
81
+ */
82
+ body?: string;
83
+ /**
84
+ *
85
+ * @type {string}
86
+ * @memberof VideoAPNSRequest
87
+ */
88
+ title?: string;
89
+ }
90
+ /**
91
+ *
92
+ * @export
93
+ * @interface VideoAcceptCallResponse
94
+ */
95
+ export interface VideoAcceptCallResponse {
96
+ /**
97
+ *
98
+ * @type {string}
99
+ * @memberof VideoAcceptCallResponse
100
+ */
101
+ duration: string;
102
+ }
103
+ /**
104
+ *
105
+ * @export
106
+ * @interface VideoAudioSettings
107
+ */
108
+ export interface VideoAudioSettings {
109
+ /**
110
+ *
111
+ * @type {boolean}
112
+ * @memberof VideoAudioSettings
113
+ */
114
+ access_request_enabled: boolean;
115
+ /**
116
+ *
117
+ * @type {string}
118
+ * @memberof VideoAudioSettings
119
+ */
120
+ default_device: VideoAudioSettingsDefaultDeviceEnum;
121
+ /**
122
+ *
123
+ * @type {boolean}
124
+ * @memberof VideoAudioSettings
125
+ */
126
+ mic_default_on: boolean;
127
+ /**
128
+ *
129
+ * @type {boolean}
130
+ * @memberof VideoAudioSettings
131
+ */
132
+ opus_dtx_enabled: boolean;
133
+ /**
134
+ *
135
+ * @type {boolean}
136
+ * @memberof VideoAudioSettings
137
+ */
138
+ redundant_coding_enabled: boolean;
139
+ /**
140
+ *
141
+ * @type {boolean}
142
+ * @memberof VideoAudioSettings
143
+ */
144
+ speaker_default_on: boolean;
145
+ }
146
+ /**
147
+ * @export
148
+ */
149
+ export declare const VideoAudioSettingsDefaultDeviceEnum: {
150
+ readonly SPEAKER: "speaker";
151
+ readonly EARPIECE: "earpiece";
152
+ };
153
+ export type VideoAudioSettingsDefaultDeviceEnum = typeof VideoAudioSettingsDefaultDeviceEnum[keyof typeof VideoAudioSettingsDefaultDeviceEnum];
154
+ /**
155
+ *
156
+ * @export
157
+ * @interface VideoAudioSettingsRequest
158
+ */
159
+ export interface VideoAudioSettingsRequest {
160
+ /**
161
+ *
162
+ * @type {boolean}
163
+ * @memberof VideoAudioSettingsRequest
164
+ */
165
+ access_request_enabled?: boolean;
166
+ /**
167
+ *
168
+ * @type {string}
169
+ * @memberof VideoAudioSettingsRequest
170
+ */
171
+ default_device: VideoAudioSettingsRequestDefaultDeviceEnum;
172
+ /**
173
+ *
174
+ * @type {boolean}
175
+ * @memberof VideoAudioSettingsRequest
176
+ */
177
+ mic_default_on?: boolean;
178
+ /**
179
+ *
180
+ * @type {boolean}
181
+ * @memberof VideoAudioSettingsRequest
182
+ */
183
+ opus_dtx_enabled?: boolean;
184
+ /**
185
+ *
186
+ * @type {boolean}
187
+ * @memberof VideoAudioSettingsRequest
188
+ */
189
+ redundant_coding_enabled?: boolean;
190
+ /**
191
+ *
192
+ * @type {boolean}
193
+ * @memberof VideoAudioSettingsRequest
194
+ */
195
+ speaker_default_on?: boolean;
196
+ }
197
+ /**
198
+ * @export
199
+ */
200
+ export declare const VideoAudioSettingsRequestDefaultDeviceEnum: {
201
+ readonly SPEAKER: "speaker";
202
+ readonly EARPIECE: "earpiece";
203
+ };
204
+ export type VideoAudioSettingsRequestDefaultDeviceEnum = typeof VideoAudioSettingsRequestDefaultDeviceEnum[keyof typeof VideoAudioSettingsRequestDefaultDeviceEnum];
205
+ /**
206
+ *
207
+ * @export
208
+ * @interface VideoBackstageSettings
209
+ */
210
+ export interface VideoBackstageSettings {
211
+ /**
212
+ *
213
+ * @type {boolean}
214
+ * @memberof VideoBackstageSettings
215
+ */
216
+ enabled: boolean;
217
+ }
218
+ /**
219
+ *
220
+ * @export
221
+ * @interface VideoBackstageSettingsRequest
222
+ */
223
+ export interface VideoBackstageSettingsRequest {
224
+ /**
225
+ *
226
+ * @type {boolean}
227
+ * @memberof VideoBackstageSettingsRequest
228
+ */
229
+ enabled?: boolean;
230
+ }
231
+ /**
232
+ *
233
+ * @export
234
+ * @interface VideoBlockUserRequest
235
+ */
236
+ export interface VideoBlockUserRequest {
237
+ /**
238
+ * the user to block
239
+ * @type {string}
240
+ * @memberof VideoBlockUserRequest
241
+ */
242
+ user_id: string;
243
+ }
244
+ /**
245
+ *
246
+ * @export
247
+ * @interface VideoBlockUserResponse
248
+ */
249
+ export interface VideoBlockUserResponse {
250
+ /**
251
+ * Duration of the request in human-readable format
252
+ * @type {string}
253
+ * @memberof VideoBlockUserResponse
254
+ */
255
+ duration: string;
256
+ }
257
+ /**
258
+ * This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification.
259
+ * If the user is the current user, the client should leave the call screen as well
260
+ * @export
261
+ * @interface VideoBlockedUserEvent
262
+ */
263
+ export interface VideoBlockedUserEvent {
264
+ /**
265
+ *
266
+ * @type {VideoUserResponse}
267
+ * @memberof VideoBlockedUserEvent
268
+ */
269
+ blocked_by_user?: VideoUserResponse;
270
+ /**
271
+ *
272
+ * @type {string}
273
+ * @memberof VideoBlockedUserEvent
274
+ */
275
+ call_cid: string;
276
+ /**
277
+ *
278
+ * @type {string}
279
+ * @memberof VideoBlockedUserEvent
280
+ */
281
+ created_at: string;
282
+ /**
283
+ * The type of event: "call.blocked_user" in this case
284
+ * @type {string}
285
+ * @memberof VideoBlockedUserEvent
286
+ */
287
+ type: string;
288
+ /**
289
+ *
290
+ * @type {VideoUserResponse}
291
+ * @memberof VideoBlockedUserEvent
292
+ */
293
+ user: VideoUserResponse;
294
+ }
295
+ /**
296
+ *
297
+ * @export
298
+ * @interface VideoBroadcastSettingsRequest
299
+ */
300
+ export interface VideoBroadcastSettingsRequest {
301
+ /**
302
+ *
303
+ * @type {boolean}
304
+ * @memberof VideoBroadcastSettingsRequest
305
+ */
306
+ enabled?: boolean;
307
+ /**
308
+ *
309
+ * @type {VideoHLSSettingsRequest}
310
+ * @memberof VideoBroadcastSettingsRequest
311
+ */
312
+ hls?: VideoHLSSettingsRequest;
313
+ }
314
+ /**
315
+ *
316
+ * @export
317
+ * @interface VideoBroadcastSettingsResponse
318
+ */
319
+ export interface VideoBroadcastSettingsResponse {
320
+ /**
321
+ *
322
+ * @type {boolean}
323
+ * @memberof VideoBroadcastSettingsResponse
324
+ */
325
+ enabled: boolean;
326
+ /**
327
+ *
328
+ * @type {VideoHLSSettingsResponse}
329
+ * @memberof VideoBroadcastSettingsResponse
330
+ */
331
+ hls: VideoHLSSettingsResponse;
332
+ }
333
+ /**
334
+ * This event is sent when a user accepts a notification to join a call.
335
+ * @export
336
+ * @interface VideoCallAcceptedEvent
337
+ */
338
+ export interface VideoCallAcceptedEvent {
339
+ /**
340
+ *
341
+ * @type {VideoCallResponse}
342
+ * @memberof VideoCallAcceptedEvent
343
+ */
344
+ call: VideoCallResponse;
345
+ /**
346
+ *
347
+ * @type {string}
348
+ * @memberof VideoCallAcceptedEvent
349
+ */
350
+ call_cid: string;
351
+ /**
352
+ *
353
+ * @type {string}
354
+ * @memberof VideoCallAcceptedEvent
355
+ */
356
+ created_at: string;
357
+ /**
358
+ * The type of event: "call.accepted" in this case
359
+ * @type {string}
360
+ * @memberof VideoCallAcceptedEvent
361
+ */
362
+ type: string;
363
+ /**
364
+ *
365
+ * @type {VideoUserResponse}
366
+ * @memberof VideoCallAcceptedEvent
367
+ */
368
+ user: VideoUserResponse;
369
+ }
370
+ /**
371
+ * This event is sent when a call is created. Clients receiving this event should check if the ringing
372
+ * field is set to true and if so, show the call screen
373
+ * @export
374
+ * @interface VideoCallCreatedEvent
375
+ */
376
+ export interface VideoCallCreatedEvent {
377
+ /**
378
+ *
379
+ * @type {VideoCallResponse}
380
+ * @memberof VideoCallCreatedEvent
381
+ */
382
+ call: VideoCallResponse;
383
+ /**
384
+ *
385
+ * @type {string}
386
+ * @memberof VideoCallCreatedEvent
387
+ */
388
+ call_cid: string;
389
+ /**
390
+ *
391
+ * @type {string}
392
+ * @memberof VideoCallCreatedEvent
393
+ */
394
+ created_at: string;
395
+ /**
396
+ * the members added to this call
397
+ * @type {Array<VideoMemberResponse>}
398
+ * @memberof VideoCallCreatedEvent
399
+ */
400
+ members: Array<VideoMemberResponse>;
401
+ /**
402
+ * The type of event: "call.created" in this case
403
+ * @type {string}
404
+ * @memberof VideoCallCreatedEvent
405
+ */
406
+ type: string;
407
+ }
408
+ /**
409
+ * This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen
410
+ * @export
411
+ * @interface VideoCallEndedEvent
412
+ */
413
+ export interface VideoCallEndedEvent {
414
+ /**
415
+ *
416
+ * @type {VideoCallResponse}
417
+ * @memberof VideoCallEndedEvent
418
+ */
419
+ call: VideoCallResponse;
420
+ /**
421
+ *
422
+ * @type {string}
423
+ * @memberof VideoCallEndedEvent
424
+ */
425
+ call_cid: string;
426
+ /**
427
+ *
428
+ * @type {string}
429
+ * @memberof VideoCallEndedEvent
430
+ */
431
+ created_at: string;
432
+ /**
433
+ * The type of event: "call.ended" in this case
434
+ * @type {string}
435
+ * @memberof VideoCallEndedEvent
436
+ */
437
+ type: string;
438
+ /**
439
+ *
440
+ * @type {VideoUserResponse}
441
+ * @memberof VideoCallEndedEvent
442
+ */
443
+ user?: VideoUserResponse;
444
+ }
445
+ /**
446
+ * This event is sent when HLS broadcasting has failed
447
+ * @export
448
+ * @interface VideoCallHLSBroadcastingFailedEvent
449
+ */
450
+ export interface VideoCallHLSBroadcastingFailedEvent {
451
+ /**
452
+ *
453
+ * @type {string}
454
+ * @memberof VideoCallHLSBroadcastingFailedEvent
455
+ */
456
+ call_cid: string;
457
+ /**
458
+ *
459
+ * @type {string}
460
+ * @memberof VideoCallHLSBroadcastingFailedEvent
461
+ */
462
+ created_at: string;
463
+ /**
464
+ * The type of event: "call.hls_broadcasting_failed" in this case
465
+ * @type {string}
466
+ * @memberof VideoCallHLSBroadcastingFailedEvent
467
+ */
468
+ type: string;
469
+ }
470
+ /**
471
+ * This event is sent when HLS broadcasting has started
472
+ * @export
473
+ * @interface VideoCallHLSBroadcastingStartedEvent
474
+ */
475
+ export interface VideoCallHLSBroadcastingStartedEvent {
476
+ /**
477
+ *
478
+ * @type {string}
479
+ * @memberof VideoCallHLSBroadcastingStartedEvent
480
+ */
481
+ call_cid: string;
482
+ /**
483
+ *
484
+ * @type {string}
485
+ * @memberof VideoCallHLSBroadcastingStartedEvent
486
+ */
487
+ created_at: string;
488
+ /**
489
+ *
490
+ * @type {string}
491
+ * @memberof VideoCallHLSBroadcastingStartedEvent
492
+ */
493
+ hls_playlist_url: string;
494
+ /**
495
+ * The type of event: "call.hls_broadcasting_started" in this case
496
+ * @type {string}
497
+ * @memberof VideoCallHLSBroadcastingStartedEvent
498
+ */
499
+ type: string;
500
+ }
501
+ /**
502
+ * This event is sent when HLS broadcasting has stopped
503
+ * @export
504
+ * @interface VideoCallHLSBroadcastingStoppedEvent
505
+ */
506
+ export interface VideoCallHLSBroadcastingStoppedEvent {
507
+ /**
508
+ *
509
+ * @type {string}
510
+ * @memberof VideoCallHLSBroadcastingStoppedEvent
511
+ */
512
+ call_cid: string;
513
+ /**
514
+ *
515
+ * @type {string}
516
+ * @memberof VideoCallHLSBroadcastingStoppedEvent
517
+ */
518
+ created_at: string;
519
+ /**
520
+ * The type of event: "call.hls_broadcasting_stopped" in this case
521
+ * @type {string}
522
+ * @memberof VideoCallHLSBroadcastingStoppedEvent
523
+ */
524
+ type: string;
525
+ }
526
+ /**
527
+ *
528
+ * @export
529
+ * @interface VideoCallIngressResponse
530
+ */
531
+ export interface VideoCallIngressResponse {
532
+ /**
533
+ *
534
+ * @type {VideoRTMPIngress}
535
+ * @memberof VideoCallIngressResponse
536
+ */
537
+ rtmp: VideoRTMPIngress;
538
+ }
539
+ /**
540
+ * This event is sent when a call is started. Clients receiving this event should start the call.
541
+ * @export
542
+ * @interface VideoCallLiveStartedEvent
543
+ */
544
+ export interface VideoCallLiveStartedEvent {
545
+ /**
546
+ *
547
+ * @type {VideoCallResponse}
548
+ * @memberof VideoCallLiveStartedEvent
549
+ */
550
+ call: VideoCallResponse;
551
+ /**
552
+ *
553
+ * @type {string}
554
+ * @memberof VideoCallLiveStartedEvent
555
+ */
556
+ call_cid: string;
557
+ /**
558
+ *
559
+ * @type {string}
560
+ * @memberof VideoCallLiveStartedEvent
561
+ */
562
+ created_at: string;
563
+ /**
564
+ * The type of event: "call.live_started" in this case
565
+ * @type {string}
566
+ * @memberof VideoCallLiveStartedEvent
567
+ */
568
+ type: string;
569
+ }
570
+ /**
571
+ * This event is sent when one or more members are added to a call
572
+ * @export
573
+ * @interface VideoCallMemberAddedEvent
574
+ */
575
+ export interface VideoCallMemberAddedEvent {
576
+ /**
577
+ *
578
+ * @type {VideoCallResponse}
579
+ * @memberof VideoCallMemberAddedEvent
580
+ */
581
+ call: VideoCallResponse;
582
+ /**
583
+ *
584
+ * @type {string}
585
+ * @memberof VideoCallMemberAddedEvent
586
+ */
587
+ call_cid: string;
588
+ /**
589
+ *
590
+ * @type {string}
591
+ * @memberof VideoCallMemberAddedEvent
592
+ */
593
+ created_at: string;
594
+ /**
595
+ * the members added to this call
596
+ * @type {Array<VideoMemberResponse>}
597
+ * @memberof VideoCallMemberAddedEvent
598
+ */
599
+ members: Array<VideoMemberResponse>;
600
+ /**
601
+ * The type of event: "call.member_added" in this case
602
+ * @type {string}
603
+ * @memberof VideoCallMemberAddedEvent
604
+ */
605
+ type: string;
606
+ }
607
+ /**
608
+ * This event is sent when one or more members are removed from a call
609
+ * @export
610
+ * @interface VideoCallMemberRemovedEvent
611
+ */
612
+ export interface VideoCallMemberRemovedEvent {
613
+ /**
614
+ *
615
+ * @type {VideoCallResponse}
616
+ * @memberof VideoCallMemberRemovedEvent
617
+ */
618
+ call: VideoCallResponse;
619
+ /**
620
+ *
621
+ * @type {string}
622
+ * @memberof VideoCallMemberRemovedEvent
623
+ */
624
+ call_cid: string;
625
+ /**
626
+ *
627
+ * @type {string}
628
+ * @memberof VideoCallMemberRemovedEvent
629
+ */
630
+ created_at: string;
631
+ /**
632
+ * the list of member IDs removed from the call
633
+ * @type {Array<string>}
634
+ * @memberof VideoCallMemberRemovedEvent
635
+ */
636
+ members: Array<string>;
637
+ /**
638
+ * The type of event: "call.member_removed" in this case
639
+ * @type {string}
640
+ * @memberof VideoCallMemberRemovedEvent
641
+ */
642
+ type: string;
643
+ }
644
+ /**
645
+ * This event is sent when one or more members are updated
646
+ * @export
647
+ * @interface VideoCallMemberUpdatedEvent
648
+ */
649
+ export interface VideoCallMemberUpdatedEvent {
650
+ /**
651
+ *
652
+ * @type {VideoCallResponse}
653
+ * @memberof VideoCallMemberUpdatedEvent
654
+ */
655
+ call: VideoCallResponse;
656
+ /**
657
+ *
658
+ * @type {string}
659
+ * @memberof VideoCallMemberUpdatedEvent
660
+ */
661
+ call_cid: string;
662
+ /**
663
+ *
664
+ * @type {string}
665
+ * @memberof VideoCallMemberUpdatedEvent
666
+ */
667
+ created_at: string;
668
+ /**
669
+ * The list of members that were updated
670
+ * @type {Array<VideoMemberResponse>}
671
+ * @memberof VideoCallMemberUpdatedEvent
672
+ */
673
+ members: Array<VideoMemberResponse>;
674
+ /**
675
+ * The type of event: "call.member_updated" in this case
676
+ * @type {string}
677
+ * @memberof VideoCallMemberUpdatedEvent
678
+ */
679
+ type: string;
680
+ }
681
+ /**
682
+ * This event is sent when one or more members get its role updated
683
+ * @export
684
+ * @interface VideoCallMemberUpdatedPermissionEvent
685
+ */
686
+ export interface VideoCallMemberUpdatedPermissionEvent {
687
+ /**
688
+ *
689
+ * @type {VideoCallResponse}
690
+ * @memberof VideoCallMemberUpdatedPermissionEvent
691
+ */
692
+ call: VideoCallResponse;
693
+ /**
694
+ *
695
+ * @type {string}
696
+ * @memberof VideoCallMemberUpdatedPermissionEvent
697
+ */
698
+ call_cid: string;
699
+ /**
700
+ * The capabilities by role for this call
701
+ * @type {{ [key: string]: Array<string>; }}
702
+ * @memberof VideoCallMemberUpdatedPermissionEvent
703
+ */
704
+ capabilities_by_role: {
705
+ [key: string]: Array<string>;
706
+ };
707
+ /**
708
+ *
709
+ * @type {string}
710
+ * @memberof VideoCallMemberUpdatedPermissionEvent
711
+ */
712
+ created_at: string;
713
+ /**
714
+ * The list of members that were updated
715
+ * @type {Array<VideoMemberResponse>}
716
+ * @memberof VideoCallMemberUpdatedPermissionEvent
717
+ */
718
+ members: Array<VideoMemberResponse>;
719
+ /**
720
+ * The type of event: "call.member_added" in this case
721
+ * @type {string}
722
+ * @memberof VideoCallMemberUpdatedPermissionEvent
723
+ */
724
+ type: string;
725
+ }
726
+ /**
727
+ * This event is sent to all call members to notify they are getting called
728
+ * @export
729
+ * @interface VideoCallNotificationEvent
730
+ */
731
+ export interface VideoCallNotificationEvent {
732
+ /**
733
+ *
734
+ * @type {VideoCallResponse}
735
+ * @memberof VideoCallNotificationEvent
736
+ */
737
+ call: VideoCallResponse;
738
+ /**
739
+ *
740
+ * @type {string}
741
+ * @memberof VideoCallNotificationEvent
742
+ */
743
+ call_cid: string;
744
+ /**
745
+ *
746
+ * @type {string}
747
+ * @memberof VideoCallNotificationEvent
748
+ */
749
+ created_at: string;
750
+ /**
751
+ * Call members
752
+ * @type {Array<VideoMemberResponse>}
753
+ * @memberof VideoCallNotificationEvent
754
+ */
755
+ members: Array<VideoMemberResponse>;
756
+ /**
757
+ * Call session ID
758
+ * @type {string}
759
+ * @memberof VideoCallNotificationEvent
760
+ */
761
+ session_id: string;
762
+ /**
763
+ * The type of event: "call.notification" in this case
764
+ * @type {string}
765
+ * @memberof VideoCallNotificationEvent
766
+ */
767
+ type: string;
768
+ /**
769
+ *
770
+ * @type {VideoUserResponse}
771
+ * @memberof VideoCallNotificationEvent
772
+ */
773
+ user: VideoUserResponse;
774
+ }
775
+ /**
776
+ *
777
+ * @export
778
+ * @interface VideoCallParticipantResponse
779
+ */
780
+ export interface VideoCallParticipantResponse {
781
+ /**
782
+ *
783
+ * @type {string}
784
+ * @memberof VideoCallParticipantResponse
785
+ */
786
+ joined_at: string;
787
+ /**
788
+ *
789
+ * @type {string}
790
+ * @memberof VideoCallParticipantResponse
791
+ */
792
+ role: string;
793
+ /**
794
+ *
795
+ * @type {VideoUserResponse}
796
+ * @memberof VideoCallParticipantResponse
797
+ */
798
+ user: VideoUserResponse;
799
+ /**
800
+ *
801
+ * @type {string}
802
+ * @memberof VideoCallParticipantResponse
803
+ */
804
+ user_session_id: string;
805
+ }
806
+ /**
807
+ * This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen
808
+ * @export
809
+ * @interface VideoCallReactionEvent
810
+ */
811
+ export interface VideoCallReactionEvent {
812
+ /**
813
+ *
814
+ * @type {string}
815
+ * @memberof VideoCallReactionEvent
816
+ */
817
+ call_cid: string;
818
+ /**
819
+ *
820
+ * @type {string}
821
+ * @memberof VideoCallReactionEvent
822
+ */
823
+ created_at: string;
824
+ /**
825
+ *
826
+ * @type {VideoReactionResponse}
827
+ * @memberof VideoCallReactionEvent
828
+ */
829
+ reaction: VideoReactionResponse;
830
+ /**
831
+ * The type of event: "call.reaction_new" in this case
832
+ * @type {string}
833
+ * @memberof VideoCallReactionEvent
834
+ */
835
+ type: string;
836
+ }
837
+ /**
838
+ * CallRecording represents a recording of a call.
839
+ * @export
840
+ * @interface VideoCallRecording
841
+ */
842
+ export interface VideoCallRecording {
843
+ /**
844
+ *
845
+ * @type {string}
846
+ * @memberof VideoCallRecording
847
+ */
848
+ end_time: string;
849
+ /**
850
+ *
851
+ * @type {string}
852
+ * @memberof VideoCallRecording
853
+ */
854
+ filename: string;
855
+ /**
856
+ *
857
+ * @type {string}
858
+ * @memberof VideoCallRecording
859
+ */
860
+ start_time: string;
861
+ /**
862
+ *
863
+ * @type {string}
864
+ * @memberof VideoCallRecording
865
+ */
866
+ url: string;
867
+ }
868
+ /**
869
+ * This event is sent when call recording has failed
870
+ * @export
871
+ * @interface VideoCallRecordingFailedEvent
872
+ */
873
+ export interface VideoCallRecordingFailedEvent {
874
+ /**
875
+ *
876
+ * @type {string}
877
+ * @memberof VideoCallRecordingFailedEvent
878
+ */
879
+ call_cid: string;
880
+ /**
881
+ *
882
+ * @type {string}
883
+ * @memberof VideoCallRecordingFailedEvent
884
+ */
885
+ created_at: string;
886
+ /**
887
+ * The type of event: "call.recording_failed" in this case
888
+ * @type {string}
889
+ * @memberof VideoCallRecordingFailedEvent
890
+ */
891
+ type: string;
892
+ }
893
+ /**
894
+ * This event is sent when call recording is ready
895
+ * @export
896
+ * @interface VideoCallRecordingReadyEvent
897
+ */
898
+ export interface VideoCallRecordingReadyEvent {
899
+ /**
900
+ *
901
+ * @type {string}
902
+ * @memberof VideoCallRecordingReadyEvent
903
+ */
904
+ call_cid: string;
905
+ /**
906
+ *
907
+ * @type {VideoCallRecording}
908
+ * @memberof VideoCallRecordingReadyEvent
909
+ */
910
+ call_recording: VideoCallRecording;
911
+ /**
912
+ *
913
+ * @type {string}
914
+ * @memberof VideoCallRecordingReadyEvent
915
+ */
916
+ created_at: string;
917
+ /**
918
+ * The type of event: "call.recording_ready" in this case
919
+ * @type {string}
920
+ * @memberof VideoCallRecordingReadyEvent
921
+ */
922
+ type: string;
923
+ }
924
+ /**
925
+ * This event is sent when call recording has started
926
+ * @export
927
+ * @interface VideoCallRecordingStartedEvent
928
+ */
929
+ export interface VideoCallRecordingStartedEvent {
930
+ /**
931
+ *
932
+ * @type {string}
933
+ * @memberof VideoCallRecordingStartedEvent
934
+ */
935
+ call_cid: string;
936
+ /**
937
+ *
938
+ * @type {string}
939
+ * @memberof VideoCallRecordingStartedEvent
940
+ */
941
+ created_at: string;
942
+ /**
943
+ * The type of event: "call.recording_started" in this case
944
+ * @type {string}
945
+ * @memberof VideoCallRecordingStartedEvent
946
+ */
947
+ type: string;
948
+ }
949
+ /**
950
+ * This event is sent when call recording has stopped
951
+ * @export
952
+ * @interface VideoCallRecordingStoppedEvent
953
+ */
954
+ export interface VideoCallRecordingStoppedEvent {
955
+ /**
956
+ *
957
+ * @type {string}
958
+ * @memberof VideoCallRecordingStoppedEvent
959
+ */
960
+ call_cid: string;
961
+ /**
962
+ *
963
+ * @type {string}
964
+ * @memberof VideoCallRecordingStoppedEvent
965
+ */
966
+ created_at: string;
967
+ /**
968
+ * The type of event: "call.recording_stopped" in this case
969
+ * @type {string}
970
+ * @memberof VideoCallRecordingStoppedEvent
971
+ */
972
+ type: string;
973
+ }
974
+ /**
975
+ * This event is sent when a user rejects a notification to join a call.
976
+ * @export
977
+ * @interface VideoCallRejectedEvent
978
+ */
979
+ export interface VideoCallRejectedEvent {
980
+ /**
981
+ *
982
+ * @type {VideoCallResponse}
983
+ * @memberof VideoCallRejectedEvent
984
+ */
985
+ call: VideoCallResponse;
986
+ /**
987
+ *
988
+ * @type {string}
989
+ * @memberof VideoCallRejectedEvent
990
+ */
991
+ call_cid: string;
992
+ /**
993
+ *
994
+ * @type {string}
995
+ * @memberof VideoCallRejectedEvent
996
+ */
997
+ created_at: string;
998
+ /**
999
+ * The type of event: "call.rejected" in this case
1000
+ * @type {string}
1001
+ * @memberof VideoCallRejectedEvent
1002
+ */
1003
+ type: string;
1004
+ /**
1005
+ *
1006
+ * @type {VideoUserResponse}
1007
+ * @memberof VideoCallRejectedEvent
1008
+ */
1009
+ user: VideoUserResponse;
1010
+ }
1011
+ /**
1012
+ *
1013
+ * @export
1014
+ * @interface VideoCallRequest
1015
+ */
1016
+ export interface VideoCallRequest {
1017
+ /**
1018
+ *
1019
+ * @type {VideoUserRequest}
1020
+ * @memberof VideoCallRequest
1021
+ */
1022
+ created_by?: VideoUserRequest;
1023
+ /**
1024
+ *
1025
+ * @type {string}
1026
+ * @memberof VideoCallRequest
1027
+ */
1028
+ created_by_id?: string;
1029
+ /**
1030
+ *
1031
+ * @type {{ [key: string]: any; }}
1032
+ * @memberof VideoCallRequest
1033
+ */
1034
+ custom?: {
1035
+ [key: string]: any;
1036
+ };
1037
+ /**
1038
+ *
1039
+ * @type {Array<VideoMemberRequest>}
1040
+ * @memberof VideoCallRequest
1041
+ */
1042
+ members?: Array<VideoMemberRequest>;
1043
+ /**
1044
+ *
1045
+ * @type {VideoCallSettingsRequest}
1046
+ * @memberof VideoCallRequest
1047
+ */
1048
+ settings_override?: VideoCallSettingsRequest;
1049
+ /**
1050
+ *
1051
+ * @type {string}
1052
+ * @memberof VideoCallRequest
1053
+ */
1054
+ starts_at?: string;
1055
+ /**
1056
+ *
1057
+ * @type {string}
1058
+ * @memberof VideoCallRequest
1059
+ */
1060
+ team?: string;
1061
+ }
1062
+ /**
1063
+ * Represents a call
1064
+ * @export
1065
+ * @interface VideoCallResponse
1066
+ */
1067
+ export interface VideoCallResponse {
1068
+ /**
1069
+ *
1070
+ * @type {boolean}
1071
+ * @memberof VideoCallResponse
1072
+ */
1073
+ backstage: boolean;
1074
+ /**
1075
+ *
1076
+ * @type {Array<string>}
1077
+ * @memberof VideoCallResponse
1078
+ */
1079
+ blocked_user_ids: Array<string>;
1080
+ /**
1081
+ * The unique identifier for a call (<type>:<id>)
1082
+ * @type {string}
1083
+ * @memberof VideoCallResponse
1084
+ */
1085
+ cid: string;
1086
+ /**
1087
+ * Date/time of creation
1088
+ * @type {string}
1089
+ * @memberof VideoCallResponse
1090
+ */
1091
+ created_at: string;
1092
+ /**
1093
+ *
1094
+ * @type {VideoUserResponse}
1095
+ * @memberof VideoCallResponse
1096
+ */
1097
+ created_by: VideoUserResponse;
1098
+ /**
1099
+ *
1100
+ * @type {string}
1101
+ * @memberof VideoCallResponse
1102
+ */
1103
+ current_session_id: string;
1104
+ /**
1105
+ * Custom data for this object
1106
+ * @type {{ [key: string]: any; }}
1107
+ * @memberof VideoCallResponse
1108
+ */
1109
+ custom: {
1110
+ [key: string]: any;
1111
+ };
1112
+ /**
1113
+ *
1114
+ * @type {VideoEgressResponse}
1115
+ * @memberof VideoCallResponse
1116
+ */
1117
+ egress: VideoEgressResponse;
1118
+ /**
1119
+ * Date/time when the call ended
1120
+ * @type {string}
1121
+ * @memberof VideoCallResponse
1122
+ */
1123
+ ended_at?: string;
1124
+ /**
1125
+ * Call ID
1126
+ * @type {string}
1127
+ * @memberof VideoCallResponse
1128
+ */
1129
+ id: string;
1130
+ /**
1131
+ *
1132
+ * @type {VideoCallIngressResponse}
1133
+ * @memberof VideoCallResponse
1134
+ */
1135
+ ingress: VideoCallIngressResponse;
1136
+ /**
1137
+ *
1138
+ * @type {boolean}
1139
+ * @memberof VideoCallResponse
1140
+ */
1141
+ recording: boolean;
1142
+ /**
1143
+ *
1144
+ * @type {VideoCallSessionResponse}
1145
+ * @memberof VideoCallResponse
1146
+ */
1147
+ session?: VideoCallSessionResponse;
1148
+ /**
1149
+ *
1150
+ * @type {VideoCallSettingsResponse}
1151
+ * @memberof VideoCallResponse
1152
+ */
1153
+ settings: VideoCallSettingsResponse;
1154
+ /**
1155
+ * Date/time when the call will start
1156
+ * @type {string}
1157
+ * @memberof VideoCallResponse
1158
+ */
1159
+ starts_at?: string;
1160
+ /**
1161
+ *
1162
+ * @type {string}
1163
+ * @memberof VideoCallResponse
1164
+ */
1165
+ team?: string;
1166
+ /**
1167
+ *
1168
+ * @type {VideoThumbnailResponse}
1169
+ * @memberof VideoCallResponse
1170
+ */
1171
+ thumbnails?: VideoThumbnailResponse;
1172
+ /**
1173
+ *
1174
+ * @type {boolean}
1175
+ * @memberof VideoCallResponse
1176
+ */
1177
+ transcribing: boolean;
1178
+ /**
1179
+ * The type of call
1180
+ * @type {string}
1181
+ * @memberof VideoCallResponse
1182
+ */
1183
+ type: string;
1184
+ /**
1185
+ * Date/time of the last update
1186
+ * @type {string}
1187
+ * @memberof VideoCallResponse
1188
+ */
1189
+ updated_at: string;
1190
+ }
1191
+ /**
1192
+ * This event is sent to all call members to notify they are getting called
1193
+ * @export
1194
+ * @interface VideoCallRingEvent
1195
+ */
1196
+ export interface VideoCallRingEvent {
1197
+ /**
1198
+ *
1199
+ * @type {VideoCallResponse}
1200
+ * @memberof VideoCallRingEvent
1201
+ */
1202
+ call: VideoCallResponse;
1203
+ /**
1204
+ *
1205
+ * @type {string}
1206
+ * @memberof VideoCallRingEvent
1207
+ */
1208
+ call_cid: string;
1209
+ /**
1210
+ *
1211
+ * @type {string}
1212
+ * @memberof VideoCallRingEvent
1213
+ */
1214
+ created_at: string;
1215
+ /**
1216
+ * Call members
1217
+ * @type {Array<VideoMemberResponse>}
1218
+ * @memberof VideoCallRingEvent
1219
+ */
1220
+ members: Array<VideoMemberResponse>;
1221
+ /**
1222
+ * Call session ID
1223
+ * @type {string}
1224
+ * @memberof VideoCallRingEvent
1225
+ */
1226
+ session_id: string;
1227
+ /**
1228
+ * The type of event: "call.notification" in this case
1229
+ * @type {string}
1230
+ * @memberof VideoCallRingEvent
1231
+ */
1232
+ type: string;
1233
+ /**
1234
+ *
1235
+ * @type {VideoUserResponse}
1236
+ * @memberof VideoCallRingEvent
1237
+ */
1238
+ user: VideoUserResponse;
1239
+ }
1240
+ /**
1241
+ * This event is sent when a call session ends
1242
+ * @export
1243
+ * @interface VideoCallSessionEndedEvent
1244
+ */
1245
+ export interface VideoCallSessionEndedEvent {
1246
+ /**
1247
+ *
1248
+ * @type {VideoCallResponse}
1249
+ * @memberof VideoCallSessionEndedEvent
1250
+ */
1251
+ call: VideoCallResponse;
1252
+ /**
1253
+ *
1254
+ * @type {string}
1255
+ * @memberof VideoCallSessionEndedEvent
1256
+ */
1257
+ call_cid: string;
1258
+ /**
1259
+ *
1260
+ * @type {string}
1261
+ * @memberof VideoCallSessionEndedEvent
1262
+ */
1263
+ created_at: string;
1264
+ /**
1265
+ * Call session ID
1266
+ * @type {string}
1267
+ * @memberof VideoCallSessionEndedEvent
1268
+ */
1269
+ session_id: string;
1270
+ /**
1271
+ * The type of event: "call.session_ended" in this case
1272
+ * @type {string}
1273
+ * @memberof VideoCallSessionEndedEvent
1274
+ */
1275
+ type: string;
1276
+ }
1277
+ /**
1278
+ * This event is sent when a participant joins a call session
1279
+ * @export
1280
+ * @interface VideoCallSessionParticipantJoinedEvent
1281
+ */
1282
+ export interface VideoCallSessionParticipantJoinedEvent {
1283
+ /**
1284
+ *
1285
+ * @type {string}
1286
+ * @memberof VideoCallSessionParticipantJoinedEvent
1287
+ */
1288
+ call_cid: string;
1289
+ /**
1290
+ *
1291
+ * @type {string}
1292
+ * @memberof VideoCallSessionParticipantJoinedEvent
1293
+ */
1294
+ created_at: string;
1295
+ /**
1296
+ *
1297
+ * @type {VideoCallParticipantResponse}
1298
+ * @memberof VideoCallSessionParticipantJoinedEvent
1299
+ */
1300
+ participant: VideoCallParticipantResponse;
1301
+ /**
1302
+ * Call session ID
1303
+ * @type {string}
1304
+ * @memberof VideoCallSessionParticipantJoinedEvent
1305
+ */
1306
+ session_id: string;
1307
+ /**
1308
+ * The type of event: "call.session_participant_joined" in this case
1309
+ * @type {string}
1310
+ * @memberof VideoCallSessionParticipantJoinedEvent
1311
+ */
1312
+ type: string;
1313
+ }
1314
+ /**
1315
+ * This event is sent when a participant leaves a call session
1316
+ * @export
1317
+ * @interface VideoCallSessionParticipantLeftEvent
1318
+ */
1319
+ export interface VideoCallSessionParticipantLeftEvent {
1320
+ /**
1321
+ *
1322
+ * @type {string}
1323
+ * @memberof VideoCallSessionParticipantLeftEvent
1324
+ */
1325
+ call_cid: string;
1326
+ /**
1327
+ *
1328
+ * @type {string}
1329
+ * @memberof VideoCallSessionParticipantLeftEvent
1330
+ */
1331
+ created_at: string;
1332
+ /**
1333
+ *
1334
+ * @type {VideoCallParticipantResponse}
1335
+ * @memberof VideoCallSessionParticipantLeftEvent
1336
+ */
1337
+ participant: VideoCallParticipantResponse;
1338
+ /**
1339
+ * Call session ID
1340
+ * @type {string}
1341
+ * @memberof VideoCallSessionParticipantLeftEvent
1342
+ */
1343
+ session_id: string;
1344
+ /**
1345
+ * The type of event: "call.session_participant_left" in this case
1346
+ * @type {string}
1347
+ * @memberof VideoCallSessionParticipantLeftEvent
1348
+ */
1349
+ type: string;
1350
+ }
1351
+ /**
1352
+ *
1353
+ * @export
1354
+ * @interface VideoCallSessionResponse
1355
+ */
1356
+ export interface VideoCallSessionResponse {
1357
+ /**
1358
+ *
1359
+ * @type {{ [key: string]: string; }}
1360
+ * @memberof VideoCallSessionResponse
1361
+ */
1362
+ accepted_by: {
1363
+ [key: string]: string;
1364
+ };
1365
+ /**
1366
+ *
1367
+ * @type {string}
1368
+ * @memberof VideoCallSessionResponse
1369
+ */
1370
+ ended_at?: string;
1371
+ /**
1372
+ *
1373
+ * @type {string}
1374
+ * @memberof VideoCallSessionResponse
1375
+ */
1376
+ id: string;
1377
+ /**
1378
+ *
1379
+ * @type {string}
1380
+ * @memberof VideoCallSessionResponse
1381
+ */
1382
+ live_ended_at?: string;
1383
+ /**
1384
+ *
1385
+ * @type {string}
1386
+ * @memberof VideoCallSessionResponse
1387
+ */
1388
+ live_started_at?: string;
1389
+ /**
1390
+ *
1391
+ * @type {Array<VideoCallParticipantResponse>}
1392
+ * @memberof VideoCallSessionResponse
1393
+ */
1394
+ participants: Array<VideoCallParticipantResponse>;
1395
+ /**
1396
+ *
1397
+ * @type {{ [key: string]: number; }}
1398
+ * @memberof VideoCallSessionResponse
1399
+ */
1400
+ participants_count_by_role: {
1401
+ [key: string]: number;
1402
+ };
1403
+ /**
1404
+ *
1405
+ * @type {{ [key: string]: string; }}
1406
+ * @memberof VideoCallSessionResponse
1407
+ */
1408
+ rejected_by: {
1409
+ [key: string]: string;
1410
+ };
1411
+ /**
1412
+ *
1413
+ * @type {string}
1414
+ * @memberof VideoCallSessionResponse
1415
+ */
1416
+ started_at?: string;
1417
+ }
1418
+ /**
1419
+ * This event is sent when a call session starts
1420
+ * @export
1421
+ * @interface VideoCallSessionStartedEvent
1422
+ */
1423
+ export interface VideoCallSessionStartedEvent {
1424
+ /**
1425
+ *
1426
+ * @type {VideoCallResponse}
1427
+ * @memberof VideoCallSessionStartedEvent
1428
+ */
1429
+ call: VideoCallResponse;
1430
+ /**
1431
+ *
1432
+ * @type {string}
1433
+ * @memberof VideoCallSessionStartedEvent
1434
+ */
1435
+ call_cid: string;
1436
+ /**
1437
+ *
1438
+ * @type {string}
1439
+ * @memberof VideoCallSessionStartedEvent
1440
+ */
1441
+ created_at: string;
1442
+ /**
1443
+ * Call session ID
1444
+ * @type {string}
1445
+ * @memberof VideoCallSessionStartedEvent
1446
+ */
1447
+ session_id: string;
1448
+ /**
1449
+ * The type of event: "call.session_started" in this case
1450
+ * @type {string}
1451
+ * @memberof VideoCallSessionStartedEvent
1452
+ */
1453
+ type: string;
1454
+ }
1455
+ /**
1456
+ *
1457
+ * @export
1458
+ * @interface VideoCallSettingsRequest
1459
+ */
1460
+ export interface VideoCallSettingsRequest {
1461
+ /**
1462
+ *
1463
+ * @type {VideoAudioSettingsRequest}
1464
+ * @memberof VideoCallSettingsRequest
1465
+ */
1466
+ audio?: VideoAudioSettingsRequest;
1467
+ /**
1468
+ *
1469
+ * @type {VideoBackstageSettingsRequest}
1470
+ * @memberof VideoCallSettingsRequest
1471
+ */
1472
+ backstage?: VideoBackstageSettingsRequest;
1473
+ /**
1474
+ *
1475
+ * @type {VideoBroadcastSettingsRequest}
1476
+ * @memberof VideoCallSettingsRequest
1477
+ */
1478
+ broadcasting?: VideoBroadcastSettingsRequest;
1479
+ /**
1480
+ *
1481
+ * @type {VideoGeofenceSettingsRequest}
1482
+ * @memberof VideoCallSettingsRequest
1483
+ */
1484
+ geofencing?: VideoGeofenceSettingsRequest;
1485
+ /**
1486
+ *
1487
+ * @type {VideoRecordSettingsRequest}
1488
+ * @memberof VideoCallSettingsRequest
1489
+ */
1490
+ recording?: VideoRecordSettingsRequest;
1491
+ /**
1492
+ *
1493
+ * @type {VideoRingSettingsRequest}
1494
+ * @memberof VideoCallSettingsRequest
1495
+ */
1496
+ ring?: VideoRingSettingsRequest;
1497
+ /**
1498
+ *
1499
+ * @type {VideoScreensharingSettingsRequest}
1500
+ * @memberof VideoCallSettingsRequest
1501
+ */
1502
+ screensharing?: VideoScreensharingSettingsRequest;
1503
+ /**
1504
+ *
1505
+ * @type {VideoThumbnailsSettingsRequest}
1506
+ * @memberof VideoCallSettingsRequest
1507
+ */
1508
+ thumbnails?: VideoThumbnailsSettingsRequest;
1509
+ /**
1510
+ *
1511
+ * @type {VideoTranscriptionSettingsRequest}
1512
+ * @memberof VideoCallSettingsRequest
1513
+ */
1514
+ transcription?: VideoTranscriptionSettingsRequest;
1515
+ /**
1516
+ *
1517
+ * @type {VideoVideoSettingsRequest}
1518
+ * @memberof VideoCallSettingsRequest
1519
+ */
1520
+ video?: VideoVideoSettingsRequest;
1521
+ }
1522
+ /**
1523
+ *
1524
+ * @export
1525
+ * @interface VideoCallSettingsResponse
1526
+ */
1527
+ export interface VideoCallSettingsResponse {
1528
+ /**
1529
+ *
1530
+ * @type {VideoAudioSettings}
1531
+ * @memberof VideoCallSettingsResponse
1532
+ */
1533
+ audio: VideoAudioSettings;
1534
+ /**
1535
+ *
1536
+ * @type {VideoBackstageSettings}
1537
+ * @memberof VideoCallSettingsResponse
1538
+ */
1539
+ backstage: VideoBackstageSettings;
1540
+ /**
1541
+ *
1542
+ * @type {VideoBroadcastSettingsResponse}
1543
+ * @memberof VideoCallSettingsResponse
1544
+ */
1545
+ broadcasting: VideoBroadcastSettingsResponse;
1546
+ /**
1547
+ *
1548
+ * @type {VideoGeofenceSettings}
1549
+ * @memberof VideoCallSettingsResponse
1550
+ */
1551
+ geofencing: VideoGeofenceSettings;
1552
+ /**
1553
+ *
1554
+ * @type {VideoRecordSettingsResponse}
1555
+ * @memberof VideoCallSettingsResponse
1556
+ */
1557
+ recording: VideoRecordSettingsResponse;
1558
+ /**
1559
+ *
1560
+ * @type {VideoRingSettings}
1561
+ * @memberof VideoCallSettingsResponse
1562
+ */
1563
+ ring: VideoRingSettings;
1564
+ /**
1565
+ *
1566
+ * @type {VideoScreensharingSettings}
1567
+ * @memberof VideoCallSettingsResponse
1568
+ */
1569
+ screensharing: VideoScreensharingSettings;
1570
+ /**
1571
+ *
1572
+ * @type {VideoThumbnailsSettings}
1573
+ * @memberof VideoCallSettingsResponse
1574
+ */
1575
+ thumbnails: VideoThumbnailsSettings;
1576
+ /**
1577
+ *
1578
+ * @type {VideoTranscriptionSettings}
1579
+ * @memberof VideoCallSettingsResponse
1580
+ */
1581
+ transcription: VideoTranscriptionSettings;
1582
+ /**
1583
+ *
1584
+ * @type {VideoVideoSettings}
1585
+ * @memberof VideoCallSettingsResponse
1586
+ */
1587
+ video: VideoVideoSettings;
1588
+ }
1589
+ /**
1590
+ *
1591
+ * @export
1592
+ * @interface VideoCallStateResponseFields
1593
+ */
1594
+ export interface VideoCallStateResponseFields {
1595
+ /**
1596
+ *
1597
+ * @type {VideoCallResponse}
1598
+ * @memberof VideoCallStateResponseFields
1599
+ */
1600
+ call: VideoCallResponse;
1601
+ /**
1602
+ * List of call members
1603
+ * @type {Array<VideoMemberResponse>}
1604
+ * @memberof VideoCallStateResponseFields
1605
+ */
1606
+ members: Array<VideoMemberResponse>;
1607
+ /**
1608
+ *
1609
+ * @type {VideoMemberResponse}
1610
+ * @memberof VideoCallStateResponseFields
1611
+ */
1612
+ membership?: VideoMemberResponse;
1613
+ /**
1614
+ *
1615
+ * @type {Array<VideoOwnCapability>}
1616
+ * @memberof VideoCallStateResponseFields
1617
+ */
1618
+ own_capabilities: Array<VideoOwnCapability>;
1619
+ }
1620
+ /**
1621
+ *
1622
+ * @export
1623
+ * @interface VideoCallTypeResponse
1624
+ */
1625
+ export interface VideoCallTypeResponse {
1626
+ /**
1627
+ *
1628
+ * @type {string}
1629
+ * @memberof VideoCallTypeResponse
1630
+ */
1631
+ created_at: string;
1632
+ /**
1633
+ *
1634
+ * @type {{ [key: string]: Array<string>; }}
1635
+ * @memberof VideoCallTypeResponse
1636
+ */
1637
+ grants: {
1638
+ [key: string]: Array<string>;
1639
+ };
1640
+ /**
1641
+ *
1642
+ * @type {string}
1643
+ * @memberof VideoCallTypeResponse
1644
+ */
1645
+ name: string;
1646
+ /**
1647
+ *
1648
+ * @type {VideoNotificationSettings}
1649
+ * @memberof VideoCallTypeResponse
1650
+ */
1651
+ notification_settings: VideoNotificationSettings;
1652
+ /**
1653
+ *
1654
+ * @type {VideoCallSettingsResponse}
1655
+ * @memberof VideoCallTypeResponse
1656
+ */
1657
+ settings: VideoCallSettingsResponse;
1658
+ /**
1659
+ *
1660
+ * @type {string}
1661
+ * @memberof VideoCallTypeResponse
1662
+ */
1663
+ updated_at: string;
1664
+ }
1665
+ /**
1666
+ * This event is sent when a call is updated, clients should use this update the local state of the call.
1667
+ * This event also contains the capabilities by role for the call, clients should update the own_capability for the current.
1668
+ * @export
1669
+ * @interface VideoCallUpdatedEvent
1670
+ */
1671
+ export interface VideoCallUpdatedEvent {
1672
+ /**
1673
+ *
1674
+ * @type {VideoCallResponse}
1675
+ * @memberof VideoCallUpdatedEvent
1676
+ */
1677
+ call: VideoCallResponse;
1678
+ /**
1679
+ *
1680
+ * @type {string}
1681
+ * @memberof VideoCallUpdatedEvent
1682
+ */
1683
+ call_cid: string;
1684
+ /**
1685
+ * The capabilities by role for this call
1686
+ * @type {{ [key: string]: Array<string>; }}
1687
+ * @memberof VideoCallUpdatedEvent
1688
+ */
1689
+ capabilities_by_role: {
1690
+ [key: string]: Array<string>;
1691
+ };
1692
+ /**
1693
+ *
1694
+ * @type {string}
1695
+ * @memberof VideoCallUpdatedEvent
1696
+ */
1697
+ created_at: string;
1698
+ /**
1699
+ * The type of event: "call.ended" in this case
1700
+ * @type {string}
1701
+ * @memberof VideoCallUpdatedEvent
1702
+ */
1703
+ type: string;
1704
+ }
1705
+ /**
1706
+ * This event is sent when a call member is muted
1707
+ * @export
1708
+ * @interface VideoCallUserMuted
1709
+ */
1710
+ export interface VideoCallUserMuted {
1711
+ /**
1712
+ *
1713
+ * @type {string}
1714
+ * @memberof VideoCallUserMuted
1715
+ */
1716
+ call_cid: string;
1717
+ /**
1718
+ *
1719
+ * @type {string}
1720
+ * @memberof VideoCallUserMuted
1721
+ */
1722
+ created_at: string;
1723
+ /**
1724
+ *
1725
+ * @type {string}
1726
+ * @memberof VideoCallUserMuted
1727
+ */
1728
+ from_user_id: string;
1729
+ /**
1730
+ *
1731
+ * @type {Array<string>}
1732
+ * @memberof VideoCallUserMuted
1733
+ */
1734
+ muted_user_ids: Array<string>;
1735
+ /**
1736
+ * The type of event: "call.user_muted" in this case
1737
+ * @type {string}
1738
+ * @memberof VideoCallUserMuted
1739
+ */
1740
+ type: string;
1741
+ }
1742
+ /**
1743
+ *
1744
+ * @export
1745
+ * @interface VideoConnectUserDetailsRequest
1746
+ */
1747
+ export interface VideoConnectUserDetailsRequest {
1748
+ /**
1749
+ *
1750
+ * @type {{ [key: string]: any; }}
1751
+ * @memberof VideoConnectUserDetailsRequest
1752
+ */
1753
+ custom?: {
1754
+ [key: string]: any;
1755
+ };
1756
+ /**
1757
+ *
1758
+ * @type {string}
1759
+ * @memberof VideoConnectUserDetailsRequest
1760
+ */
1761
+ id: string;
1762
+ /**
1763
+ *
1764
+ * @type {string}
1765
+ * @memberof VideoConnectUserDetailsRequest
1766
+ */
1767
+ image?: string;
1768
+ /**
1769
+ *
1770
+ * @type {string}
1771
+ * @memberof VideoConnectUserDetailsRequest
1772
+ */
1773
+ name?: string;
1774
+ }
1775
+ /**
1776
+ * This event is sent when the WS connection is established and authenticated, this event contains the full user object as it is stored on the server
1777
+ * @export
1778
+ * @interface VideoConnectedEvent
1779
+ */
1780
+ export interface VideoConnectedEvent {
1781
+ /**
1782
+ * The connection_id for this client
1783
+ * @type {string}
1784
+ * @memberof VideoConnectedEvent
1785
+ */
1786
+ connection_id: string;
1787
+ /**
1788
+ *
1789
+ * @type {string}
1790
+ * @memberof VideoConnectedEvent
1791
+ */
1792
+ created_at: string;
1793
+ /**
1794
+ *
1795
+ * @type {VideoOwnUserResponse}
1796
+ * @memberof VideoConnectedEvent
1797
+ */
1798
+ me: VideoOwnUserResponse;
1799
+ /**
1800
+ * The type of event: "connection.ok" in this case
1801
+ * @type {string}
1802
+ * @memberof VideoConnectedEvent
1803
+ */
1804
+ type: string;
1805
+ }
1806
+ /**
1807
+ * This event is sent when the WS connection fails
1808
+ * @export
1809
+ * @interface VideoConnectionErrorEvent
1810
+ */
1811
+ export interface VideoConnectionErrorEvent {
1812
+ /**
1813
+ *
1814
+ * @type {string}
1815
+ * @memberof VideoConnectionErrorEvent
1816
+ */
1817
+ connection_id: string;
1818
+ /**
1819
+ *
1820
+ * @type {string}
1821
+ * @memberof VideoConnectionErrorEvent
1822
+ */
1823
+ created_at: string;
1824
+ /**
1825
+ *
1826
+ * @type {VideoAPIError}
1827
+ * @memberof VideoConnectionErrorEvent
1828
+ */
1829
+ error: VideoAPIError | null;
1830
+ /**
1831
+ * The type of event: "connection.ok" in this case
1832
+ * @type {string}
1833
+ * @memberof VideoConnectionErrorEvent
1834
+ */
1835
+ type: string;
1836
+ }
1837
+ /**
1838
+ *
1839
+ * @export
1840
+ * @interface VideoCreateCallTypeRequest
1841
+ */
1842
+ export interface VideoCreateCallTypeRequest {
1843
+ /**
1844
+ *
1845
+ * @type {{ [key: string]: Array<string>; }}
1846
+ * @memberof VideoCreateCallTypeRequest
1847
+ */
1848
+ grants?: {
1849
+ [key: string]: Array<string>;
1850
+ };
1851
+ /**
1852
+ *
1853
+ * @type {string}
1854
+ * @memberof VideoCreateCallTypeRequest
1855
+ */
1856
+ name: string;
1857
+ /**
1858
+ *
1859
+ * @type {VideoNotificationSettingsRequest}
1860
+ * @memberof VideoCreateCallTypeRequest
1861
+ */
1862
+ notification_settings?: VideoNotificationSettingsRequest;
1863
+ /**
1864
+ *
1865
+ * @type {VideoCallSettingsRequest}
1866
+ * @memberof VideoCreateCallTypeRequest
1867
+ */
1868
+ settings?: VideoCallSettingsRequest;
1869
+ }
1870
+ /**
1871
+ *
1872
+ * @export
1873
+ * @interface VideoCreateCallTypeResponse
1874
+ */
1875
+ export interface VideoCreateCallTypeResponse {
1876
+ /**
1877
+ *
1878
+ * @type {string}
1879
+ * @memberof VideoCreateCallTypeResponse
1880
+ */
1881
+ created_at: string;
1882
+ /**
1883
+ *
1884
+ * @type {string}
1885
+ * @memberof VideoCreateCallTypeResponse
1886
+ */
1887
+ duration: string;
1888
+ /**
1889
+ *
1890
+ * @type {{ [key: string]: Array<string>; }}
1891
+ * @memberof VideoCreateCallTypeResponse
1892
+ */
1893
+ grants: {
1894
+ [key: string]: Array<string>;
1895
+ };
1896
+ /**
1897
+ *
1898
+ * @type {string}
1899
+ * @memberof VideoCreateCallTypeResponse
1900
+ */
1901
+ name: string;
1902
+ /**
1903
+ *
1904
+ * @type {VideoNotificationSettings}
1905
+ * @memberof VideoCreateCallTypeResponse
1906
+ */
1907
+ notification_settings: VideoNotificationSettings;
1908
+ /**
1909
+ *
1910
+ * @type {VideoCallSettingsResponse}
1911
+ * @memberof VideoCreateCallTypeResponse
1912
+ */
1913
+ settings: VideoCallSettingsResponse;
1914
+ /**
1915
+ *
1916
+ * @type {string}
1917
+ * @memberof VideoCreateCallTypeResponse
1918
+ */
1919
+ updated_at: string;
1920
+ }
1921
+ /**
1922
+ *
1923
+ * @export
1924
+ * @interface VideoCreateDeviceRequest
1925
+ */
1926
+ export interface VideoCreateDeviceRequest {
1927
+ /**
1928
+ *
1929
+ * @type {string}
1930
+ * @memberof VideoCreateDeviceRequest
1931
+ */
1932
+ id?: string;
1933
+ /**
1934
+ *
1935
+ * @type {string}
1936
+ * @memberof VideoCreateDeviceRequest
1937
+ */
1938
+ push_provider?: VideoCreateDeviceRequestPushProviderEnum;
1939
+ /**
1940
+ *
1941
+ * @type {string}
1942
+ * @memberof VideoCreateDeviceRequest
1943
+ */
1944
+ push_provider_name?: string;
1945
+ /**
1946
+ *
1947
+ * @type {VideoUserRequest}
1948
+ * @memberof VideoCreateDeviceRequest
1949
+ */
1950
+ user?: VideoUserRequest;
1951
+ /**
1952
+ *
1953
+ * @type {string}
1954
+ * @memberof VideoCreateDeviceRequest
1955
+ */
1956
+ user_id?: string;
1957
+ /**
1958
+ *
1959
+ * @type {boolean}
1960
+ * @memberof VideoCreateDeviceRequest
1961
+ */
1962
+ voip_token?: boolean;
1963
+ }
1964
+ /**
1965
+ * @export
1966
+ */
1967
+ export declare const VideoCreateDeviceRequestPushProviderEnum: {
1968
+ readonly FIREBASE: "firebase";
1969
+ readonly APN: "apn";
1970
+ readonly HUAWEI: "huawei";
1971
+ readonly XIAOMI: "xiaomi";
1972
+ };
1973
+ export type VideoCreateDeviceRequestPushProviderEnum = typeof VideoCreateDeviceRequestPushProviderEnum[keyof typeof VideoCreateDeviceRequestPushProviderEnum];
1974
+ /**
1975
+ *
1976
+ * @export
1977
+ * @interface VideoCreateGuestRequest
1978
+ */
1979
+ export interface VideoCreateGuestRequest {
1980
+ /**
1981
+ *
1982
+ * @type {VideoUserRequest}
1983
+ * @memberof VideoCreateGuestRequest
1984
+ */
1985
+ user: VideoUserRequest;
1986
+ }
1987
+ /**
1988
+ *
1989
+ * @export
1990
+ * @interface VideoCreateGuestResponse
1991
+ */
1992
+ export interface VideoCreateGuestResponse {
1993
+ /**
1994
+ * the access token to authenticate the user
1995
+ * @type {string}
1996
+ * @memberof VideoCreateGuestResponse
1997
+ */
1998
+ access_token: string;
1999
+ /**
2000
+ *
2001
+ * @type {string}
2002
+ * @memberof VideoCreateGuestResponse
2003
+ */
2004
+ duration: string;
2005
+ /**
2006
+ *
2007
+ * @type {VideoUserResponse}
2008
+ * @memberof VideoCreateGuestResponse
2009
+ */
2010
+ user: VideoUserResponse;
2011
+ }
2012
+ /**
2013
+ *
2014
+ * @export
2015
+ * @interface VideoCredentials
2016
+ */
2017
+ export interface VideoCredentials {
2018
+ /**
2019
+ *
2020
+ * @type {Array<VideoICEServer>}
2021
+ * @memberof VideoCredentials
2022
+ */
2023
+ ice_servers: Array<VideoICEServer>;
2024
+ /**
2025
+ *
2026
+ * @type {VideoSFUResponse}
2027
+ * @memberof VideoCredentials
2028
+ */
2029
+ server: VideoSFUResponse;
2030
+ /**
2031
+ *
2032
+ * @type {string}
2033
+ * @memberof VideoCredentials
2034
+ */
2035
+ token: string;
2036
+ }
2037
+ /**
2038
+ * A custom event, this event is used to send custom events to other participants in the call.
2039
+ * @export
2040
+ * @interface VideoCustomVideoEvent
2041
+ */
2042
+ export interface VideoCustomVideoEvent {
2043
+ /**
2044
+ *
2045
+ * @type {string}
2046
+ * @memberof VideoCustomVideoEvent
2047
+ */
2048
+ call_cid: string;
2049
+ /**
2050
+ *
2051
+ * @type {string}
2052
+ * @memberof VideoCustomVideoEvent
2053
+ */
2054
+ created_at: string;
2055
+ /**
2056
+ * Custom data for this object
2057
+ * @type {{ [key: string]: any; }}
2058
+ * @memberof VideoCustomVideoEvent
2059
+ */
2060
+ custom: {
2061
+ [key: string]: any;
2062
+ };
2063
+ /**
2064
+ * The type of event, "custom" in this case
2065
+ * @type {string}
2066
+ * @memberof VideoCustomVideoEvent
2067
+ */
2068
+ type: string;
2069
+ /**
2070
+ *
2071
+ * @type {VideoUserResponse}
2072
+ * @memberof VideoCustomVideoEvent
2073
+ */
2074
+ user: VideoUserResponse;
2075
+ }
2076
+ /**
2077
+ *
2078
+ * @export
2079
+ * @interface VideoDevice
2080
+ */
2081
+ export interface VideoDevice {
2082
+ /**
2083
+ * Date/time of creation
2084
+ * @type {string}
2085
+ * @memberof VideoDevice
2086
+ */
2087
+ created_at: string;
2088
+ /**
2089
+ * Whether device is disabled or not
2090
+ * @type {boolean}
2091
+ * @memberof VideoDevice
2092
+ */
2093
+ disabled?: boolean;
2094
+ /**
2095
+ * Reason explaining why device had been disabled
2096
+ * @type {string}
2097
+ * @memberof VideoDevice
2098
+ */
2099
+ disabled_reason?: string;
2100
+ /**
2101
+ *
2102
+ * @type {string}
2103
+ * @memberof VideoDevice
2104
+ */
2105
+ id: string;
2106
+ /**
2107
+ *
2108
+ * @type {string}
2109
+ * @memberof VideoDevice
2110
+ */
2111
+ push_provider: string;
2112
+ /**
2113
+ *
2114
+ * @type {string}
2115
+ * @memberof VideoDevice
2116
+ */
2117
+ push_provider_name?: string;
2118
+ /**
2119
+ * When true the token is for Apple VoIP push notifications
2120
+ * @type {boolean}
2121
+ * @memberof VideoDevice
2122
+ */
2123
+ voip?: boolean;
2124
+ }
2125
+ /**
2126
+ *
2127
+ * @export
2128
+ * @interface VideoEdgeResponse
2129
+ */
2130
+ export interface VideoEdgeResponse {
2131
+ /**
2132
+ *
2133
+ * @type {string}
2134
+ * @memberof VideoEdgeResponse
2135
+ */
2136
+ continent_code: string;
2137
+ /**
2138
+ *
2139
+ * @type {string}
2140
+ * @memberof VideoEdgeResponse
2141
+ */
2142
+ country_iso_code: string;
2143
+ /**
2144
+ *
2145
+ * @type {number}
2146
+ * @memberof VideoEdgeResponse
2147
+ */
2148
+ green: number;
2149
+ /**
2150
+ *
2151
+ * @type {string}
2152
+ * @memberof VideoEdgeResponse
2153
+ */
2154
+ id: string;
2155
+ /**
2156
+ *
2157
+ * @type {string}
2158
+ * @memberof VideoEdgeResponse
2159
+ */
2160
+ latency_test_url: string;
2161
+ /**
2162
+ *
2163
+ * @type {number}
2164
+ * @memberof VideoEdgeResponse
2165
+ */
2166
+ latitude: number;
2167
+ /**
2168
+ *
2169
+ * @type {number}
2170
+ * @memberof VideoEdgeResponse
2171
+ */
2172
+ longitude: number;
2173
+ /**
2174
+ *
2175
+ * @type {number}
2176
+ * @memberof VideoEdgeResponse
2177
+ */
2178
+ red: number;
2179
+ /**
2180
+ *
2181
+ * @type {string}
2182
+ * @memberof VideoEdgeResponse
2183
+ */
2184
+ subdivision_iso_code: string;
2185
+ /**
2186
+ *
2187
+ * @type {number}
2188
+ * @memberof VideoEdgeResponse
2189
+ */
2190
+ yellow: number;
2191
+ }
2192
+ /**
2193
+ *
2194
+ * @export
2195
+ * @interface VideoEgressHLSResponse
2196
+ */
2197
+ export interface VideoEgressHLSResponse {
2198
+ /**
2199
+ *
2200
+ * @type {string}
2201
+ * @memberof VideoEgressHLSResponse
2202
+ */
2203
+ playlist_url: string;
2204
+ }
2205
+ /**
2206
+ *
2207
+ * @export
2208
+ * @interface VideoEgressRTMPResponse
2209
+ */
2210
+ export interface VideoEgressRTMPResponse {
2211
+ /**
2212
+ *
2213
+ * @type {string}
2214
+ * @memberof VideoEgressRTMPResponse
2215
+ */
2216
+ name: string;
2217
+ /**
2218
+ *
2219
+ * @type {string}
2220
+ * @memberof VideoEgressRTMPResponse
2221
+ */
2222
+ stream_key: string;
2223
+ /**
2224
+ *
2225
+ * @type {string}
2226
+ * @memberof VideoEgressRTMPResponse
2227
+ */
2228
+ url: string;
2229
+ }
2230
+ /**
2231
+ *
2232
+ * @export
2233
+ * @interface VideoEgressResponse
2234
+ */
2235
+ export interface VideoEgressResponse {
2236
+ /**
2237
+ *
2238
+ * @type {boolean}
2239
+ * @memberof VideoEgressResponse
2240
+ */
2241
+ broadcasting: boolean;
2242
+ /**
2243
+ *
2244
+ * @type {VideoEgressHLSResponse}
2245
+ * @memberof VideoEgressResponse
2246
+ */
2247
+ hls?: VideoEgressHLSResponse;
2248
+ /**
2249
+ *
2250
+ * @type {Array<VideoEgressRTMPResponse>}
2251
+ * @memberof VideoEgressResponse
2252
+ */
2253
+ rtmps: Array<VideoEgressRTMPResponse>;
2254
+ }
2255
+ /**
2256
+ *
2257
+ * @export
2258
+ * @interface VideoEndCallResponse
2259
+ */
2260
+ export interface VideoEndCallResponse {
2261
+ /**
2262
+ *
2263
+ * @type {string}
2264
+ * @memberof VideoEndCallResponse
2265
+ */
2266
+ duration: string;
2267
+ }
2268
+ /**
2269
+ *
2270
+ * @export
2271
+ * @interface VideoEventNotificationSettings
2272
+ */
2273
+ export interface VideoEventNotificationSettings {
2274
+ /**
2275
+ *
2276
+ * @type {VideoAPNS}
2277
+ * @memberof VideoEventNotificationSettings
2278
+ */
2279
+ apns: VideoAPNS;
2280
+ /**
2281
+ *
2282
+ * @type {boolean}
2283
+ * @memberof VideoEventNotificationSettings
2284
+ */
2285
+ enabled: boolean;
2286
+ }
2287
+ /**
2288
+ *
2289
+ * @export
2290
+ * @interface VideoEventNotificationSettingsRequest
2291
+ */
2292
+ export interface VideoEventNotificationSettingsRequest {
2293
+ /**
2294
+ *
2295
+ * @type {VideoAPNSRequest}
2296
+ * @memberof VideoEventNotificationSettingsRequest
2297
+ */
2298
+ apns?: VideoAPNSRequest;
2299
+ /**
2300
+ *
2301
+ * @type {boolean}
2302
+ * @memberof VideoEventNotificationSettingsRequest
2303
+ */
2304
+ enabled?: boolean;
2305
+ }
2306
+ /**
2307
+ *
2308
+ * @export
2309
+ * @interface VideoGeofenceSettings
2310
+ */
2311
+ export interface VideoGeofenceSettings {
2312
+ /**
2313
+ *
2314
+ * @type {Array<string>}
2315
+ * @memberof VideoGeofenceSettings
2316
+ */
2317
+ names: Array<string>;
2318
+ }
2319
+ /**
2320
+ *
2321
+ * @export
2322
+ * @interface VideoGeofenceSettingsRequest
2323
+ */
2324
+ export interface VideoGeofenceSettingsRequest {
2325
+ /**
2326
+ *
2327
+ * @type {Array<string>}
2328
+ * @memberof VideoGeofenceSettingsRequest
2329
+ */
2330
+ names?: Array<string>;
2331
+ }
2332
+ /**
2333
+ *
2334
+ * @export
2335
+ * @interface VideoGetCallResponse
2336
+ */
2337
+ export interface VideoGetCallResponse {
2338
+ /**
2339
+ *
2340
+ * @type {VideoCallResponse}
2341
+ * @memberof VideoGetCallResponse
2342
+ */
2343
+ call: VideoCallResponse;
2344
+ /**
2345
+ *
2346
+ * @type {string}
2347
+ * @memberof VideoGetCallResponse
2348
+ */
2349
+ duration: string;
2350
+ /**
2351
+ *
2352
+ * @type {Array<VideoMemberResponse>}
2353
+ * @memberof VideoGetCallResponse
2354
+ */
2355
+ members: Array<VideoMemberResponse>;
2356
+ /**
2357
+ *
2358
+ * @type {VideoMemberResponse}
2359
+ * @memberof VideoGetCallResponse
2360
+ */
2361
+ membership?: VideoMemberResponse;
2362
+ /**
2363
+ *
2364
+ * @type {Array<VideoOwnCapability>}
2365
+ * @memberof VideoGetCallResponse
2366
+ */
2367
+ own_capabilities: Array<VideoOwnCapability>;
2368
+ }
2369
+ /**
2370
+ *
2371
+ * @export
2372
+ * @interface VideoGetCallTypeResponse
2373
+ */
2374
+ export interface VideoGetCallTypeResponse {
2375
+ /**
2376
+ *
2377
+ * @type {string}
2378
+ * @memberof VideoGetCallTypeResponse
2379
+ */
2380
+ created_at: string;
2381
+ /**
2382
+ *
2383
+ * @type {string}
2384
+ * @memberof VideoGetCallTypeResponse
2385
+ */
2386
+ duration: string;
2387
+ /**
2388
+ *
2389
+ * @type {{ [key: string]: Array<string>; }}
2390
+ * @memberof VideoGetCallTypeResponse
2391
+ */
2392
+ grants: {
2393
+ [key: string]: Array<string>;
2394
+ };
2395
+ /**
2396
+ *
2397
+ * @type {string}
2398
+ * @memberof VideoGetCallTypeResponse
2399
+ */
2400
+ name: string;
2401
+ /**
2402
+ *
2403
+ * @type {VideoNotificationSettings}
2404
+ * @memberof VideoGetCallTypeResponse
2405
+ */
2406
+ notification_settings: VideoNotificationSettings;
2407
+ /**
2408
+ *
2409
+ * @type {VideoCallSettingsResponse}
2410
+ * @memberof VideoGetCallTypeResponse
2411
+ */
2412
+ settings: VideoCallSettingsResponse;
2413
+ /**
2414
+ *
2415
+ * @type {string}
2416
+ * @memberof VideoGetCallTypeResponse
2417
+ */
2418
+ updated_at: string;
2419
+ }
2420
+ /**
2421
+ *
2422
+ * @export
2423
+ * @interface VideoGetEdgesResponse
2424
+ */
2425
+ export interface VideoGetEdgesResponse {
2426
+ /**
2427
+ * Duration of the request in human-readable format
2428
+ * @type {string}
2429
+ * @memberof VideoGetEdgesResponse
2430
+ */
2431
+ duration: string;
2432
+ /**
2433
+ *
2434
+ * @type {Array<VideoEdgeResponse>}
2435
+ * @memberof VideoGetEdgesResponse
2436
+ */
2437
+ edges: Array<VideoEdgeResponse>;
2438
+ }
2439
+ /**
2440
+ *
2441
+ * @export
2442
+ * @interface VideoGetOrCreateCallRequest
2443
+ */
2444
+ export interface VideoGetOrCreateCallRequest {
2445
+ /**
2446
+ *
2447
+ * @type {VideoCallRequest}
2448
+ * @memberof VideoGetOrCreateCallRequest
2449
+ */
2450
+ data?: VideoCallRequest;
2451
+ /**
2452
+ *
2453
+ * @type {number}
2454
+ * @memberof VideoGetOrCreateCallRequest
2455
+ */
2456
+ members_limit?: number;
2457
+ /**
2458
+ * if provided it sends a notification event to the members for this call
2459
+ * @type {boolean}
2460
+ * @memberof VideoGetOrCreateCallRequest
2461
+ */
2462
+ notify?: boolean;
2463
+ /**
2464
+ * if provided it sends a ring event to the members for this call
2465
+ * @type {boolean}
2466
+ * @memberof VideoGetOrCreateCallRequest
2467
+ */
2468
+ ring?: boolean;
2469
+ }
2470
+ /**
2471
+ *
2472
+ * @export
2473
+ * @interface VideoGetOrCreateCallResponse
2474
+ */
2475
+ export interface VideoGetOrCreateCallResponse {
2476
+ /**
2477
+ *
2478
+ * @type {VideoCallResponse}
2479
+ * @memberof VideoGetOrCreateCallResponse
2480
+ */
2481
+ call: VideoCallResponse;
2482
+ /**
2483
+ *
2484
+ * @type {boolean}
2485
+ * @memberof VideoGetOrCreateCallResponse
2486
+ */
2487
+ created: boolean;
2488
+ /**
2489
+ *
2490
+ * @type {string}
2491
+ * @memberof VideoGetOrCreateCallResponse
2492
+ */
2493
+ duration: string;
2494
+ /**
2495
+ *
2496
+ * @type {Array<VideoMemberResponse>}
2497
+ * @memberof VideoGetOrCreateCallResponse
2498
+ */
2499
+ members: Array<VideoMemberResponse>;
2500
+ /**
2501
+ *
2502
+ * @type {VideoMemberResponse}
2503
+ * @memberof VideoGetOrCreateCallResponse
2504
+ */
2505
+ membership?: VideoMemberResponse;
2506
+ /**
2507
+ *
2508
+ * @type {Array<VideoOwnCapability>}
2509
+ * @memberof VideoGetOrCreateCallResponse
2510
+ */
2511
+ own_capabilities: Array<VideoOwnCapability>;
2512
+ }
2513
+ /**
2514
+ *
2515
+ * @export
2516
+ * @interface VideoGoLiveRequest
2517
+ */
2518
+ export interface VideoGoLiveRequest {
2519
+ /**
2520
+ *
2521
+ * @type {boolean}
2522
+ * @memberof VideoGoLiveRequest
2523
+ */
2524
+ start_hls?: boolean;
2525
+ /**
2526
+ *
2527
+ * @type {boolean}
2528
+ * @memberof VideoGoLiveRequest
2529
+ */
2530
+ start_recording?: boolean;
2531
+ /**
2532
+ *
2533
+ * @type {boolean}
2534
+ * @memberof VideoGoLiveRequest
2535
+ */
2536
+ start_transcription?: boolean;
2537
+ }
2538
+ /**
2539
+ *
2540
+ * @export
2541
+ * @interface VideoGoLiveResponse
2542
+ */
2543
+ export interface VideoGoLiveResponse {
2544
+ /**
2545
+ *
2546
+ * @type {VideoCallResponse}
2547
+ * @memberof VideoGoLiveResponse
2548
+ */
2549
+ call: VideoCallResponse;
2550
+ /**
2551
+ * Duration of the request in human-readable format
2552
+ * @type {string}
2553
+ * @memberof VideoGoLiveResponse
2554
+ */
2555
+ duration: string;
2556
+ }
2557
+ /**
2558
+ *
2559
+ * @export
2560
+ * @interface VideoHLSSettingsRequest
2561
+ */
2562
+ export interface VideoHLSSettingsRequest {
2563
+ /**
2564
+ *
2565
+ * @type {boolean}
2566
+ * @memberof VideoHLSSettingsRequest
2567
+ */
2568
+ auto_on?: boolean;
2569
+ /**
2570
+ *
2571
+ * @type {boolean}
2572
+ * @memberof VideoHLSSettingsRequest
2573
+ */
2574
+ enabled?: boolean;
2575
+ /**
2576
+ *
2577
+ * @type {VideoLayoutSettingsRequest}
2578
+ * @memberof VideoHLSSettingsRequest
2579
+ */
2580
+ layout?: VideoLayoutSettingsRequest;
2581
+ /**
2582
+ *
2583
+ * @type {Array<string>}
2584
+ * @memberof VideoHLSSettingsRequest
2585
+ */
2586
+ quality_tracks?: Array<string>;
2587
+ }
2588
+ /**
2589
+ *
2590
+ * @export
2591
+ * @interface VideoHLSSettingsResponse
2592
+ */
2593
+ export interface VideoHLSSettingsResponse {
2594
+ /**
2595
+ *
2596
+ * @type {boolean}
2597
+ * @memberof VideoHLSSettingsResponse
2598
+ */
2599
+ auto_on: boolean;
2600
+ /**
2601
+ *
2602
+ * @type {boolean}
2603
+ * @memberof VideoHLSSettingsResponse
2604
+ */
2605
+ enabled: boolean;
2606
+ /**
2607
+ *
2608
+ * @type {VideoLayoutSettings}
2609
+ * @memberof VideoHLSSettingsResponse
2610
+ */
2611
+ layout: VideoLayoutSettings;
2612
+ /**
2613
+ *
2614
+ * @type {Array<string>}
2615
+ * @memberof VideoHLSSettingsResponse
2616
+ */
2617
+ quality_tracks: Array<string>;
2618
+ }
2619
+ /**
2620
+ *
2621
+ * @export
2622
+ * @interface VideoHealthCheckEvent
2623
+ */
2624
+ export interface VideoHealthCheckEvent {
2625
+ /**
2626
+ * The connection_id for this client
2627
+ * @type {string}
2628
+ * @memberof VideoHealthCheckEvent
2629
+ */
2630
+ connection_id: string;
2631
+ /**
2632
+ *
2633
+ * @type {string}
2634
+ * @memberof VideoHealthCheckEvent
2635
+ */
2636
+ created_at: string;
2637
+ /**
2638
+ * The type of event: "health.check" in this case
2639
+ * @type {string}
2640
+ * @memberof VideoHealthCheckEvent
2641
+ */
2642
+ type: string;
2643
+ }
2644
+ /**
2645
+ *
2646
+ * @export
2647
+ * @interface VideoICEServer
2648
+ */
2649
+ export interface VideoICEServer {
2650
+ /**
2651
+ *
2652
+ * @type {string}
2653
+ * @memberof VideoICEServer
2654
+ */
2655
+ password: string;
2656
+ /**
2657
+ *
2658
+ * @type {Array<string>}
2659
+ * @memberof VideoICEServer
2660
+ */
2661
+ urls: Array<string>;
2662
+ /**
2663
+ *
2664
+ * @type {string}
2665
+ * @memberof VideoICEServer
2666
+ */
2667
+ username: string;
2668
+ }
2669
+ /**
2670
+ *
2671
+ * @export
2672
+ * @interface VideoJoinCallRequest
2673
+ */
2674
+ export interface VideoJoinCallRequest {
2675
+ /**
2676
+ * if true the call will be created if it doesn't exist
2677
+ * @type {boolean}
2678
+ * @memberof VideoJoinCallRequest
2679
+ */
2680
+ create?: boolean;
2681
+ /**
2682
+ *
2683
+ * @type {VideoCallRequest}
2684
+ * @memberof VideoJoinCallRequest
2685
+ */
2686
+ data?: VideoCallRequest;
2687
+ /**
2688
+ *
2689
+ * @type {string}
2690
+ * @memberof VideoJoinCallRequest
2691
+ */
2692
+ location: string;
2693
+ /**
2694
+ *
2695
+ * @type {number}
2696
+ * @memberof VideoJoinCallRequest
2697
+ */
2698
+ members_limit?: number;
2699
+ /**
2700
+ * If the participant is migrating from another SFU, then this is the ID of the previous SFU
2701
+ * @type {string}
2702
+ * @memberof VideoJoinCallRequest
2703
+ */
2704
+ migrating_from?: string;
2705
+ /**
2706
+ *
2707
+ * @type {boolean}
2708
+ * @memberof VideoJoinCallRequest
2709
+ */
2710
+ notify?: boolean;
2711
+ /**
2712
+ * if true and the call is created, the notification will include ring=true
2713
+ * @type {boolean}
2714
+ * @memberof VideoJoinCallRequest
2715
+ */
2716
+ ring?: boolean;
2717
+ }
2718
+ /**
2719
+ *
2720
+ * @export
2721
+ * @interface VideoJoinCallResponse
2722
+ */
2723
+ export interface VideoJoinCallResponse {
2724
+ /**
2725
+ *
2726
+ * @type {VideoCallResponse}
2727
+ * @memberof VideoJoinCallResponse
2728
+ */
2729
+ call: VideoCallResponse;
2730
+ /**
2731
+ *
2732
+ * @type {boolean}
2733
+ * @memberof VideoJoinCallResponse
2734
+ */
2735
+ created: boolean;
2736
+ /**
2737
+ *
2738
+ * @type {VideoCredentials}
2739
+ * @memberof VideoJoinCallResponse
2740
+ */
2741
+ credentials: VideoCredentials;
2742
+ /**
2743
+ *
2744
+ * @type {string}
2745
+ * @memberof VideoJoinCallResponse
2746
+ */
2747
+ duration: string;
2748
+ /**
2749
+ *
2750
+ * @type {Array<VideoMemberResponse>}
2751
+ * @memberof VideoJoinCallResponse
2752
+ */
2753
+ members: Array<VideoMemberResponse>;
2754
+ /**
2755
+ *
2756
+ * @type {VideoMemberResponse}
2757
+ * @memberof VideoJoinCallResponse
2758
+ */
2759
+ membership?: VideoMemberResponse;
2760
+ /**
2761
+ *
2762
+ * @type {Array<VideoOwnCapability>}
2763
+ * @memberof VideoJoinCallResponse
2764
+ */
2765
+ own_capabilities: Array<VideoOwnCapability>;
2766
+ }
2767
+ /**
2768
+ *
2769
+ * @export
2770
+ * @interface VideoLayoutSettings
2771
+ */
2772
+ export interface VideoLayoutSettings {
2773
+ /**
2774
+ *
2775
+ * @type {string}
2776
+ * @memberof VideoLayoutSettings
2777
+ */
2778
+ external_app_url: string;
2779
+ /**
2780
+ *
2781
+ * @type {string}
2782
+ * @memberof VideoLayoutSettings
2783
+ */
2784
+ external_css_url: string;
2785
+ /**
2786
+ *
2787
+ * @type {string}
2788
+ * @memberof VideoLayoutSettings
2789
+ */
2790
+ name: VideoLayoutSettingsNameEnum;
2791
+ /**
2792
+ *
2793
+ * @type {{ [key: string]: any; }}
2794
+ * @memberof VideoLayoutSettings
2795
+ */
2796
+ options?: {
2797
+ [key: string]: any;
2798
+ };
2799
+ }
2800
+ /**
2801
+ * @export
2802
+ */
2803
+ export declare const VideoLayoutSettingsNameEnum: {
2804
+ readonly SPOTLIGHT: "spotlight";
2805
+ readonly GRID: "grid";
2806
+ readonly SINGLE_PARTICIPANT: "single-participant";
2807
+ readonly MOBILE: "mobile";
2808
+ readonly CUSTOM: "custom";
2809
+ };
2810
+ export type VideoLayoutSettingsNameEnum = typeof VideoLayoutSettingsNameEnum[keyof typeof VideoLayoutSettingsNameEnum];
2811
+ /**
2812
+ *
2813
+ * @export
2814
+ * @interface VideoLayoutSettingsRequest
2815
+ */
2816
+ export interface VideoLayoutSettingsRequest {
2817
+ /**
2818
+ *
2819
+ * @type {string}
2820
+ * @memberof VideoLayoutSettingsRequest
2821
+ */
2822
+ external_app_url?: string;
2823
+ /**
2824
+ *
2825
+ * @type {string}
2826
+ * @memberof VideoLayoutSettingsRequest
2827
+ */
2828
+ external_css_url?: string;
2829
+ /**
2830
+ *
2831
+ * @type {string}
2832
+ * @memberof VideoLayoutSettingsRequest
2833
+ */
2834
+ name: VideoLayoutSettingsRequestNameEnum;
2835
+ /**
2836
+ *
2837
+ * @type {{ [key: string]: any; }}
2838
+ * @memberof VideoLayoutSettingsRequest
2839
+ */
2840
+ options?: {
2841
+ [key: string]: any;
2842
+ };
2843
+ }
2844
+ /**
2845
+ * @export
2846
+ */
2847
+ export declare const VideoLayoutSettingsRequestNameEnum: {
2848
+ readonly SPOTLIGHT: "spotlight";
2849
+ readonly GRID: "grid";
2850
+ readonly SINGLE_PARTICIPANT: "single-participant";
2851
+ readonly MOBILE: "mobile";
2852
+ readonly CUSTOM: "custom";
2853
+ };
2854
+ export type VideoLayoutSettingsRequestNameEnum = typeof VideoLayoutSettingsRequestNameEnum[keyof typeof VideoLayoutSettingsRequestNameEnum];
2855
+ /**
2856
+ *
2857
+ * @export
2858
+ * @interface VideoListCallTypeResponse
2859
+ */
2860
+ export interface VideoListCallTypeResponse {
2861
+ /**
2862
+ *
2863
+ * @type {{ [key: string]: VideoCallTypeResponse; }}
2864
+ * @memberof VideoListCallTypeResponse
2865
+ */
2866
+ call_types: {
2867
+ [key: string]: VideoCallTypeResponse;
2868
+ };
2869
+ /**
2870
+ *
2871
+ * @type {string}
2872
+ * @memberof VideoListCallTypeResponse
2873
+ */
2874
+ duration: string;
2875
+ }
2876
+ /**
2877
+ *
2878
+ * @export
2879
+ * @interface VideoListDevicesResponse
2880
+ */
2881
+ export interface VideoListDevicesResponse {
2882
+ /**
2883
+ * List of devices
2884
+ * @type {Array<VideoDevice>}
2885
+ * @memberof VideoListDevicesResponse
2886
+ */
2887
+ devices: Array<VideoDevice>;
2888
+ /**
2889
+ *
2890
+ * @type {string}
2891
+ * @memberof VideoListDevicesResponse
2892
+ */
2893
+ duration: string;
2894
+ }
2895
+ /**
2896
+ *
2897
+ * @export
2898
+ * @interface VideoListRecordingsResponse
2899
+ */
2900
+ export interface VideoListRecordingsResponse {
2901
+ /**
2902
+ *
2903
+ * @type {string}
2904
+ * @memberof VideoListRecordingsResponse
2905
+ */
2906
+ duration: string;
2907
+ /**
2908
+ *
2909
+ * @type {Array<VideoCallRecording>}
2910
+ * @memberof VideoListRecordingsResponse
2911
+ */
2912
+ recordings: Array<VideoCallRecording>;
2913
+ }
2914
+ /**
2915
+ *
2916
+ * @export
2917
+ * @interface VideoMemberRequest
2918
+ */
2919
+ export interface VideoMemberRequest {
2920
+ /**
2921
+ * Custom data for this object
2922
+ * @type {{ [key: string]: any; }}
2923
+ * @memberof VideoMemberRequest
2924
+ */
2925
+ custom?: {
2926
+ [key: string]: any;
2927
+ };
2928
+ /**
2929
+ *
2930
+ * @type {string}
2931
+ * @memberof VideoMemberRequest
2932
+ */
2933
+ role?: string;
2934
+ /**
2935
+ *
2936
+ * @type {string}
2937
+ * @memberof VideoMemberRequest
2938
+ */
2939
+ user_id: string;
2940
+ }
2941
+ /**
2942
+ *
2943
+ * @export
2944
+ * @interface VideoMemberResponse
2945
+ */
2946
+ export interface VideoMemberResponse {
2947
+ /**
2948
+ * Date/time of creation
2949
+ * @type {string}
2950
+ * @memberof VideoMemberResponse
2951
+ */
2952
+ created_at: string;
2953
+ /**
2954
+ * Custom member response data
2955
+ * @type {{ [key: string]: any; }}
2956
+ * @memberof VideoMemberResponse
2957
+ */
2958
+ custom: {
2959
+ [key: string]: any;
2960
+ };
2961
+ /**
2962
+ * Date/time of deletion
2963
+ * @type {string}
2964
+ * @memberof VideoMemberResponse
2965
+ */
2966
+ deleted_at?: string;
2967
+ /**
2968
+ *
2969
+ * @type {string}
2970
+ * @memberof VideoMemberResponse
2971
+ */
2972
+ role?: string;
2973
+ /**
2974
+ * Date/time of the last update
2975
+ * @type {string}
2976
+ * @memberof VideoMemberResponse
2977
+ */
2978
+ updated_at: string;
2979
+ /**
2980
+ *
2981
+ * @type {VideoUserResponse}
2982
+ * @memberof VideoMemberResponse
2983
+ */
2984
+ user: VideoUserResponse;
2985
+ /**
2986
+ *
2987
+ * @type {string}
2988
+ * @memberof VideoMemberResponse
2989
+ */
2990
+ user_id: string;
2991
+ }
2992
+ /**
2993
+ *
2994
+ * @export
2995
+ * @interface VideoMuteUsersRequest
2996
+ */
2997
+ export interface VideoMuteUsersRequest {
2998
+ /**
2999
+ *
3000
+ * @type {boolean}
3001
+ * @memberof VideoMuteUsersRequest
3002
+ */
3003
+ audio?: boolean;
3004
+ /**
3005
+ *
3006
+ * @type {boolean}
3007
+ * @memberof VideoMuteUsersRequest
3008
+ */
3009
+ mute_all_users?: boolean;
3010
+ /**
3011
+ *
3012
+ * @type {boolean}
3013
+ * @memberof VideoMuteUsersRequest
3014
+ */
3015
+ screenshare?: boolean;
3016
+ /**
3017
+ *
3018
+ * @type {boolean}
3019
+ * @memberof VideoMuteUsersRequest
3020
+ */
3021
+ screenshare_audio?: boolean;
3022
+ /**
3023
+ *
3024
+ * @type {Array<string>}
3025
+ * @memberof VideoMuteUsersRequest
3026
+ */
3027
+ user_ids?: Array<string>;
3028
+ /**
3029
+ *
3030
+ * @type {boolean}
3031
+ * @memberof VideoMuteUsersRequest
3032
+ */
3033
+ video?: boolean;
3034
+ }
3035
+ /**
3036
+ *
3037
+ * @export
3038
+ * @interface VideoMuteUsersResponse
3039
+ */
3040
+ export interface VideoMuteUsersResponse {
3041
+ /**
3042
+ * Duration of the request in human-readable format
3043
+ * @type {string}
3044
+ * @memberof VideoMuteUsersResponse
3045
+ */
3046
+ duration: string;
3047
+ }
3048
+ /**
3049
+ *
3050
+ * @export
3051
+ * @interface VideoNotificationSettings
3052
+ */
3053
+ export interface VideoNotificationSettings {
3054
+ /**
3055
+ *
3056
+ * @type {VideoEventNotificationSettings}
3057
+ * @memberof VideoNotificationSettings
3058
+ */
3059
+ call_live_started: VideoEventNotificationSettings;
3060
+ /**
3061
+ *
3062
+ * @type {VideoEventNotificationSettings}
3063
+ * @memberof VideoNotificationSettings
3064
+ */
3065
+ call_notification: VideoEventNotificationSettings;
3066
+ /**
3067
+ *
3068
+ * @type {VideoEventNotificationSettings}
3069
+ * @memberof VideoNotificationSettings
3070
+ */
3071
+ call_ring: VideoEventNotificationSettings;
3072
+ /**
3073
+ *
3074
+ * @type {boolean}
3075
+ * @memberof VideoNotificationSettings
3076
+ */
3077
+ enabled: boolean;
3078
+ /**
3079
+ *
3080
+ * @type {VideoEventNotificationSettings}
3081
+ * @memberof VideoNotificationSettings
3082
+ */
3083
+ session_started: VideoEventNotificationSettings;
3084
+ }
3085
+ /**
3086
+ *
3087
+ * @export
3088
+ * @interface VideoNotificationSettingsRequest
3089
+ */
3090
+ export interface VideoNotificationSettingsRequest {
3091
+ /**
3092
+ *
3093
+ * @type {VideoEventNotificationSettingsRequest}
3094
+ * @memberof VideoNotificationSettingsRequest
3095
+ */
3096
+ call_live_started?: VideoEventNotificationSettingsRequest;
3097
+ /**
3098
+ *
3099
+ * @type {VideoEventNotificationSettingsRequest}
3100
+ * @memberof VideoNotificationSettingsRequest
3101
+ */
3102
+ call_notification?: VideoEventNotificationSettingsRequest;
3103
+ /**
3104
+ *
3105
+ * @type {VideoEventNotificationSettingsRequest}
3106
+ * @memberof VideoNotificationSettingsRequest
3107
+ */
3108
+ call_ring?: VideoEventNotificationSettingsRequest;
3109
+ /**
3110
+ *
3111
+ * @type {boolean}
3112
+ * @memberof VideoNotificationSettingsRequest
3113
+ */
3114
+ enabled?: boolean;
3115
+ /**
3116
+ *
3117
+ * @type {VideoEventNotificationSettingsRequest}
3118
+ * @memberof VideoNotificationSettingsRequest
3119
+ */
3120
+ session_started?: VideoEventNotificationSettingsRequest;
3121
+ }
3122
+ /**
3123
+ * All possibility of string to use
3124
+ * @export
3125
+ */
3126
+ export declare const VideoOwnCapability: {
3127
+ readonly BLOCK_USERS: "block-users";
3128
+ readonly CREATE_CALL: "create-call";
3129
+ readonly CREATE_REACTION: "create-reaction";
3130
+ readonly END_CALL: "end-call";
3131
+ readonly JOIN_BACKSTAGE: "join-backstage";
3132
+ readonly JOIN_CALL: "join-call";
3133
+ readonly JOIN_ENDED_CALL: "join-ended-call";
3134
+ readonly MUTE_USERS: "mute-users";
3135
+ readonly PIN_FOR_EVERYONE: "pin-for-everyone";
3136
+ readonly READ_CALL: "read-call";
3137
+ readonly REMOVE_CALL_MEMBER: "remove-call-member";
3138
+ readonly SCREENSHARE: "screenshare";
3139
+ readonly SEND_AUDIO: "send-audio";
3140
+ readonly SEND_VIDEO: "send-video";
3141
+ readonly START_BROADCAST_CALL: "start-broadcast-call";
3142
+ readonly START_RECORD_CALL: "start-record-call";
3143
+ readonly START_TRANSCRIPTION_CALL: "start-transcription-call";
3144
+ readonly STOP_BROADCAST_CALL: "stop-broadcast-call";
3145
+ readonly STOP_RECORD_CALL: "stop-record-call";
3146
+ readonly STOP_TRANSCRIPTION_CALL: "stop-transcription-call";
3147
+ readonly UPDATE_CALL: "update-call";
3148
+ readonly UPDATE_CALL_MEMBER: "update-call-member";
3149
+ readonly UPDATE_CALL_PERMISSIONS: "update-call-permissions";
3150
+ readonly UPDATE_CALL_SETTINGS: "update-call-settings";
3151
+ };
3152
+ export type VideoOwnCapability = typeof VideoOwnCapability[keyof typeof VideoOwnCapability];
3153
+ /**
3154
+ *
3155
+ * @export
3156
+ * @interface VideoOwnUserResponse
3157
+ */
3158
+ export interface VideoOwnUserResponse {
3159
+ /**
3160
+ *
3161
+ * @type {string}
3162
+ * @memberof VideoOwnUserResponse
3163
+ */
3164
+ created_at: string;
3165
+ /**
3166
+ *
3167
+ * @type {{ [key: string]: any; }}
3168
+ * @memberof VideoOwnUserResponse
3169
+ */
3170
+ custom: {
3171
+ [key: string]: any;
3172
+ };
3173
+ /**
3174
+ *
3175
+ * @type {string}
3176
+ * @memberof VideoOwnUserResponse
3177
+ */
3178
+ deleted_at?: string;
3179
+ /**
3180
+ *
3181
+ * @type {Array<VideoDevice>}
3182
+ * @memberof VideoOwnUserResponse
3183
+ */
3184
+ devices: Array<VideoDevice>;
3185
+ /**
3186
+ *
3187
+ * @type {string}
3188
+ * @memberof VideoOwnUserResponse
3189
+ */
3190
+ id: string;
3191
+ /**
3192
+ *
3193
+ * @type {string}
3194
+ * @memberof VideoOwnUserResponse
3195
+ */
3196
+ image?: string;
3197
+ /**
3198
+ *
3199
+ * @type {string}
3200
+ * @memberof VideoOwnUserResponse
3201
+ */
3202
+ name?: string;
3203
+ /**
3204
+ *
3205
+ * @type {string}
3206
+ * @memberof VideoOwnUserResponse
3207
+ */
3208
+ role: string;
3209
+ /**
3210
+ *
3211
+ * @type {Array<string>}
3212
+ * @memberof VideoOwnUserResponse
3213
+ */
3214
+ teams: Array<string>;
3215
+ /**
3216
+ *
3217
+ * @type {string}
3218
+ * @memberof VideoOwnUserResponse
3219
+ */
3220
+ updated_at: string;
3221
+ }
3222
+ /**
3223
+ * This event is sent when a user requests access to a feature on a call,
3224
+ * clients receiving this event should display a permission request to the user
3225
+ * @export
3226
+ * @interface VideoPermissionRequestEvent
3227
+ */
3228
+ export interface VideoPermissionRequestEvent {
3229
+ /**
3230
+ *
3231
+ * @type {string}
3232
+ * @memberof VideoPermissionRequestEvent
3233
+ */
3234
+ call_cid: string;
3235
+ /**
3236
+ *
3237
+ * @type {string}
3238
+ * @memberof VideoPermissionRequestEvent
3239
+ */
3240
+ created_at: string;
3241
+ /**
3242
+ * The list of permissions requested by the user
3243
+ * @type {Array<string>}
3244
+ * @memberof VideoPermissionRequestEvent
3245
+ */
3246
+ permissions: Array<string>;
3247
+ /**
3248
+ * The type of event: "call.permission_request" in this case
3249
+ * @type {string}
3250
+ * @memberof VideoPermissionRequestEvent
3251
+ */
3252
+ type: string;
3253
+ /**
3254
+ *
3255
+ * @type {VideoUserResponse}
3256
+ * @memberof VideoPermissionRequestEvent
3257
+ */
3258
+ user: VideoUserResponse;
3259
+ }
3260
+ /**
3261
+ *
3262
+ * @export
3263
+ * @interface VideoPinRequest
3264
+ */
3265
+ export interface VideoPinRequest {
3266
+ /**
3267
+ *
3268
+ * @type {string}
3269
+ * @memberof VideoPinRequest
3270
+ */
3271
+ session_id: string;
3272
+ /**
3273
+ *
3274
+ * @type {string}
3275
+ * @memberof VideoPinRequest
3276
+ */
3277
+ user_id: string;
3278
+ }
3279
+ /**
3280
+ *
3281
+ * @export
3282
+ * @interface VideoPinResponse
3283
+ */
3284
+ export interface VideoPinResponse {
3285
+ /**
3286
+ * Duration of the request in human-readable format
3287
+ * @type {string}
3288
+ * @memberof VideoPinResponse
3289
+ */
3290
+ duration: string;
3291
+ }
3292
+ /**
3293
+ *
3294
+ * @export
3295
+ * @interface VideoQueryCallsRequest
3296
+ */
3297
+ export interface VideoQueryCallsRequest {
3298
+ /**
3299
+ *
3300
+ * @type {{ [key: string]: any; }}
3301
+ * @memberof VideoQueryCallsRequest
3302
+ */
3303
+ filter_conditions?: {
3304
+ [key: string]: any;
3305
+ };
3306
+ /**
3307
+ *
3308
+ * @type {number}
3309
+ * @memberof VideoQueryCallsRequest
3310
+ */
3311
+ limit?: number;
3312
+ /**
3313
+ *
3314
+ * @type {string}
3315
+ * @memberof VideoQueryCallsRequest
3316
+ */
3317
+ next?: string;
3318
+ /**
3319
+ *
3320
+ * @type {string}
3321
+ * @memberof VideoQueryCallsRequest
3322
+ */
3323
+ prev?: string;
3324
+ /**
3325
+ *
3326
+ * @type {Array<VideoSortParamRequest>}
3327
+ * @memberof VideoQueryCallsRequest
3328
+ */
3329
+ sort?: Array<VideoSortParamRequest>;
3330
+ /**
3331
+ *
3332
+ * @type {boolean}
3333
+ * @memberof VideoQueryCallsRequest
3334
+ */
3335
+ watch?: boolean;
3336
+ }
3337
+ /**
3338
+ *
3339
+ * @export
3340
+ * @interface VideoQueryCallsResponse
3341
+ */
3342
+ export interface VideoQueryCallsResponse {
3343
+ /**
3344
+ *
3345
+ * @type {Array<VideoCallStateResponseFields>}
3346
+ * @memberof VideoQueryCallsResponse
3347
+ */
3348
+ calls: Array<VideoCallStateResponseFields>;
3349
+ /**
3350
+ *
3351
+ * @type {string}
3352
+ * @memberof VideoQueryCallsResponse
3353
+ */
3354
+ duration: string;
3355
+ /**
3356
+ *
3357
+ * @type {string}
3358
+ * @memberof VideoQueryCallsResponse
3359
+ */
3360
+ next?: string;
3361
+ /**
3362
+ *
3363
+ * @type {string}
3364
+ * @memberof VideoQueryCallsResponse
3365
+ */
3366
+ prev?: string;
3367
+ }
3368
+ /**
3369
+ *
3370
+ * @export
3371
+ * @interface VideoQueryMembersRequest
3372
+ */
3373
+ export interface VideoQueryMembersRequest {
3374
+ /**
3375
+ *
3376
+ * @type {{ [key: string]: any; }}
3377
+ * @memberof VideoQueryMembersRequest
3378
+ */
3379
+ filter_conditions?: {
3380
+ [key: string]: any;
3381
+ };
3382
+ /**
3383
+ *
3384
+ * @type {string}
3385
+ * @memberof VideoQueryMembersRequest
3386
+ */
3387
+ id: string;
3388
+ /**
3389
+ *
3390
+ * @type {number}
3391
+ * @memberof VideoQueryMembersRequest
3392
+ */
3393
+ limit?: number;
3394
+ /**
3395
+ *
3396
+ * @type {string}
3397
+ * @memberof VideoQueryMembersRequest
3398
+ */
3399
+ next?: string;
3400
+ /**
3401
+ *
3402
+ * @type {string}
3403
+ * @memberof VideoQueryMembersRequest
3404
+ */
3405
+ prev?: string;
3406
+ /**
3407
+ *
3408
+ * @type {Array<VideoSortParamRequest>}
3409
+ * @memberof VideoQueryMembersRequest
3410
+ */
3411
+ sort?: Array<VideoSortParamRequest>;
3412
+ /**
3413
+ *
3414
+ * @type {string}
3415
+ * @memberof VideoQueryMembersRequest
3416
+ */
3417
+ type: string;
3418
+ }
3419
+ /**
3420
+ *
3421
+ * @export
3422
+ * @interface VideoQueryMembersResponse
3423
+ */
3424
+ export interface VideoQueryMembersResponse {
3425
+ /**
3426
+ * Duration of the request in human-readable format
3427
+ * @type {string}
3428
+ * @memberof VideoQueryMembersResponse
3429
+ */
3430
+ duration: string;
3431
+ /**
3432
+ *
3433
+ * @type {Array<VideoMemberResponse>}
3434
+ * @memberof VideoQueryMembersResponse
3435
+ */
3436
+ members: Array<VideoMemberResponse>;
3437
+ /**
3438
+ *
3439
+ * @type {string}
3440
+ * @memberof VideoQueryMembersResponse
3441
+ */
3442
+ next?: string;
3443
+ /**
3444
+ *
3445
+ * @type {string}
3446
+ * @memberof VideoQueryMembersResponse
3447
+ */
3448
+ prev?: string;
3449
+ }
3450
+ /**
3451
+ * RTMP input settings
3452
+ * @export
3453
+ * @interface VideoRTMPIngress
3454
+ */
3455
+ export interface VideoRTMPIngress {
3456
+ /**
3457
+ *
3458
+ * @type {string}
3459
+ * @memberof VideoRTMPIngress
3460
+ */
3461
+ address: string;
3462
+ }
3463
+ /**
3464
+ *
3465
+ * @export
3466
+ * @interface VideoReactionResponse
3467
+ */
3468
+ export interface VideoReactionResponse {
3469
+ /**
3470
+ *
3471
+ * @type {{ [key: string]: any; }}
3472
+ * @memberof VideoReactionResponse
3473
+ */
3474
+ custom?: {
3475
+ [key: string]: any;
3476
+ };
3477
+ /**
3478
+ *
3479
+ * @type {string}
3480
+ * @memberof VideoReactionResponse
3481
+ */
3482
+ emoji_code?: string;
3483
+ /**
3484
+ *
3485
+ * @type {string}
3486
+ * @memberof VideoReactionResponse
3487
+ */
3488
+ type: string;
3489
+ /**
3490
+ *
3491
+ * @type {VideoUserResponse}
3492
+ * @memberof VideoReactionResponse
3493
+ */
3494
+ user: VideoUserResponse;
3495
+ }
3496
+ /**
3497
+ *
3498
+ * @export
3499
+ * @interface VideoRecordSettingsRequest
3500
+ */
3501
+ export interface VideoRecordSettingsRequest {
3502
+ /**
3503
+ *
3504
+ * @type {boolean}
3505
+ * @memberof VideoRecordSettingsRequest
3506
+ */
3507
+ audio_only?: boolean;
3508
+ /**
3509
+ *
3510
+ * @type {VideoLayoutSettingsRequest}
3511
+ * @memberof VideoRecordSettingsRequest
3512
+ */
3513
+ layout?: VideoLayoutSettingsRequest;
3514
+ /**
3515
+ *
3516
+ * @type {string}
3517
+ * @memberof VideoRecordSettingsRequest
3518
+ */
3519
+ mode: VideoRecordSettingsRequestModeEnum;
3520
+ /**
3521
+ *
3522
+ * @type {string}
3523
+ * @memberof VideoRecordSettingsRequest
3524
+ */
3525
+ quality?: VideoRecordSettingsRequestQualityEnum;
3526
+ }
3527
+ /**
3528
+ * @export
3529
+ */
3530
+ export declare const VideoRecordSettingsRequestModeEnum: {
3531
+ readonly AVAILABLE: "available";
3532
+ readonly DISABLED: "disabled";
3533
+ readonly AUTO_ON: "auto-on";
3534
+ };
3535
+ export type VideoRecordSettingsRequestModeEnum = typeof VideoRecordSettingsRequestModeEnum[keyof typeof VideoRecordSettingsRequestModeEnum];
3536
+ /**
3537
+ * @export
3538
+ */
3539
+ export declare const VideoRecordSettingsRequestQualityEnum: {
3540
+ readonly _360P: "360p";
3541
+ readonly _480P: "480p";
3542
+ readonly _720P: "720p";
3543
+ readonly _1080P: "1080p";
3544
+ readonly _1440P: "1440p";
3545
+ };
3546
+ export type VideoRecordSettingsRequestQualityEnum = typeof VideoRecordSettingsRequestQualityEnum[keyof typeof VideoRecordSettingsRequestQualityEnum];
3547
+ /**
3548
+ *
3549
+ * @export
3550
+ * @interface VideoRecordSettingsResponse
3551
+ */
3552
+ export interface VideoRecordSettingsResponse {
3553
+ /**
3554
+ *
3555
+ * @type {boolean}
3556
+ * @memberof VideoRecordSettingsResponse
3557
+ */
3558
+ audio_only: boolean;
3559
+ /**
3560
+ *
3561
+ * @type {VideoLayoutSettings}
3562
+ * @memberof VideoRecordSettingsResponse
3563
+ */
3564
+ layout: VideoLayoutSettings;
3565
+ /**
3566
+ *
3567
+ * @type {string}
3568
+ * @memberof VideoRecordSettingsResponse
3569
+ */
3570
+ mode: string;
3571
+ /**
3572
+ *
3573
+ * @type {string}
3574
+ * @memberof VideoRecordSettingsResponse
3575
+ */
3576
+ quality: string;
3577
+ }
3578
+ /**
3579
+ *
3580
+ * @export
3581
+ * @interface VideoRejectCallResponse
3582
+ */
3583
+ export interface VideoRejectCallResponse {
3584
+ /**
3585
+ *
3586
+ * @type {string}
3587
+ * @memberof VideoRejectCallResponse
3588
+ */
3589
+ duration: string;
3590
+ }
3591
+ /**
3592
+ *
3593
+ * @export
3594
+ * @interface VideoRequestPermissionRequest
3595
+ */
3596
+ export interface VideoRequestPermissionRequest {
3597
+ /**
3598
+ *
3599
+ * @type {Array<string>}
3600
+ * @memberof VideoRequestPermissionRequest
3601
+ */
3602
+ permissions: Array<string>;
3603
+ }
3604
+ /**
3605
+ *
3606
+ * @export
3607
+ * @interface VideoRequestPermissionResponse
3608
+ */
3609
+ export interface VideoRequestPermissionResponse {
3610
+ /**
3611
+ *
3612
+ * @type {string}
3613
+ * @memberof VideoRequestPermissionResponse
3614
+ */
3615
+ duration: string;
3616
+ }
3617
+ /**
3618
+ *
3619
+ * @export
3620
+ * @interface VideoResponse
3621
+ */
3622
+ export interface VideoResponse {
3623
+ /**
3624
+ * Duration of the request in human-readable format
3625
+ * @type {string}
3626
+ * @memberof VideoResponse
3627
+ */
3628
+ duration: string;
3629
+ }
3630
+ /**
3631
+ *
3632
+ * @export
3633
+ * @interface VideoRingSettings
3634
+ */
3635
+ export interface VideoRingSettings {
3636
+ /**
3637
+ *
3638
+ * @type {number}
3639
+ * @memberof VideoRingSettings
3640
+ */
3641
+ auto_cancel_timeout_ms: number;
3642
+ /**
3643
+ *
3644
+ * @type {number}
3645
+ * @memberof VideoRingSettings
3646
+ */
3647
+ incoming_call_timeout_ms: number;
3648
+ }
3649
+ /**
3650
+ *
3651
+ * @export
3652
+ * @interface VideoRingSettingsRequest
3653
+ */
3654
+ export interface VideoRingSettingsRequest {
3655
+ /**
3656
+ *
3657
+ * @type {number}
3658
+ * @memberof VideoRingSettingsRequest
3659
+ */
3660
+ auto_cancel_timeout_ms?: number;
3661
+ /**
3662
+ *
3663
+ * @type {number}
3664
+ * @memberof VideoRingSettingsRequest
3665
+ */
3666
+ incoming_call_timeout_ms?: number;
3667
+ }
3668
+ /**
3669
+ *
3670
+ * @export
3671
+ * @interface VideoSFUResponse
3672
+ */
3673
+ export interface VideoSFUResponse {
3674
+ /**
3675
+ *
3676
+ * @type {string}
3677
+ * @memberof VideoSFUResponse
3678
+ */
3679
+ edge_name: string;
3680
+ /**
3681
+ *
3682
+ * @type {string}
3683
+ * @memberof VideoSFUResponse
3684
+ */
3685
+ url: string;
3686
+ /**
3687
+ *
3688
+ * @type {string}
3689
+ * @memberof VideoSFUResponse
3690
+ */
3691
+ ws_endpoint: string;
3692
+ }
3693
+ /**
3694
+ *
3695
+ * @export
3696
+ * @interface VideoScreensharingSettings
3697
+ */
3698
+ export interface VideoScreensharingSettings {
3699
+ /**
3700
+ *
3701
+ * @type {boolean}
3702
+ * @memberof VideoScreensharingSettings
3703
+ */
3704
+ access_request_enabled: boolean;
3705
+ /**
3706
+ *
3707
+ * @type {boolean}
3708
+ * @memberof VideoScreensharingSettings
3709
+ */
3710
+ enabled: boolean;
3711
+ }
3712
+ /**
3713
+ *
3714
+ * @export
3715
+ * @interface VideoScreensharingSettingsRequest
3716
+ */
3717
+ export interface VideoScreensharingSettingsRequest {
3718
+ /**
3719
+ *
3720
+ * @type {boolean}
3721
+ * @memberof VideoScreensharingSettingsRequest
3722
+ */
3723
+ access_request_enabled?: boolean;
3724
+ /**
3725
+ *
3726
+ * @type {boolean}
3727
+ * @memberof VideoScreensharingSettingsRequest
3728
+ */
3729
+ enabled?: boolean;
3730
+ }
3731
+ /**
3732
+ *
3733
+ * @export
3734
+ * @interface VideoSendEventRequest
3735
+ */
3736
+ export interface VideoSendEventRequest {
3737
+ /**
3738
+ *
3739
+ * @type {{ [key: string]: any; }}
3740
+ * @memberof VideoSendEventRequest
3741
+ */
3742
+ custom?: {
3743
+ [key: string]: any;
3744
+ };
3745
+ }
3746
+ /**
3747
+ *
3748
+ * @export
3749
+ * @interface VideoSendEventResponse
3750
+ */
3751
+ export interface VideoSendEventResponse {
3752
+ /**
3753
+ *
3754
+ * @type {string}
3755
+ * @memberof VideoSendEventResponse
3756
+ */
3757
+ duration: string;
3758
+ }
3759
+ /**
3760
+ *
3761
+ * @export
3762
+ * @interface VideoSendReactionRequest
3763
+ */
3764
+ export interface VideoSendReactionRequest {
3765
+ /**
3766
+ *
3767
+ * @type {{ [key: string]: any; }}
3768
+ * @memberof VideoSendReactionRequest
3769
+ */
3770
+ custom?: {
3771
+ [key: string]: any;
3772
+ };
3773
+ /**
3774
+ *
3775
+ * @type {string}
3776
+ * @memberof VideoSendReactionRequest
3777
+ */
3778
+ emoji_code?: string;
3779
+ /**
3780
+ *
3781
+ * @type {string}
3782
+ * @memberof VideoSendReactionRequest
3783
+ */
3784
+ type: string;
3785
+ }
3786
+ /**
3787
+ *
3788
+ * @export
3789
+ * @interface VideoSendReactionResponse
3790
+ */
3791
+ export interface VideoSendReactionResponse {
3792
+ /**
3793
+ * Duration of the request in human-readable format
3794
+ * @type {string}
3795
+ * @memberof VideoSendReactionResponse
3796
+ */
3797
+ duration: string;
3798
+ /**
3799
+ *
3800
+ * @type {VideoReactionResponse}
3801
+ * @memberof VideoSendReactionResponse
3802
+ */
3803
+ reaction: VideoReactionResponse;
3804
+ }
3805
+ /**
3806
+ *
3807
+ * @export
3808
+ * @interface VideoSortParamRequest
3809
+ */
3810
+ export interface VideoSortParamRequest {
3811
+ /**
3812
+ * Direction of sorting, -1 for descending, 1 for ascending
3813
+ * @type {number}
3814
+ * @memberof VideoSortParamRequest
3815
+ */
3816
+ direction?: number;
3817
+ /**
3818
+ * Name of field to sort by
3819
+ * @type {string}
3820
+ * @memberof VideoSortParamRequest
3821
+ */
3822
+ field?: string;
3823
+ }
3824
+ /**
3825
+ *
3826
+ * @export
3827
+ * @interface VideoStartHLSBroadcastingResponse
3828
+ */
3829
+ export interface VideoStartHLSBroadcastingResponse {
3830
+ /**
3831
+ * Duration of the request in human-readable format
3832
+ * @type {string}
3833
+ * @memberof VideoStartHLSBroadcastingResponse
3834
+ */
3835
+ duration: string;
3836
+ /**
3837
+ *
3838
+ * @type {string}
3839
+ * @memberof VideoStartHLSBroadcastingResponse
3840
+ */
3841
+ playlist_url: string;
3842
+ }
3843
+ /**
3844
+ *
3845
+ * @export
3846
+ * @interface VideoStartRecordingResponse
3847
+ */
3848
+ export interface VideoStartRecordingResponse {
3849
+ /**
3850
+ *
3851
+ * @type {string}
3852
+ * @memberof VideoStartRecordingResponse
3853
+ */
3854
+ duration: string;
3855
+ }
3856
+ /**
3857
+ *
3858
+ * @export
3859
+ * @interface VideoStartTranscriptionResponse
3860
+ */
3861
+ export interface VideoStartTranscriptionResponse {
3862
+ /**
3863
+ *
3864
+ * @type {string}
3865
+ * @memberof VideoStartTranscriptionResponse
3866
+ */
3867
+ duration: string;
3868
+ }
3869
+ /**
3870
+ *
3871
+ * @export
3872
+ * @interface VideoStopHLSBroadcastingResponse
3873
+ */
3874
+ export interface VideoStopHLSBroadcastingResponse {
3875
+ /**
3876
+ * Duration of the request in human-readable format
3877
+ * @type {string}
3878
+ * @memberof VideoStopHLSBroadcastingResponse
3879
+ */
3880
+ duration: string;
3881
+ }
3882
+ /**
3883
+ *
3884
+ * @export
3885
+ * @interface VideoStopLiveResponse
3886
+ */
3887
+ export interface VideoStopLiveResponse {
3888
+ /**
3889
+ *
3890
+ * @type {VideoCallResponse}
3891
+ * @memberof VideoStopLiveResponse
3892
+ */
3893
+ call: VideoCallResponse;
3894
+ /**
3895
+ * Duration of the request in human-readable format
3896
+ * @type {string}
3897
+ * @memberof VideoStopLiveResponse
3898
+ */
3899
+ duration: string;
3900
+ }
3901
+ /**
3902
+ *
3903
+ * @export
3904
+ * @interface VideoStopRecordingResponse
3905
+ */
3906
+ export interface VideoStopRecordingResponse {
3907
+ /**
3908
+ * Duration of the request in human-readable format
3909
+ * @type {string}
3910
+ * @memberof VideoStopRecordingResponse
3911
+ */
3912
+ duration: string;
3913
+ }
3914
+ /**
3915
+ *
3916
+ * @export
3917
+ * @interface VideoStopTranscriptionResponse
3918
+ */
3919
+ export interface VideoStopTranscriptionResponse {
3920
+ /**
3921
+ * Duration of the request in human-readable format
3922
+ * @type {string}
3923
+ * @memberof VideoStopTranscriptionResponse
3924
+ */
3925
+ duration: string;
3926
+ }
3927
+ /**
3928
+ *
3929
+ * @export
3930
+ * @interface VideoTargetResolution
3931
+ */
3932
+ export interface VideoTargetResolution {
3933
+ /**
3934
+ *
3935
+ * @type {number}
3936
+ * @memberof VideoTargetResolution
3937
+ */
3938
+ bitrate: number;
3939
+ /**
3940
+ *
3941
+ * @type {number}
3942
+ * @memberof VideoTargetResolution
3943
+ */
3944
+ height: number;
3945
+ /**
3946
+ *
3947
+ * @type {number}
3948
+ * @memberof VideoTargetResolution
3949
+ */
3950
+ width: number;
3951
+ }
3952
+ /**
3953
+ *
3954
+ * @export
3955
+ * @interface VideoTargetResolutionRequest
3956
+ */
3957
+ export interface VideoTargetResolutionRequest {
3958
+ /**
3959
+ *
3960
+ * @type {number}
3961
+ * @memberof VideoTargetResolutionRequest
3962
+ */
3963
+ bitrate?: number;
3964
+ /**
3965
+ *
3966
+ * @type {number}
3967
+ * @memberof VideoTargetResolutionRequest
3968
+ */
3969
+ height?: number;
3970
+ /**
3971
+ *
3972
+ * @type {number}
3973
+ * @memberof VideoTargetResolutionRequest
3974
+ */
3975
+ width?: number;
3976
+ }
3977
+ /**
3978
+ *
3979
+ * @export
3980
+ * @interface VideoThumbnailResponse
3981
+ */
3982
+ export interface VideoThumbnailResponse {
3983
+ /**
3984
+ *
3985
+ * @type {string}
3986
+ * @memberof VideoThumbnailResponse
3987
+ */
3988
+ image_url: string;
3989
+ }
3990
+ /**
3991
+ *
3992
+ * @export
3993
+ * @interface VideoThumbnailsSettings
3994
+ */
3995
+ export interface VideoThumbnailsSettings {
3996
+ /**
3997
+ *
3998
+ * @type {boolean}
3999
+ * @memberof VideoThumbnailsSettings
4000
+ */
4001
+ enabled: boolean;
4002
+ }
4003
+ /**
4004
+ *
4005
+ * @export
4006
+ * @interface VideoThumbnailsSettingsRequest
4007
+ */
4008
+ export interface VideoThumbnailsSettingsRequest {
4009
+ /**
4010
+ *
4011
+ * @type {boolean}
4012
+ * @memberof VideoThumbnailsSettingsRequest
4013
+ */
4014
+ enabled?: boolean;
4015
+ }
4016
+ /**
4017
+ *
4018
+ * @export
4019
+ * @interface VideoTranscriptionSettings
4020
+ */
4021
+ export interface VideoTranscriptionSettings {
4022
+ /**
4023
+ *
4024
+ * @type {string}
4025
+ * @memberof VideoTranscriptionSettings
4026
+ */
4027
+ closed_caption_mode: string;
4028
+ /**
4029
+ *
4030
+ * @type {string}
4031
+ * @memberof VideoTranscriptionSettings
4032
+ */
4033
+ mode: VideoTranscriptionSettingsModeEnum;
4034
+ }
4035
+ /**
4036
+ * @export
4037
+ */
4038
+ export declare const VideoTranscriptionSettingsModeEnum: {
4039
+ readonly AVAILABLE: "available";
4040
+ readonly DISABLED: "disabled";
4041
+ readonly AUTO_ON: "auto-on";
4042
+ };
4043
+ export type VideoTranscriptionSettingsModeEnum = typeof VideoTranscriptionSettingsModeEnum[keyof typeof VideoTranscriptionSettingsModeEnum];
4044
+ /**
4045
+ *
4046
+ * @export
4047
+ * @interface VideoTranscriptionSettingsRequest
4048
+ */
4049
+ export interface VideoTranscriptionSettingsRequest {
4050
+ /**
4051
+ *
4052
+ * @type {string}
4053
+ * @memberof VideoTranscriptionSettingsRequest
4054
+ */
4055
+ closed_caption_mode?: string;
4056
+ /**
4057
+ *
4058
+ * @type {string}
4059
+ * @memberof VideoTranscriptionSettingsRequest
4060
+ */
4061
+ mode?: VideoTranscriptionSettingsRequestModeEnum;
4062
+ }
4063
+ /**
4064
+ * @export
4065
+ */
4066
+ export declare const VideoTranscriptionSettingsRequestModeEnum: {
4067
+ readonly AVAILABLE: "available";
4068
+ readonly DISABLED: "disabled";
4069
+ readonly AUTO_ON: "auto-on";
4070
+ };
4071
+ export type VideoTranscriptionSettingsRequestModeEnum = typeof VideoTranscriptionSettingsRequestModeEnum[keyof typeof VideoTranscriptionSettingsRequestModeEnum];
4072
+ /**
4073
+ *
4074
+ * @export
4075
+ * @interface VideoUnblockUserRequest
4076
+ */
4077
+ export interface VideoUnblockUserRequest {
4078
+ /**
4079
+ * the user to unblock
4080
+ * @type {string}
4081
+ * @memberof VideoUnblockUserRequest
4082
+ */
4083
+ user_id: string;
4084
+ }
4085
+ /**
4086
+ *
4087
+ * @export
4088
+ * @interface VideoUnblockUserResponse
4089
+ */
4090
+ export interface VideoUnblockUserResponse {
4091
+ /**
4092
+ * Duration of the request in human-readable format
4093
+ * @type {string}
4094
+ * @memberof VideoUnblockUserResponse
4095
+ */
4096
+ duration: string;
4097
+ }
4098
+ /**
4099
+ * This event is sent when a user is unblocked on a call,
4100
+ * this can be useful to notify the user that they can now join the call again
4101
+ * @export
4102
+ * @interface VideoUnblockedUserEvent
4103
+ */
4104
+ export interface VideoUnblockedUserEvent {
4105
+ /**
4106
+ *
4107
+ * @type {string}
4108
+ * @memberof VideoUnblockedUserEvent
4109
+ */
4110
+ call_cid: string;
4111
+ /**
4112
+ *
4113
+ * @type {string}
4114
+ * @memberof VideoUnblockedUserEvent
4115
+ */
4116
+ created_at: string;
4117
+ /**
4118
+ * The type of event: "call.unblocked_user" in this case
4119
+ * @type {string}
4120
+ * @memberof VideoUnblockedUserEvent
4121
+ */
4122
+ type: string;
4123
+ /**
4124
+ *
4125
+ * @type {VideoUserResponse}
4126
+ * @memberof VideoUnblockedUserEvent
4127
+ */
4128
+ user: VideoUserResponse;
4129
+ }
4130
+ /**
4131
+ *
4132
+ * @export
4133
+ * @interface VideoUnpinRequest
4134
+ */
4135
+ export interface VideoUnpinRequest {
4136
+ /**
4137
+ *
4138
+ * @type {string}
4139
+ * @memberof VideoUnpinRequest
4140
+ */
4141
+ session_id: string;
4142
+ /**
4143
+ *
4144
+ * @type {string}
4145
+ * @memberof VideoUnpinRequest
4146
+ */
4147
+ user_id: string;
4148
+ }
4149
+ /**
4150
+ *
4151
+ * @export
4152
+ * @interface VideoUnpinResponse
4153
+ */
4154
+ export interface VideoUnpinResponse {
4155
+ /**
4156
+ * Duration of the request in human-readable format
4157
+ * @type {string}
4158
+ * @memberof VideoUnpinResponse
4159
+ */
4160
+ duration: string;
4161
+ }
4162
+ /**
4163
+ *
4164
+ * @export
4165
+ * @interface VideoUpdateCallMembersRequest
4166
+ */
4167
+ export interface VideoUpdateCallMembersRequest {
4168
+ /**
4169
+ * List of userID to remove
4170
+ * @type {Array<string>}
4171
+ * @memberof VideoUpdateCallMembersRequest
4172
+ */
4173
+ remove_members?: Array<string>;
4174
+ /**
4175
+ * List of members to update or insert
4176
+ * @type {Array<VideoMemberRequest>}
4177
+ * @memberof VideoUpdateCallMembersRequest
4178
+ */
4179
+ update_members?: Array<VideoMemberRequest>;
4180
+ }
4181
+ /**
4182
+ *
4183
+ * @export
4184
+ * @interface VideoUpdateCallMembersResponse
4185
+ */
4186
+ export interface VideoUpdateCallMembersResponse {
4187
+ /**
4188
+ * Duration of the request in human-readable format
4189
+ * @type {string}
4190
+ * @memberof VideoUpdateCallMembersResponse
4191
+ */
4192
+ duration: string;
4193
+ /**
4194
+ *
4195
+ * @type {Array<VideoMemberResponse>}
4196
+ * @memberof VideoUpdateCallMembersResponse
4197
+ */
4198
+ members: Array<VideoMemberResponse>;
4199
+ }
4200
+ /**
4201
+ *
4202
+ * @export
4203
+ * @interface VideoUpdateCallRequest
4204
+ */
4205
+ export interface VideoUpdateCallRequest {
4206
+ /**
4207
+ * Custom data for this object
4208
+ * @type {{ [key: string]: any; }}
4209
+ * @memberof VideoUpdateCallRequest
4210
+ */
4211
+ custom?: {
4212
+ [key: string]: any;
4213
+ };
4214
+ /**
4215
+ *
4216
+ * @type {VideoCallSettingsRequest}
4217
+ * @memberof VideoUpdateCallRequest
4218
+ */
4219
+ settings_override?: VideoCallSettingsRequest;
4220
+ /**
4221
+ * the time the call is scheduled to start
4222
+ * @type {string}
4223
+ * @memberof VideoUpdateCallRequest
4224
+ */
4225
+ starts_at?: string;
4226
+ }
4227
+ /**
4228
+ * Represents a call
4229
+ * @export
4230
+ * @interface VideoUpdateCallResponse
4231
+ */
4232
+ export interface VideoUpdateCallResponse {
4233
+ /**
4234
+ *
4235
+ * @type {VideoCallResponse}
4236
+ * @memberof VideoUpdateCallResponse
4237
+ */
4238
+ call: VideoCallResponse;
4239
+ /**
4240
+ *
4241
+ * @type {string}
4242
+ * @memberof VideoUpdateCallResponse
4243
+ */
4244
+ duration: string;
4245
+ /**
4246
+ *
4247
+ * @type {Array<VideoMemberResponse>}
4248
+ * @memberof VideoUpdateCallResponse
4249
+ */
4250
+ members: Array<VideoMemberResponse>;
4251
+ /**
4252
+ *
4253
+ * @type {VideoMemberResponse}
4254
+ * @memberof VideoUpdateCallResponse
4255
+ */
4256
+ membership?: VideoMemberResponse;
4257
+ /**
4258
+ *
4259
+ * @type {Array<VideoOwnCapability>}
4260
+ * @memberof VideoUpdateCallResponse
4261
+ */
4262
+ own_capabilities: Array<VideoOwnCapability>;
4263
+ }
4264
+ /**
4265
+ *
4266
+ * @export
4267
+ * @interface VideoUpdateCallTypeRequest
4268
+ */
4269
+ export interface VideoUpdateCallTypeRequest {
4270
+ /**
4271
+ *
4272
+ * @type {{ [key: string]: Array<string>; }}
4273
+ * @memberof VideoUpdateCallTypeRequest
4274
+ */
4275
+ grants?: {
4276
+ [key: string]: Array<string>;
4277
+ };
4278
+ /**
4279
+ *
4280
+ * @type {VideoNotificationSettingsRequest}
4281
+ * @memberof VideoUpdateCallTypeRequest
4282
+ */
4283
+ notification_settings?: VideoNotificationSettingsRequest;
4284
+ /**
4285
+ *
4286
+ * @type {VideoCallSettingsRequest}
4287
+ * @memberof VideoUpdateCallTypeRequest
4288
+ */
4289
+ settings?: VideoCallSettingsRequest;
4290
+ }
4291
+ /**
4292
+ *
4293
+ * @export
4294
+ * @interface VideoUpdateCallTypeResponse
4295
+ */
4296
+ export interface VideoUpdateCallTypeResponse {
4297
+ /**
4298
+ *
4299
+ * @type {string}
4300
+ * @memberof VideoUpdateCallTypeResponse
4301
+ */
4302
+ created_at: string;
4303
+ /**
4304
+ *
4305
+ * @type {string}
4306
+ * @memberof VideoUpdateCallTypeResponse
4307
+ */
4308
+ duration: string;
4309
+ /**
4310
+ *
4311
+ * @type {{ [key: string]: Array<string>; }}
4312
+ * @memberof VideoUpdateCallTypeResponse
4313
+ */
4314
+ grants: {
4315
+ [key: string]: Array<string>;
4316
+ };
4317
+ /**
4318
+ *
4319
+ * @type {string}
4320
+ * @memberof VideoUpdateCallTypeResponse
4321
+ */
4322
+ name: string;
4323
+ /**
4324
+ *
4325
+ * @type {VideoNotificationSettings}
4326
+ * @memberof VideoUpdateCallTypeResponse
4327
+ */
4328
+ notification_settings: VideoNotificationSettings;
4329
+ /**
4330
+ *
4331
+ * @type {VideoCallSettingsResponse}
4332
+ * @memberof VideoUpdateCallTypeResponse
4333
+ */
4334
+ settings: VideoCallSettingsResponse;
4335
+ /**
4336
+ *
4337
+ * @type {string}
4338
+ * @memberof VideoUpdateCallTypeResponse
4339
+ */
4340
+ updated_at: string;
4341
+ }
4342
+ /**
4343
+ *
4344
+ * @export
4345
+ * @interface VideoUpdateUserPermissionsRequest
4346
+ */
4347
+ export interface VideoUpdateUserPermissionsRequest {
4348
+ /**
4349
+ *
4350
+ * @type {Array<string>}
4351
+ * @memberof VideoUpdateUserPermissionsRequest
4352
+ */
4353
+ grant_permissions?: Array<string>;
4354
+ /**
4355
+ *
4356
+ * @type {Array<string>}
4357
+ * @memberof VideoUpdateUserPermissionsRequest
4358
+ */
4359
+ revoke_permissions?: Array<string>;
4360
+ /**
4361
+ *
4362
+ * @type {string}
4363
+ * @memberof VideoUpdateUserPermissionsRequest
4364
+ */
4365
+ user_id: string;
4366
+ }
4367
+ /**
4368
+ *
4369
+ * @export
4370
+ * @interface VideoUpdateUserPermissionsResponse
4371
+ */
4372
+ export interface VideoUpdateUserPermissionsResponse {
4373
+ /**
4374
+ * Duration of the request in human-readable format
4375
+ * @type {string}
4376
+ * @memberof VideoUpdateUserPermissionsResponse
4377
+ */
4378
+ duration: string;
4379
+ }
4380
+ /**
4381
+ * This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly
4382
+ * @export
4383
+ * @interface VideoUpdatedCallPermissionsEvent
4384
+ */
4385
+ export interface VideoUpdatedCallPermissionsEvent {
4386
+ /**
4387
+ *
4388
+ * @type {string}
4389
+ * @memberof VideoUpdatedCallPermissionsEvent
4390
+ */
4391
+ call_cid: string;
4392
+ /**
4393
+ *
4394
+ * @type {string}
4395
+ * @memberof VideoUpdatedCallPermissionsEvent
4396
+ */
4397
+ created_at: string;
4398
+ /**
4399
+ * The capabilities of the current user
4400
+ * @type {Array<VideoOwnCapability>}
4401
+ * @memberof VideoUpdatedCallPermissionsEvent
4402
+ */
4403
+ own_capabilities: Array<VideoOwnCapability>;
4404
+ /**
4405
+ * The type of event: "call.permissions_updated" in this case
4406
+ * @type {string}
4407
+ * @memberof VideoUpdatedCallPermissionsEvent
4408
+ */
4409
+ type: string;
4410
+ /**
4411
+ *
4412
+ * @type {VideoUserResponse}
4413
+ * @memberof VideoUpdatedCallPermissionsEvent
4414
+ */
4415
+ user: VideoUserResponse;
4416
+ }
4417
+ /**
4418
+ *
4419
+ * @export
4420
+ * @interface VideoUserRequest
4421
+ */
4422
+ export interface VideoUserRequest {
4423
+ /**
4424
+ *
4425
+ * @type {{ [key: string]: any; }}
4426
+ * @memberof VideoUserRequest
4427
+ */
4428
+ custom?: {
4429
+ [key: string]: any;
4430
+ };
4431
+ /**
4432
+ * User ID
4433
+ * @type {string}
4434
+ * @memberof VideoUserRequest
4435
+ */
4436
+ id: string;
4437
+ /**
4438
+ *
4439
+ * @type {string}
4440
+ * @memberof VideoUserRequest
4441
+ */
4442
+ image?: string;
4443
+ /**
4444
+ * Optional name of user
4445
+ * @type {string}
4446
+ * @memberof VideoUserRequest
4447
+ */
4448
+ name?: string;
4449
+ /**
4450
+ *
4451
+ * @type {string}
4452
+ * @memberof VideoUserRequest
4453
+ */
4454
+ role?: string;
4455
+ /**
4456
+ *
4457
+ * @type {Array<string>}
4458
+ * @memberof VideoUserRequest
4459
+ */
4460
+ teams?: Array<string>;
4461
+ }
4462
+ /**
4463
+ *
4464
+ * @export
4465
+ * @interface VideoUserResponse
4466
+ */
4467
+ export interface VideoUserResponse {
4468
+ /**
4469
+ * Date/time of creation
4470
+ * @type {string}
4471
+ * @memberof VideoUserResponse
4472
+ */
4473
+ created_at: string;
4474
+ /**
4475
+ *
4476
+ * @type {{ [key: string]: any; }}
4477
+ * @memberof VideoUserResponse
4478
+ */
4479
+ custom: {
4480
+ [key: string]: any;
4481
+ };
4482
+ /**
4483
+ * Date/time of deletion
4484
+ * @type {string}
4485
+ * @memberof VideoUserResponse
4486
+ */
4487
+ deleted_at?: string;
4488
+ /**
4489
+ *
4490
+ * @type {string}
4491
+ * @memberof VideoUserResponse
4492
+ */
4493
+ id: string;
4494
+ /**
4495
+ *
4496
+ * @type {string}
4497
+ * @memberof VideoUserResponse
4498
+ */
4499
+ image?: string;
4500
+ /**
4501
+ *
4502
+ * @type {string}
4503
+ * @memberof VideoUserResponse
4504
+ */
4505
+ name?: string;
4506
+ /**
4507
+ *
4508
+ * @type {string}
4509
+ * @memberof VideoUserResponse
4510
+ */
4511
+ role: string;
4512
+ /**
4513
+ *
4514
+ * @type {Array<string>}
4515
+ * @memberof VideoUserResponse
4516
+ */
4517
+ teams: Array<string>;
4518
+ /**
4519
+ * Date/time of the last update
4520
+ * @type {string}
4521
+ * @memberof VideoUserResponse
4522
+ */
4523
+ updated_at: string;
4524
+ }
4525
+ /**
4526
+ * @type VideoVideoEvent
4527
+ * The discriminator object for all websocket events, you should use this to map event payloads to their own type
4528
+ * @export
4529
+ */
4530
+ export type VideoVideoEvent = {
4531
+ type: 'call.accepted';
4532
+ } & VideoCallAcceptedEvent | {
4533
+ type: 'call.blocked_user';
4534
+ } & VideoBlockedUserEvent | {
4535
+ type: 'call.created';
4536
+ } & VideoCallCreatedEvent | {
4537
+ type: 'call.ended';
4538
+ } & VideoCallEndedEvent | {
4539
+ type: 'call.hls_broadcasting_failed';
4540
+ } & VideoCallHLSBroadcastingFailedEvent | {
4541
+ type: 'call.hls_broadcasting_started';
4542
+ } & VideoCallHLSBroadcastingStartedEvent | {
4543
+ type: 'call.hls_broadcasting_stopped';
4544
+ } & VideoCallHLSBroadcastingStoppedEvent | {
4545
+ type: 'call.live_started';
4546
+ } & VideoCallLiveStartedEvent | {
4547
+ type: 'call.member_added';
4548
+ } & VideoCallMemberAddedEvent | {
4549
+ type: 'call.member_removed';
4550
+ } & VideoCallMemberRemovedEvent | {
4551
+ type: 'call.member_updated';
4552
+ } & VideoCallMemberUpdatedEvent | {
4553
+ type: 'call.member_updated_permission';
4554
+ } & VideoCallMemberUpdatedPermissionEvent | {
4555
+ type: 'call.notification';
4556
+ } & VideoCallNotificationEvent | {
4557
+ type: 'call.permission_request';
4558
+ } & VideoPermissionRequestEvent | {
4559
+ type: 'call.permissions_updated';
4560
+ } & VideoUpdatedCallPermissionsEvent | {
4561
+ type: 'call.reaction_new';
4562
+ } & VideoCallReactionEvent | {
4563
+ type: 'call.recording_failed';
4564
+ } & VideoCallRecordingFailedEvent | {
4565
+ type: 'call.recording_ready';
4566
+ } & VideoCallRecordingReadyEvent | {
4567
+ type: 'call.recording_started';
4568
+ } & VideoCallRecordingStartedEvent | {
4569
+ type: 'call.recording_stopped';
4570
+ } & VideoCallRecordingStoppedEvent | {
4571
+ type: 'call.rejected';
4572
+ } & VideoCallRejectedEvent | {
4573
+ type: 'call.ring';
4574
+ } & VideoCallRingEvent | {
4575
+ type: 'call.session_ended';
4576
+ } & VideoCallSessionEndedEvent | {
4577
+ type: 'call.session_participant_joined';
4578
+ } & VideoCallSessionParticipantJoinedEvent | {
4579
+ type: 'call.session_participant_left';
4580
+ } & VideoCallSessionParticipantLeftEvent | {
4581
+ type: 'call.session_started';
4582
+ } & VideoCallSessionStartedEvent | {
4583
+ type: 'call.unblocked_user';
4584
+ } & VideoUnblockedUserEvent | {
4585
+ type: 'call.updated';
4586
+ } & VideoCallUpdatedEvent | {
4587
+ type: 'call.user_muted';
4588
+ } & VideoCallUserMuted | {
4589
+ type: 'connection.error';
4590
+ } & VideoConnectionErrorEvent | {
4591
+ type: 'connection.ok';
4592
+ } & VideoConnectedEvent | {
4593
+ type: 'custom';
4594
+ } & VideoCustomVideoEvent | {
4595
+ type: 'health.check';
4596
+ } & VideoHealthCheckEvent;
4597
+ /**
4598
+ *
4599
+ * @export
4600
+ * @interface VideoVideoSettings
4601
+ */
4602
+ export interface VideoVideoSettings {
4603
+ /**
4604
+ *
4605
+ * @type {boolean}
4606
+ * @memberof VideoVideoSettings
4607
+ */
4608
+ access_request_enabled: boolean;
4609
+ /**
4610
+ *
4611
+ * @type {boolean}
4612
+ * @memberof VideoVideoSettings
4613
+ */
4614
+ camera_default_on: boolean;
4615
+ /**
4616
+ *
4617
+ * @type {string}
4618
+ * @memberof VideoVideoSettings
4619
+ */
4620
+ camera_facing: VideoVideoSettingsCameraFacingEnum;
4621
+ /**
4622
+ *
4623
+ * @type {boolean}
4624
+ * @memberof VideoVideoSettings
4625
+ */
4626
+ enabled: boolean;
4627
+ /**
4628
+ *
4629
+ * @type {VideoTargetResolution}
4630
+ * @memberof VideoVideoSettings
4631
+ */
4632
+ target_resolution: VideoTargetResolution;
4633
+ }
4634
+ /**
4635
+ * @export
4636
+ */
4637
+ export declare const VideoVideoSettingsCameraFacingEnum: {
4638
+ readonly FRONT: "front";
4639
+ readonly BACK: "back";
4640
+ readonly EXTERNAL: "external";
4641
+ };
4642
+ export type VideoVideoSettingsCameraFacingEnum = typeof VideoVideoSettingsCameraFacingEnum[keyof typeof VideoVideoSettingsCameraFacingEnum];
4643
+ /**
4644
+ *
4645
+ * @export
4646
+ * @interface VideoVideoSettingsRequest
4647
+ */
4648
+ export interface VideoVideoSettingsRequest {
4649
+ /**
4650
+ *
4651
+ * @type {boolean}
4652
+ * @memberof VideoVideoSettingsRequest
4653
+ */
4654
+ access_request_enabled?: boolean;
4655
+ /**
4656
+ *
4657
+ * @type {boolean}
4658
+ * @memberof VideoVideoSettingsRequest
4659
+ */
4660
+ camera_default_on?: boolean;
4661
+ /**
4662
+ *
4663
+ * @type {string}
4664
+ * @memberof VideoVideoSettingsRequest
4665
+ */
4666
+ camera_facing?: VideoVideoSettingsRequestCameraFacingEnum;
4667
+ /**
4668
+ *
4669
+ * @type {boolean}
4670
+ * @memberof VideoVideoSettingsRequest
4671
+ */
4672
+ enabled?: boolean;
4673
+ /**
4674
+ *
4675
+ * @type {VideoTargetResolutionRequest}
4676
+ * @memberof VideoVideoSettingsRequest
4677
+ */
4678
+ target_resolution?: VideoTargetResolutionRequest;
4679
+ }
4680
+ /**
4681
+ * @export
4682
+ */
4683
+ export declare const VideoVideoSettingsRequestCameraFacingEnum: {
4684
+ readonly FRONT: "front";
4685
+ readonly BACK: "back";
4686
+ readonly EXTERNAL: "external";
4687
+ };
4688
+ export type VideoVideoSettingsRequestCameraFacingEnum = typeof VideoVideoSettingsRequestCameraFacingEnum[keyof typeof VideoVideoSettingsRequestCameraFacingEnum];
4689
+ /**
4690
+ *
4691
+ * @export
4692
+ * @interface VideoWSAuthMessageRequest
4693
+ */
4694
+ export interface VideoWSAuthMessageRequest {
4695
+ /**
4696
+ *
4697
+ * @type {string}
4698
+ * @memberof VideoWSAuthMessageRequest
4699
+ */
4700
+ token: string;
4701
+ /**
4702
+ *
4703
+ * @type {VideoConnectUserDetailsRequest}
4704
+ * @memberof VideoWSAuthMessageRequest
4705
+ */
4706
+ user_details: VideoConnectUserDetailsRequest;
4707
+ }
4708
+ /**
4709
+ * This is just a placeholder for all client events
4710
+ * @export
4711
+ * @interface VideoWSCallEvent
4712
+ */
4713
+ export interface VideoWSCallEvent {
4714
+ /**
4715
+ *
4716
+ * @type {string}
4717
+ * @memberof VideoWSCallEvent
4718
+ */
4719
+ call_cid?: string;
4720
+ }
4721
+ /**
4722
+ * This is just a placeholder for all client events
4723
+ * @export
4724
+ * @interface VideoWSClientEvent
4725
+ */
4726
+ export interface VideoWSClientEvent {
4727
+ /**
4728
+ *
4729
+ * @type {string}
4730
+ * @memberof VideoWSClientEvent
4731
+ */
4732
+ connection_id?: string;
4733
+ }