@fishjam-cloud/js-server-sdk 0.1.0 → 0.1.2

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.
@@ -1,1715 +0,0 @@
1
- /**
2
- * Fishjam Media Server
3
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
- *
5
- * The version of the OpenAPI document: 0.6.1
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from './configuration';
13
- import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- import globalAxios from 'axios';
15
- import type { RequestArgs } from './base';
16
- import { BaseAPI } from './base';
17
- /**
18
- *
19
- * @export
20
- * @interface AddComponentRequest
21
- */
22
- export interface AddComponentRequest {
23
- /**
24
- *
25
- * @type {ComponentOptions}
26
- * @memberof AddComponentRequest
27
- */
28
- 'options'?: ComponentOptions;
29
- /**
30
- * Component type
31
- * @type {string}
32
- * @memberof AddComponentRequest
33
- */
34
- 'type': string;
35
- }
36
- /**
37
- *
38
- * @export
39
- * @interface AddPeerRequest
40
- */
41
- export interface AddPeerRequest {
42
- /**
43
- *
44
- * @type {PeerOptions}
45
- * @memberof AddPeerRequest
46
- */
47
- 'options': PeerOptions;
48
- /**
49
- * Peer type
50
- * @type {string}
51
- * @memberof AddPeerRequest
52
- */
53
- 'type': string;
54
- }
55
- /**
56
- * @type Component
57
- * Describes component
58
- * @export
59
- */
60
- export type Component = {
61
- type: 'file';
62
- } & ComponentFile | {
63
- type: 'hls';
64
- } & ComponentHLS | {
65
- type: 'recording';
66
- } & ComponentRecording | {
67
- type: 'rtsp';
68
- } & ComponentRTSP | {
69
- type: 'sip';
70
- } & ComponentSIP;
71
- /**
72
- * Response containing component details
73
- * @export
74
- * @interface ComponentDetailsResponse
75
- */
76
- export interface ComponentDetailsResponse {
77
- /**
78
- *
79
- * @type {Component}
80
- * @memberof ComponentDetailsResponse
81
- */
82
- 'data': Component;
83
- }
84
- /**
85
- * Describes the File component
86
- * @export
87
- * @interface ComponentFile
88
- */
89
- export interface ComponentFile {
90
- /**
91
- * Assigned component ID
92
- * @type {string}
93
- * @memberof ComponentFile
94
- */
95
- 'id': string;
96
- /**
97
- *
98
- * @type {ComponentPropertiesFile}
99
- * @memberof ComponentFile
100
- */
101
- 'properties'?: ComponentPropertiesFile;
102
- /**
103
- * List of all component\'s tracks
104
- * @type {Array<Track>}
105
- * @memberof ComponentFile
106
- */
107
- 'tracks': Array<Track>;
108
- /**
109
- * Component type
110
- * @type {string}
111
- * @memberof ComponentFile
112
- */
113
- 'type': string;
114
- }
115
- /**
116
- * Describes the HLS component
117
- * @export
118
- * @interface ComponentHLS
119
- */
120
- export interface ComponentHLS {
121
- /**
122
- * Assigned component ID
123
- * @type {string}
124
- * @memberof ComponentHLS
125
- */
126
- 'id': string;
127
- /**
128
- *
129
- * @type {ComponentPropertiesHLS}
130
- * @memberof ComponentHLS
131
- */
132
- 'properties': ComponentPropertiesHLS;
133
- /**
134
- * List of all component\'s tracks
135
- * @type {Array<Track>}
136
- * @memberof ComponentHLS
137
- */
138
- 'tracks': Array<Track>;
139
- /**
140
- * Component type
141
- * @type {string}
142
- * @memberof ComponentHLS
143
- */
144
- 'type': string;
145
- }
146
- /**
147
- * @type ComponentOptions
148
- * Component-specific options
149
- * @export
150
- */
151
- export type ComponentOptions = ComponentOptionsFile | ComponentOptionsHLS | ComponentOptionsRTSP | ComponentOptionsRecording | ComponentOptionsSIP;
152
- /**
153
- * Options specific to the File component
154
- * @export
155
- * @interface ComponentOptionsFile
156
- */
157
- export interface ComponentOptionsFile {
158
- /**
159
- * Path to track file. Must be either OPUS encapsulated in Ogg or raw h264
160
- * @type {string}
161
- * @memberof ComponentOptionsFile
162
- */
163
- 'filePath': string;
164
- /**
165
- * Framerate of video in a file. It is only valid for video track
166
- * @type {number}
167
- * @memberof ComponentOptionsFile
168
- */
169
- 'framerate'?: number | null;
170
- }
171
- /**
172
- * Options specific to the HLS component
173
- * @export
174
- * @interface ComponentOptionsHLS
175
- */
176
- export interface ComponentOptionsHLS {
177
- /**
178
- * Whether the component should use LL-HLS
179
- * @type {boolean}
180
- * @memberof ComponentOptionsHLS
181
- */
182
- 'lowLatency'?: boolean;
183
- /**
184
- * Whether the video is stored after end of stream
185
- * @type {boolean}
186
- * @memberof ComponentOptionsHLS
187
- */
188
- 'persistent'?: boolean;
189
- /**
190
- *
191
- * @type {ComponentOptionsRecordingCredentials}
192
- * @memberof ComponentOptionsHLS
193
- */
194
- 's3'?: ComponentOptionsRecordingCredentials | null;
195
- /**
196
- * Whether the HLS component should subscribe to tracks automatically or manually.
197
- * @type {string}
198
- * @memberof ComponentOptionsHLS
199
- */
200
- 'subscribeMode'?: ComponentOptionsHLSSubscribeModeEnum;
201
- /**
202
- * Duration of stream available for viewer
203
- * @type {number}
204
- * @memberof ComponentOptionsHLS
205
- */
206
- 'targetWindowDuration'?: number | null;
207
- }
208
- export declare const ComponentOptionsHLSSubscribeModeEnum: {
209
- readonly Auto: "auto";
210
- readonly Manual: "manual";
211
- };
212
- export type ComponentOptionsHLSSubscribeModeEnum = typeof ComponentOptionsHLSSubscribeModeEnum[keyof typeof ComponentOptionsHLSSubscribeModeEnum];
213
- /**
214
- * Options specific to the RTSP component
215
- * @export
216
- * @interface ComponentOptionsRTSP
217
- */
218
- export interface ComponentOptionsRTSP {
219
- /**
220
- * Interval (in ms) in which keep-alive RTSP messages will be sent to the remote stream source
221
- * @type {number}
222
- * @memberof ComponentOptionsRTSP
223
- */
224
- 'keepAliveInterval'?: number;
225
- /**
226
- * Whether to attempt to create client-side NAT binding by sending an empty datagram from client to source, after the completion of RTSP setup
227
- * @type {boolean}
228
- * @memberof ComponentOptionsRTSP
229
- */
230
- 'pierceNat'?: boolean;
231
- /**
232
- * Delay (in ms) between successive reconnect attempts
233
- * @type {number}
234
- * @memberof ComponentOptionsRTSP
235
- */
236
- 'reconnectDelay'?: number;
237
- /**
238
- * Local port RTP stream will be received at
239
- * @type {number}
240
- * @memberof ComponentOptionsRTSP
241
- */
242
- 'rtpPort'?: number;
243
- /**
244
- * URI of RTSP source stream
245
- * @type {string}
246
- * @memberof ComponentOptionsRTSP
247
- */
248
- 'sourceUri': string;
249
- }
250
- /**
251
- * Options specific to the Recording component
252
- * @export
253
- * @interface ComponentOptionsRecording
254
- */
255
- export interface ComponentOptionsRecording {
256
- /**
257
- *
258
- * @type {ComponentOptionsRecordingCredentials}
259
- * @memberof ComponentOptionsRecording
260
- */
261
- 'credentials'?: ComponentOptionsRecordingCredentials | null;
262
- /**
263
- * Path prefix under which all recording are stored
264
- * @type {string}
265
- * @memberof ComponentOptionsRecording
266
- */
267
- 'pathPrefix'?: string | null;
268
- /**
269
- * Whether the Recording component should subscribe to tracks automatically or manually.
270
- * @type {string}
271
- * @memberof ComponentOptionsRecording
272
- */
273
- 'subscribeMode'?: ComponentOptionsRecordingSubscribeModeEnum;
274
- }
275
- export declare const ComponentOptionsRecordingSubscribeModeEnum: {
276
- readonly Auto: "auto";
277
- readonly Manual: "manual";
278
- };
279
- export type ComponentOptionsRecordingSubscribeModeEnum = typeof ComponentOptionsRecordingSubscribeModeEnum[keyof typeof ComponentOptionsRecordingSubscribeModeEnum];
280
- /**
281
- * @type ComponentOptionsRecordingCredentials
282
- * Credentials to AWS S3 bucket.
283
- * @export
284
- */
285
- export type ComponentOptionsRecordingCredentials = S3Credentials;
286
- /**
287
- * Options specific to the SIP component
288
- * @export
289
- * @interface ComponentOptionsSIP
290
- */
291
- export interface ComponentOptionsSIP {
292
- /**
293
- *
294
- * @type {SIPCredentials1}
295
- * @memberof ComponentOptionsSIP
296
- */
297
- 'registrarCredentials': SIPCredentials1;
298
- }
299
- /**
300
- * Properties specific to the File component
301
- * @export
302
- * @interface ComponentPropertiesFile
303
- */
304
- export interface ComponentPropertiesFile {
305
- /**
306
- * Relative path to track file. Must be either OPUS encapsulated in Ogg or raw h264
307
- * @type {string}
308
- * @memberof ComponentPropertiesFile
309
- */
310
- 'filePath': string;
311
- /**
312
- * Framerate of video in a file. It is only valid for video track
313
- * @type {number}
314
- * @memberof ComponentPropertiesFile
315
- */
316
- 'framerate': number | null;
317
- }
318
- /**
319
- * Properties specific to the HLS component
320
- * @export
321
- * @interface ComponentPropertiesHLS
322
- */
323
- export interface ComponentPropertiesHLS {
324
- /**
325
- * Whether the component uses LL-HLS
326
- * @type {boolean}
327
- * @memberof ComponentPropertiesHLS
328
- */
329
- 'lowLatency': boolean;
330
- /**
331
- * Whether the video is stored after end of stream
332
- * @type {boolean}
333
- * @memberof ComponentPropertiesHLS
334
- */
335
- 'persistent': boolean;
336
- /**
337
- * Whether the generated HLS playlist is playable
338
- * @type {boolean}
339
- * @memberof ComponentPropertiesHLS
340
- */
341
- 'playable': boolean;
342
- /**
343
- * Whether the HLS component should subscribe to tracks automatically or manually
344
- * @type {string}
345
- * @memberof ComponentPropertiesHLS
346
- */
347
- 'subscribeMode': ComponentPropertiesHLSSubscribeModeEnum;
348
- /**
349
- * Duration of stream available for viewer
350
- * @type {number}
351
- * @memberof ComponentPropertiesHLS
352
- */
353
- 'targetWindowDuration': number | null;
354
- }
355
- export declare const ComponentPropertiesHLSSubscribeModeEnum: {
356
- readonly Auto: "auto";
357
- readonly Manual: "manual";
358
- };
359
- export type ComponentPropertiesHLSSubscribeModeEnum = typeof ComponentPropertiesHLSSubscribeModeEnum[keyof typeof ComponentPropertiesHLSSubscribeModeEnum];
360
- /**
361
- * Properties specific to the RTSP component
362
- * @export
363
- * @interface ComponentPropertiesRTSP
364
- */
365
- export interface ComponentPropertiesRTSP {
366
- /**
367
- * Interval (in ms) in which keep-alive RTSP messages will be sent to the remote stream source
368
- * @type {number}
369
- * @memberof ComponentPropertiesRTSP
370
- */
371
- 'keepAliveInterval': number;
372
- /**
373
- * Whether to attempt to create client-side NAT binding by sending an empty datagram from client to source, after the completion of RTSP setup
374
- * @type {boolean}
375
- * @memberof ComponentPropertiesRTSP
376
- */
377
- 'pierceNat': boolean;
378
- /**
379
- * Delay (in ms) between successive reconnect attempts
380
- * @type {number}
381
- * @memberof ComponentPropertiesRTSP
382
- */
383
- 'reconnectDelay': number;
384
- /**
385
- * Local port RTP stream will be received at
386
- * @type {number}
387
- * @memberof ComponentPropertiesRTSP
388
- */
389
- 'rtpPort': number;
390
- /**
391
- * URI of RTSP source stream
392
- * @type {string}
393
- * @memberof ComponentPropertiesRTSP
394
- */
395
- 'sourceUri': string;
396
- }
397
- /**
398
- * Properties specific to the Recording component
399
- * @export
400
- * @interface ComponentPropertiesRecording
401
- */
402
- export interface ComponentPropertiesRecording {
403
- /**
404
- * Whether the Recording component should subscribe to tracks automatically or manually
405
- * @type {string}
406
- * @memberof ComponentPropertiesRecording
407
- */
408
- 'subscribeMode': ComponentPropertiesRecordingSubscribeModeEnum;
409
- }
410
- export declare const ComponentPropertiesRecordingSubscribeModeEnum: {
411
- readonly Auto: "auto";
412
- readonly Manual: "manual";
413
- };
414
- export type ComponentPropertiesRecordingSubscribeModeEnum = typeof ComponentPropertiesRecordingSubscribeModeEnum[keyof typeof ComponentPropertiesRecordingSubscribeModeEnum];
415
- /**
416
- * Properties specific to the SIP component
417
- * @export
418
- * @interface ComponentPropertiesSIP
419
- */
420
- export interface ComponentPropertiesSIP {
421
- /**
422
- *
423
- * @type {SIPCredentials1}
424
- * @memberof ComponentPropertiesSIP
425
- */
426
- 'registrarCredentials': SIPCredentials1;
427
- }
428
- /**
429
- * Describes the RTSP component
430
- * @export
431
- * @interface ComponentRTSP
432
- */
433
- export interface ComponentRTSP {
434
- /**
435
- * Assigned component ID
436
- * @type {string}
437
- * @memberof ComponentRTSP
438
- */
439
- 'id': string;
440
- /**
441
- *
442
- * @type {ComponentPropertiesRTSP}
443
- * @memberof ComponentRTSP
444
- */
445
- 'properties': ComponentPropertiesRTSP;
446
- /**
447
- * List of all component\'s tracks
448
- * @type {Array<Track>}
449
- * @memberof ComponentRTSP
450
- */
451
- 'tracks': Array<Track>;
452
- /**
453
- * Component type
454
- * @type {string}
455
- * @memberof ComponentRTSP
456
- */
457
- 'type': string;
458
- }
459
- /**
460
- * Describes the Recording component
461
- * @export
462
- * @interface ComponentRecording
463
- */
464
- export interface ComponentRecording {
465
- /**
466
- * Assigned component ID
467
- * @type {string}
468
- * @memberof ComponentRecording
469
- */
470
- 'id': string;
471
- /**
472
- *
473
- * @type {ComponentPropertiesRecording}
474
- * @memberof ComponentRecording
475
- */
476
- 'properties': ComponentPropertiesRecording;
477
- /**
478
- * List of all component\'s tracks
479
- * @type {Array<Track>}
480
- * @memberof ComponentRecording
481
- */
482
- 'tracks': Array<Track>;
483
- /**
484
- * Component type
485
- * @type {string}
486
- * @memberof ComponentRecording
487
- */
488
- 'type': string;
489
- }
490
- /**
491
- * Describes the SIP component
492
- * @export
493
- * @interface ComponentSIP
494
- */
495
- export interface ComponentSIP {
496
- /**
497
- * Assigned component ID
498
- * @type {string}
499
- * @memberof ComponentSIP
500
- */
501
- 'id': string;
502
- /**
503
- *
504
- * @type {ComponentPropertiesSIP}
505
- * @memberof ComponentSIP
506
- */
507
- 'properties': ComponentPropertiesSIP;
508
- /**
509
- * List of all component\'s tracks
510
- * @type {Array<Track>}
511
- * @memberof ComponentSIP
512
- */
513
- 'tracks': Array<Track>;
514
- /**
515
- * Component type
516
- * @type {string}
517
- * @memberof ComponentSIP
518
- */
519
- 'type': string;
520
- }
521
- /**
522
- * Dial config
523
- * @export
524
- * @interface DialConfig
525
- */
526
- export interface DialConfig {
527
- /**
528
- * Phone number on which SIP Component will call
529
- * @type {string}
530
- * @memberof DialConfig
531
- */
532
- 'phoneNumber'?: string;
533
- }
534
- /**
535
- * Describes overall Fishjam health
536
- * @export
537
- * @interface HealthReport
538
- */
539
- export interface HealthReport {
540
- /**
541
- *
542
- * @type {HealthReportDistribution}
543
- * @memberof HealthReport
544
- */
545
- 'distribution': HealthReportDistribution;
546
- /**
547
- * Commit hash of the build
548
- * @type {string}
549
- * @memberof HealthReport
550
- */
551
- 'gitCommit': string;
552
- /**
553
- *
554
- * @type {HealthReportStatus}
555
- * @memberof HealthReport
556
- */
557
- 'status': HealthReportStatus;
558
- /**
559
- * Uptime of Fishjam (in seconds)
560
- * @type {number}
561
- * @memberof HealthReport
562
- */
563
- 'uptime': number;
564
- /**
565
- * Version of Fishjam
566
- * @type {string}
567
- * @memberof HealthReport
568
- */
569
- 'version': string;
570
- }
571
- /**
572
- * Informs about the status of Fishjam distribution
573
- * @export
574
- * @interface HealthReportDistribution
575
- */
576
- export interface HealthReportDistribution {
577
- /**
578
- * Whether distribution is enabled on this Fishjam
579
- * @type {boolean}
580
- * @memberof HealthReportDistribution
581
- */
582
- 'enabled'?: boolean;
583
- /**
584
- *
585
- * @type {HealthReportStatus}
586
- * @memberof HealthReportDistribution
587
- */
588
- 'nodeStatus': HealthReportStatus;
589
- /**
590
- * Amount of nodes (including this Fishjam\'s node) in the distribution cluster
591
- * @type {number}
592
- * @memberof HealthReportDistribution
593
- */
594
- 'nodesInCluster': number;
595
- }
596
- /**
597
- * Informs about the status of Fishjam or a specific service
598
- * @export
599
- * @enum {string}
600
- */
601
- export declare const HealthReportStatus: {
602
- readonly Up: "UP";
603
- readonly Down: "DOWN";
604
- };
605
- export type HealthReportStatus = typeof HealthReportStatus[keyof typeof HealthReportStatus];
606
- /**
607
- * Response containing health report of Fishjam
608
- * @export
609
- * @interface HealthcheckResponse
610
- */
611
- export interface HealthcheckResponse {
612
- /**
613
- *
614
- * @type {HealthReport}
615
- * @memberof HealthcheckResponse
616
- */
617
- 'data': HealthReport;
618
- }
619
- /**
620
- * Error message
621
- * @export
622
- * @interface ModelError
623
- */
624
- export interface ModelError {
625
- /**
626
- * Error details
627
- * @type {string}
628
- * @memberof ModelError
629
- */
630
- 'errors': string;
631
- }
632
- /**
633
- * Describes peer status
634
- * @export
635
- * @interface Peer
636
- */
637
- export interface Peer {
638
- /**
639
- * Assigned peer id
640
- * @type {string}
641
- * @memberof Peer
642
- */
643
- 'id': string;
644
- /**
645
- * Custom metadata set by the peer
646
- * @type {any}
647
- * @memberof Peer
648
- */
649
- 'metadata': any | null;
650
- /**
651
- *
652
- * @type {PeerStatus}
653
- * @memberof Peer
654
- */
655
- 'status': PeerStatus;
656
- /**
657
- * List of all peer\'s tracks
658
- * @type {Array<Track>}
659
- * @memberof Peer
660
- */
661
- 'tracks': Array<Track>;
662
- /**
663
- * Peer type
664
- * @type {string}
665
- * @memberof Peer
666
- */
667
- 'type': string;
668
- }
669
- /**
670
- * Response containing peer details and their token
671
- * @export
672
- * @interface PeerDetailsResponse
673
- */
674
- export interface PeerDetailsResponse {
675
- /**
676
- *
677
- * @type {PeerDetailsResponseData}
678
- * @memberof PeerDetailsResponse
679
- */
680
- 'data': PeerDetailsResponseData;
681
- }
682
- /**
683
- *
684
- * @export
685
- * @interface PeerDetailsResponseData
686
- */
687
- export interface PeerDetailsResponseData {
688
- /**
689
- *
690
- * @type {Peer}
691
- * @memberof PeerDetailsResponseData
692
- */
693
- 'peer': Peer;
694
- /**
695
- * Websocket URL to which peer has to connect
696
- * @type {string}
697
- * @memberof PeerDetailsResponseData
698
- */
699
- 'peer_websocket_url'?: string;
700
- /**
701
- * Token for authorizing websocket connection
702
- * @type {string}
703
- * @memberof PeerDetailsResponseData
704
- */
705
- 'token': string;
706
- }
707
- /**
708
- * @type PeerOptions
709
- * Peer-specific options
710
- * @export
711
- */
712
- export type PeerOptions = PeerOptionsWebRTC;
713
- /**
714
- * Options specific to the WebRTC peer
715
- * @export
716
- * @interface PeerOptionsWebRTC
717
- */
718
- export interface PeerOptionsWebRTC {
719
- /**
720
- * Enables the peer to use simulcast
721
- * @type {boolean}
722
- * @memberof PeerOptionsWebRTC
723
- */
724
- 'enableSimulcast'?: boolean;
725
- }
726
- /**
727
- * Informs about the peer status
728
- * @export
729
- * @enum {string}
730
- */
731
- export declare const PeerStatus: {
732
- readonly Connected: "connected";
733
- readonly Disconnected: "disconnected";
734
- };
735
- export type PeerStatus = typeof PeerStatus[keyof typeof PeerStatus];
736
- /**
737
- * Response containing list of all recording
738
- * @export
739
- * @interface RecordingListResponse
740
- */
741
- export interface RecordingListResponse {
742
- /**
743
- *
744
- * @type {Array<string>}
745
- * @memberof RecordingListResponse
746
- */
747
- 'data': Array<string>;
748
- }
749
- /**
750
- * Description of the room state
751
- * @export
752
- * @interface Room
753
- */
754
- export interface Room {
755
- /**
756
- * List of all components
757
- * @type {Array<Component>}
758
- * @memberof Room
759
- */
760
- 'components': Array<Component>;
761
- /**
762
- *
763
- * @type {RoomConfig}
764
- * @memberof Room
765
- */
766
- 'config': RoomConfig;
767
- /**
768
- * Room ID
769
- * @type {string}
770
- * @memberof Room
771
- */
772
- 'id': string;
773
- /**
774
- * List of all peers
775
- * @type {Array<Peer>}
776
- * @memberof Room
777
- */
778
- 'peers': Array<Peer>;
779
- }
780
- /**
781
- * Room configuration
782
- * @export
783
- * @interface RoomConfig
784
- */
785
- export interface RoomConfig {
786
- /**
787
- * Maximum amount of peers allowed into the room
788
- * @type {number}
789
- * @memberof RoomConfig
790
- */
791
- 'maxPeers'?: number | null;
792
- /**
793
- * Duration (in seconds) after which the peer will be removed if it is disconnected. If not provided, this feature is disabled.
794
- * @type {number}
795
- * @memberof RoomConfig
796
- */
797
- 'peerDisconnectedTimeout'?: number | null;
798
- /**
799
- * Duration (in seconds) after which the room will be removed if no peers are connected. If not provided, this feature is disabled.
800
- * @type {number}
801
- * @memberof RoomConfig
802
- */
803
- 'peerlessPurgeTimeout'?: number | null;
804
- /**
805
- * Custom id used for identifying room within Fishjam. Must be unique across all rooms. If not provided, random UUID is generated.
806
- * @type {string}
807
- * @memberof RoomConfig
808
- */
809
- 'roomId'?: string | null;
810
- /**
811
- * Enforces video codec for each peer in the room
812
- * @type {string}
813
- * @memberof RoomConfig
814
- */
815
- 'videoCodec'?: RoomConfigVideoCodecEnum | null;
816
- /**
817
- * URL where Fishjam notifications will be sent
818
- * @type {string}
819
- * @memberof RoomConfig
820
- */
821
- 'webhookUrl'?: string | null;
822
- }
823
- export declare const RoomConfigVideoCodecEnum: {
824
- readonly H264: "h264";
825
- readonly Vp8: "vp8";
826
- };
827
- export type RoomConfigVideoCodecEnum = typeof RoomConfigVideoCodecEnum[keyof typeof RoomConfigVideoCodecEnum];
828
- /**
829
- * Response containing room details
830
- * @export
831
- * @interface RoomCreateDetailsResponse
832
- */
833
- export interface RoomCreateDetailsResponse {
834
- /**
835
- *
836
- * @type {RoomCreateDetailsResponseData}
837
- * @memberof RoomCreateDetailsResponse
838
- */
839
- 'data': RoomCreateDetailsResponseData;
840
- }
841
- /**
842
- *
843
- * @export
844
- * @interface RoomCreateDetailsResponseData
845
- */
846
- export interface RoomCreateDetailsResponseData {
847
- /**
848
- * Fishjam instance address where the room was created. This might be different than the address of Fishjam where the request was sent only when running a cluster of Fishjams.
849
- * @type {string}
850
- * @memberof RoomCreateDetailsResponseData
851
- */
852
- 'fishjam_address': string;
853
- /**
854
- *
855
- * @type {Room}
856
- * @memberof RoomCreateDetailsResponseData
857
- */
858
- 'room': Room;
859
- }
860
- /**
861
- * Response containing room details
862
- * @export
863
- * @interface RoomDetailsResponse
864
- */
865
- export interface RoomDetailsResponse {
866
- /**
867
- *
868
- * @type {Room}
869
- * @memberof RoomDetailsResponse
870
- */
871
- 'data': Room;
872
- }
873
- /**
874
- * Response containing list of all rooms
875
- * @export
876
- * @interface RoomsListingResponse
877
- */
878
- export interface RoomsListingResponse {
879
- /**
880
- *
881
- * @type {Array<Room>}
882
- * @memberof RoomsListingResponse
883
- */
884
- 'data': Array<Room>;
885
- }
886
- /**
887
- * An AWS S3 credential that will be used to send HLS stream. The stream will only be uploaded if credentials are provided
888
- * @export
889
- * @interface S3Credentials
890
- */
891
- export interface S3Credentials {
892
- /**
893
- * An AWS access key identifier, linked to your AWS account.
894
- * @type {string}
895
- * @memberof S3Credentials
896
- */
897
- 'accessKeyId': string;
898
- /**
899
- * The name of the S3 bucket where your data will be stored.
900
- * @type {string}
901
- * @memberof S3Credentials
902
- */
903
- 'bucket': string;
904
- /**
905
- * The AWS region where your bucket is located.
906
- * @type {string}
907
- * @memberof S3Credentials
908
- */
909
- 'region': string;
910
- /**
911
- * The secret key that is linked to the Access Key ID.
912
- * @type {string}
913
- * @memberof S3Credentials
914
- */
915
- 'secretAccessKey': string;
916
- }
917
- /**
918
- * Credentials used to authorize in SIP Provider service
919
- * @export
920
- * @interface SIPCredentials
921
- */
922
- export interface SIPCredentials {
923
- /**
924
- * SIP provider address. Can be in the form of FQDN (my-sip-registrar.net) or IPv4 (1.2.3.4). Port can be specified e.g: 5.6.7.8:9999. If not given, the default SIP port `5060` will be assumed
925
- * @type {string}
926
- * @memberof SIPCredentials
927
- */
928
- 'address': string;
929
- /**
930
- * Password in SIP service provider
931
- * @type {string}
932
- * @memberof SIPCredentials
933
- */
934
- 'password': string;
935
- /**
936
- * Username in SIP service provider
937
- * @type {string}
938
- * @memberof SIPCredentials
939
- */
940
- 'username': string;
941
- }
942
- /**
943
- * Credentials used to authorize in SIP Provider service
944
- * @export
945
- * @interface SIPCredentials1
946
- */
947
- export interface SIPCredentials1 {
948
- /**
949
- * SIP provider address. Can be in the form of FQDN (my-sip-registrar.net) or IPv4 (1.2.3.4). Port can be specified e.g: 5.6.7.8:9999. If not given, the default SIP port `5060` will be assumed
950
- * @type {string}
951
- * @memberof SIPCredentials1
952
- */
953
- 'address': string;
954
- /**
955
- * Password in SIP service provider
956
- * @type {string}
957
- * @memberof SIPCredentials1
958
- */
959
- 'password': string;
960
- /**
961
- * Username in SIP service provider
962
- * @type {string}
963
- * @memberof SIPCredentials1
964
- */
965
- 'username': string;
966
- }
967
- /**
968
- * Subscription config
969
- * @export
970
- * @interface SubscriptionConfig
971
- */
972
- export interface SubscriptionConfig {
973
- /**
974
- * List of peers and components ids whose tracks the HLS endpoint will subscribe to
975
- * @type {Array<string>}
976
- * @memberof SubscriptionConfig
977
- */
978
- 'origins'?: Array<string>;
979
- }
980
- /**
981
- * Describes media track of a Peer or Component
982
- * @export
983
- * @interface Track
984
- */
985
- export interface Track {
986
- /**
987
- *
988
- * @type {string}
989
- * @memberof Track
990
- */
991
- 'id'?: string;
992
- /**
993
- *
994
- * @type {any}
995
- * @memberof Track
996
- */
997
- 'metadata'?: any | null;
998
- /**
999
- *
1000
- * @type {string}
1001
- * @memberof Track
1002
- */
1003
- 'type'?: TrackTypeEnum;
1004
- }
1005
- export declare const TrackTypeEnum: {
1006
- readonly Audio: "audio";
1007
- readonly Video: "video";
1008
- };
1009
- export type TrackTypeEnum = typeof TrackTypeEnum[keyof typeof TrackTypeEnum];
1010
- /**
1011
- * HealthApi - axios parameter creator
1012
- * @export
1013
- */
1014
- export declare const HealthApiAxiosParamCreator: (configuration?: Configuration) => {
1015
- /**
1016
- *
1017
- * @summary Describes the health of Fishjam
1018
- * @param {*} [options] Override http request option.
1019
- * @throws {RequiredError}
1020
- */
1021
- healthcheck: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1022
- };
1023
- /**
1024
- * HealthApi - functional programming interface
1025
- * @export
1026
- */
1027
- export declare const HealthApiFp: (configuration?: Configuration) => {
1028
- /**
1029
- *
1030
- * @summary Describes the health of Fishjam
1031
- * @param {*} [options] Override http request option.
1032
- * @throws {RequiredError}
1033
- */
1034
- healthcheck(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HealthcheckResponse>>;
1035
- };
1036
- /**
1037
- * HealthApi - factory interface
1038
- * @export
1039
- */
1040
- export declare const HealthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1041
- /**
1042
- *
1043
- * @summary Describes the health of Fishjam
1044
- * @param {*} [options] Override http request option.
1045
- * @throws {RequiredError}
1046
- */
1047
- healthcheck(options?: any): AxiosPromise<HealthcheckResponse>;
1048
- };
1049
- /**
1050
- * HealthApi - object-oriented interface
1051
- * @export
1052
- * @class HealthApi
1053
- * @extends {BaseAPI}
1054
- */
1055
- export declare class HealthApi extends BaseAPI {
1056
- /**
1057
- *
1058
- * @summary Describes the health of Fishjam
1059
- * @param {*} [options] Override http request option.
1060
- * @throws {RequiredError}
1061
- * @memberof HealthApi
1062
- */
1063
- healthcheck(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<HealthcheckResponse, any>>;
1064
- }
1065
- /**
1066
- * HlsApi - axios parameter creator
1067
- * @export
1068
- */
1069
- export declare const HlsApiAxiosParamCreator: (configuration?: Configuration) => {
1070
- /**
1071
- *
1072
- * @summary Retrieve HLS Content
1073
- * @param {string} roomId Room id
1074
- * @param {string} filename Name of the file
1075
- * @param {string} [range] Byte range of partial segment
1076
- * @param {number | null} [hLSMsn] Segment sequence number
1077
- * @param {number | null} [hLSPart] Partial segment sequence number
1078
- * @param {string | null} [hLSSkip] Is delta manifest requested
1079
- * @param {*} [options] Override http request option.
1080
- * @throws {RequiredError}
1081
- */
1082
- getHlsContent: (roomId: string, filename: string, range?: string, hLSMsn?: number | null, hLSPart?: number | null, hLSSkip?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1083
- };
1084
- /**
1085
- * HlsApi - functional programming interface
1086
- * @export
1087
- */
1088
- export declare const HlsApiFp: (configuration?: Configuration) => {
1089
- /**
1090
- *
1091
- * @summary Retrieve HLS Content
1092
- * @param {string} roomId Room id
1093
- * @param {string} filename Name of the file
1094
- * @param {string} [range] Byte range of partial segment
1095
- * @param {number | null} [hLSMsn] Segment sequence number
1096
- * @param {number | null} [hLSPart] Partial segment sequence number
1097
- * @param {string | null} [hLSSkip] Is delta manifest requested
1098
- * @param {*} [options] Override http request option.
1099
- * @throws {RequiredError}
1100
- */
1101
- getHlsContent(roomId: string, filename: string, range?: string, hLSMsn?: number | null, hLSPart?: number | null, hLSSkip?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
1102
- };
1103
- /**
1104
- * HlsApi - factory interface
1105
- * @export
1106
- */
1107
- export declare const HlsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1108
- /**
1109
- *
1110
- * @summary Retrieve HLS Content
1111
- * @param {string} roomId Room id
1112
- * @param {string} filename Name of the file
1113
- * @param {string} [range] Byte range of partial segment
1114
- * @param {number | null} [hLSMsn] Segment sequence number
1115
- * @param {number | null} [hLSPart] Partial segment sequence number
1116
- * @param {string | null} [hLSSkip] Is delta manifest requested
1117
- * @param {*} [options] Override http request option.
1118
- * @throws {RequiredError}
1119
- */
1120
- getHlsContent(roomId: string, filename: string, range?: string, hLSMsn?: number | null, hLSPart?: number | null, hLSSkip?: string | null, options?: any): AxiosPromise<string>;
1121
- };
1122
- /**
1123
- * HlsApi - object-oriented interface
1124
- * @export
1125
- * @class HlsApi
1126
- * @extends {BaseAPI}
1127
- */
1128
- export declare class HlsApi extends BaseAPI {
1129
- /**
1130
- *
1131
- * @summary Retrieve HLS Content
1132
- * @param {string} roomId Room id
1133
- * @param {string} filename Name of the file
1134
- * @param {string} [range] Byte range of partial segment
1135
- * @param {number | null} [hLSMsn] Segment sequence number
1136
- * @param {number | null} [hLSPart] Partial segment sequence number
1137
- * @param {string | null} [hLSSkip] Is delta manifest requested
1138
- * @param {*} [options] Override http request option.
1139
- * @throws {RequiredError}
1140
- * @memberof HlsApi
1141
- */
1142
- getHlsContent(roomId: string, filename: string, range?: string, hLSMsn?: number | null, hLSPart?: number | null, hLSSkip?: string | null, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any>>;
1143
- }
1144
- /**
1145
- * RecordingApi - axios parameter creator
1146
- * @export
1147
- */
1148
- export declare const RecordingApiAxiosParamCreator: (configuration?: Configuration) => {
1149
- /**
1150
- *
1151
- * @summary Deletes the recording
1152
- * @param {string} recordingId Recording id
1153
- * @param {*} [options] Override http request option.
1154
- * @throws {RequiredError}
1155
- */
1156
- deleteRecording: (recordingId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1157
- /**
1158
- *
1159
- * @summary Retrieve Recording (HLS) Content
1160
- * @param {string} recordingId Recording id
1161
- * @param {string} filename Name of the file
1162
- * @param {*} [options] Override http request option.
1163
- * @throws {RequiredError}
1164
- */
1165
- getRecordingContent: (recordingId: string, filename: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1166
- /**
1167
- *
1168
- * @summary Lists all available recordings
1169
- * @param {*} [options] Override http request option.
1170
- * @throws {RequiredError}
1171
- */
1172
- getRecordings: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1173
- };
1174
- /**
1175
- * RecordingApi - functional programming interface
1176
- * @export
1177
- */
1178
- export declare const RecordingApiFp: (configuration?: Configuration) => {
1179
- /**
1180
- *
1181
- * @summary Deletes the recording
1182
- * @param {string} recordingId Recording id
1183
- * @param {*} [options] Override http request option.
1184
- * @throws {RequiredError}
1185
- */
1186
- deleteRecording(recordingId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1187
- /**
1188
- *
1189
- * @summary Retrieve Recording (HLS) Content
1190
- * @param {string} recordingId Recording id
1191
- * @param {string} filename Name of the file
1192
- * @param {*} [options] Override http request option.
1193
- * @throws {RequiredError}
1194
- */
1195
- getRecordingContent(recordingId: string, filename: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
1196
- /**
1197
- *
1198
- * @summary Lists all available recordings
1199
- * @param {*} [options] Override http request option.
1200
- * @throws {RequiredError}
1201
- */
1202
- getRecordings(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecordingListResponse>>;
1203
- };
1204
- /**
1205
- * RecordingApi - factory interface
1206
- * @export
1207
- */
1208
- export declare const RecordingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1209
- /**
1210
- *
1211
- * @summary Deletes the recording
1212
- * @param {string} recordingId Recording id
1213
- * @param {*} [options] Override http request option.
1214
- * @throws {RequiredError}
1215
- */
1216
- deleteRecording(recordingId: string, options?: any): AxiosPromise<void>;
1217
- /**
1218
- *
1219
- * @summary Retrieve Recording (HLS) Content
1220
- * @param {string} recordingId Recording id
1221
- * @param {string} filename Name of the file
1222
- * @param {*} [options] Override http request option.
1223
- * @throws {RequiredError}
1224
- */
1225
- getRecordingContent(recordingId: string, filename: string, options?: any): AxiosPromise<string>;
1226
- /**
1227
- *
1228
- * @summary Lists all available recordings
1229
- * @param {*} [options] Override http request option.
1230
- * @throws {RequiredError}
1231
- */
1232
- getRecordings(options?: any): AxiosPromise<RecordingListResponse>;
1233
- };
1234
- /**
1235
- * RecordingApi - object-oriented interface
1236
- * @export
1237
- * @class RecordingApi
1238
- * @extends {BaseAPI}
1239
- */
1240
- export declare class RecordingApi extends BaseAPI {
1241
- /**
1242
- *
1243
- * @summary Deletes the recording
1244
- * @param {string} recordingId Recording id
1245
- * @param {*} [options] Override http request option.
1246
- * @throws {RequiredError}
1247
- * @memberof RecordingApi
1248
- */
1249
- deleteRecording(recordingId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
1250
- /**
1251
- *
1252
- * @summary Retrieve Recording (HLS) Content
1253
- * @param {string} recordingId Recording id
1254
- * @param {string} filename Name of the file
1255
- * @param {*} [options] Override http request option.
1256
- * @throws {RequiredError}
1257
- * @memberof RecordingApi
1258
- */
1259
- getRecordingContent(recordingId: string, filename: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<string, any>>;
1260
- /**
1261
- *
1262
- * @summary Lists all available recordings
1263
- * @param {*} [options] Override http request option.
1264
- * @throws {RequiredError}
1265
- * @memberof RecordingApi
1266
- */
1267
- getRecordings(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RecordingListResponse, any>>;
1268
- }
1269
- /**
1270
- * RoomApi - axios parameter creator
1271
- * @export
1272
- */
1273
- export declare const RoomApiAxiosParamCreator: (configuration?: Configuration) => {
1274
- /**
1275
- *
1276
- * @summary Creates the component and adds it to the room
1277
- * @param {string} roomId Room ID
1278
- * @param {AddComponentRequest} [addComponentRequest] Component config
1279
- * @param {*} [options] Override http request option.
1280
- * @throws {RequiredError}
1281
- */
1282
- addComponent: (roomId: string, addComponentRequest?: AddComponentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1283
- /**
1284
- *
1285
- * @summary Create peer
1286
- * @param {string} roomId Room id
1287
- * @param {AddPeerRequest} [addPeerRequest] Peer specification
1288
- * @param {*} [options] Override http request option.
1289
- * @throws {RequiredError}
1290
- */
1291
- addPeer: (roomId: string, addPeerRequest?: AddPeerRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1292
- /**
1293
- *
1294
- * @summary Creates a room
1295
- * @param {RoomConfig} [roomConfig] Room configuration
1296
- * @param {*} [options] Override http request option.
1297
- * @throws {RequiredError}
1298
- */
1299
- createRoom: (roomConfig?: RoomConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1300
- /**
1301
- *
1302
- * @summary Delete the component from the room
1303
- * @param {string} roomId Room ID
1304
- * @param {string} id Component ID
1305
- * @param {*} [options] Override http request option.
1306
- * @throws {RequiredError}
1307
- */
1308
- deleteComponent: (roomId: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1309
- /**
1310
- *
1311
- * @summary Delete peer
1312
- * @param {string} roomId Room ID
1313
- * @param {string} id Peer id
1314
- * @param {*} [options] Override http request option.
1315
- * @throws {RequiredError}
1316
- */
1317
- deletePeer: (roomId: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1318
- /**
1319
- *
1320
- * @summary Delete the room
1321
- * @param {string} roomId Room id
1322
- * @param {*} [options] Override http request option.
1323
- * @throws {RequiredError}
1324
- */
1325
- deleteRoom: (roomId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1326
- /**
1327
- *
1328
- * @summary Show information about all rooms
1329
- * @param {*} [options] Override http request option.
1330
- * @throws {RequiredError}
1331
- */
1332
- getAllRooms: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1333
- /**
1334
- *
1335
- * @summary Shows information about the room
1336
- * @param {string} roomId Room ID
1337
- * @param {*} [options] Override http request option.
1338
- * @throws {RequiredError}
1339
- */
1340
- getRoom: (roomId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1341
- /**
1342
- *
1343
- * @summary Subscribe component to the tracks of peers or components
1344
- * @param {string} roomId Room ID
1345
- * @param {string} componentId Component ID
1346
- * @param {SubscriptionConfig} [subscriptionConfig] Subscribe configuration
1347
- * @param {*} [options] Override http request option.
1348
- * @throws {RequiredError}
1349
- */
1350
- subscribeTo: (roomId: string, componentId: string, subscriptionConfig?: SubscriptionConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1351
- };
1352
- /**
1353
- * RoomApi - functional programming interface
1354
- * @export
1355
- */
1356
- export declare const RoomApiFp: (configuration?: Configuration) => {
1357
- /**
1358
- *
1359
- * @summary Creates the component and adds it to the room
1360
- * @param {string} roomId Room ID
1361
- * @param {AddComponentRequest} [addComponentRequest] Component config
1362
- * @param {*} [options] Override http request option.
1363
- * @throws {RequiredError}
1364
- */
1365
- addComponent(roomId: string, addComponentRequest?: AddComponentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ComponentDetailsResponse>>;
1366
- /**
1367
- *
1368
- * @summary Create peer
1369
- * @param {string} roomId Room id
1370
- * @param {AddPeerRequest} [addPeerRequest] Peer specification
1371
- * @param {*} [options] Override http request option.
1372
- * @throws {RequiredError}
1373
- */
1374
- addPeer(roomId: string, addPeerRequest?: AddPeerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PeerDetailsResponse>>;
1375
- /**
1376
- *
1377
- * @summary Creates a room
1378
- * @param {RoomConfig} [roomConfig] Room configuration
1379
- * @param {*} [options] Override http request option.
1380
- * @throws {RequiredError}
1381
- */
1382
- createRoom(roomConfig?: RoomConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoomCreateDetailsResponse>>;
1383
- /**
1384
- *
1385
- * @summary Delete the component from the room
1386
- * @param {string} roomId Room ID
1387
- * @param {string} id Component ID
1388
- * @param {*} [options] Override http request option.
1389
- * @throws {RequiredError}
1390
- */
1391
- deleteComponent(roomId: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1392
- /**
1393
- *
1394
- * @summary Delete peer
1395
- * @param {string} roomId Room ID
1396
- * @param {string} id Peer id
1397
- * @param {*} [options] Override http request option.
1398
- * @throws {RequiredError}
1399
- */
1400
- deletePeer(roomId: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1401
- /**
1402
- *
1403
- * @summary Delete the room
1404
- * @param {string} roomId Room id
1405
- * @param {*} [options] Override http request option.
1406
- * @throws {RequiredError}
1407
- */
1408
- deleteRoom(roomId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1409
- /**
1410
- *
1411
- * @summary Show information about all rooms
1412
- * @param {*} [options] Override http request option.
1413
- * @throws {RequiredError}
1414
- */
1415
- getAllRooms(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoomsListingResponse>>;
1416
- /**
1417
- *
1418
- * @summary Shows information about the room
1419
- * @param {string} roomId Room ID
1420
- * @param {*} [options] Override http request option.
1421
- * @throws {RequiredError}
1422
- */
1423
- getRoom(roomId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RoomDetailsResponse>>;
1424
- /**
1425
- *
1426
- * @summary Subscribe component to the tracks of peers or components
1427
- * @param {string} roomId Room ID
1428
- * @param {string} componentId Component ID
1429
- * @param {SubscriptionConfig} [subscriptionConfig] Subscribe configuration
1430
- * @param {*} [options] Override http request option.
1431
- * @throws {RequiredError}
1432
- */
1433
- subscribeTo(roomId: string, componentId: string, subscriptionConfig?: SubscriptionConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1434
- };
1435
- /**
1436
- * RoomApi - factory interface
1437
- * @export
1438
- */
1439
- export declare const RoomApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1440
- /**
1441
- *
1442
- * @summary Creates the component and adds it to the room
1443
- * @param {string} roomId Room ID
1444
- * @param {AddComponentRequest} [addComponentRequest] Component config
1445
- * @param {*} [options] Override http request option.
1446
- * @throws {RequiredError}
1447
- */
1448
- addComponent(roomId: string, addComponentRequest?: AddComponentRequest, options?: any): AxiosPromise<ComponentDetailsResponse>;
1449
- /**
1450
- *
1451
- * @summary Create peer
1452
- * @param {string} roomId Room id
1453
- * @param {AddPeerRequest} [addPeerRequest] Peer specification
1454
- * @param {*} [options] Override http request option.
1455
- * @throws {RequiredError}
1456
- */
1457
- addPeer(roomId: string, addPeerRequest?: AddPeerRequest, options?: any): AxiosPromise<PeerDetailsResponse>;
1458
- /**
1459
- *
1460
- * @summary Creates a room
1461
- * @param {RoomConfig} [roomConfig] Room configuration
1462
- * @param {*} [options] Override http request option.
1463
- * @throws {RequiredError}
1464
- */
1465
- createRoom(roomConfig?: RoomConfig, options?: any): AxiosPromise<RoomCreateDetailsResponse>;
1466
- /**
1467
- *
1468
- * @summary Delete the component from the room
1469
- * @param {string} roomId Room ID
1470
- * @param {string} id Component ID
1471
- * @param {*} [options] Override http request option.
1472
- * @throws {RequiredError}
1473
- */
1474
- deleteComponent(roomId: string, id: string, options?: any): AxiosPromise<void>;
1475
- /**
1476
- *
1477
- * @summary Delete peer
1478
- * @param {string} roomId Room ID
1479
- * @param {string} id Peer id
1480
- * @param {*} [options] Override http request option.
1481
- * @throws {RequiredError}
1482
- */
1483
- deletePeer(roomId: string, id: string, options?: any): AxiosPromise<void>;
1484
- /**
1485
- *
1486
- * @summary Delete the room
1487
- * @param {string} roomId Room id
1488
- * @param {*} [options] Override http request option.
1489
- * @throws {RequiredError}
1490
- */
1491
- deleteRoom(roomId: string, options?: any): AxiosPromise<void>;
1492
- /**
1493
- *
1494
- * @summary Show information about all rooms
1495
- * @param {*} [options] Override http request option.
1496
- * @throws {RequiredError}
1497
- */
1498
- getAllRooms(options?: any): AxiosPromise<RoomsListingResponse>;
1499
- /**
1500
- *
1501
- * @summary Shows information about the room
1502
- * @param {string} roomId Room ID
1503
- * @param {*} [options] Override http request option.
1504
- * @throws {RequiredError}
1505
- */
1506
- getRoom(roomId: string, options?: any): AxiosPromise<RoomDetailsResponse>;
1507
- /**
1508
- *
1509
- * @summary Subscribe component to the tracks of peers or components
1510
- * @param {string} roomId Room ID
1511
- * @param {string} componentId Component ID
1512
- * @param {SubscriptionConfig} [subscriptionConfig] Subscribe configuration
1513
- * @param {*} [options] Override http request option.
1514
- * @throws {RequiredError}
1515
- */
1516
- subscribeTo(roomId: string, componentId: string, subscriptionConfig?: SubscriptionConfig, options?: any): AxiosPromise<void>;
1517
- };
1518
- /**
1519
- * RoomApi - object-oriented interface
1520
- * @export
1521
- * @class RoomApi
1522
- * @extends {BaseAPI}
1523
- */
1524
- export declare class RoomApi extends BaseAPI {
1525
- /**
1526
- *
1527
- * @summary Creates the component and adds it to the room
1528
- * @param {string} roomId Room ID
1529
- * @param {AddComponentRequest} [addComponentRequest] Component config
1530
- * @param {*} [options] Override http request option.
1531
- * @throws {RequiredError}
1532
- * @memberof RoomApi
1533
- */
1534
- addComponent(roomId: string, addComponentRequest?: AddComponentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ComponentDetailsResponse, any>>;
1535
- /**
1536
- *
1537
- * @summary Create peer
1538
- * @param {string} roomId Room id
1539
- * @param {AddPeerRequest} [addPeerRequest] Peer specification
1540
- * @param {*} [options] Override http request option.
1541
- * @throws {RequiredError}
1542
- * @memberof RoomApi
1543
- */
1544
- addPeer(roomId: string, addPeerRequest?: AddPeerRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PeerDetailsResponse, any>>;
1545
- /**
1546
- *
1547
- * @summary Creates a room
1548
- * @param {RoomConfig} [roomConfig] Room configuration
1549
- * @param {*} [options] Override http request option.
1550
- * @throws {RequiredError}
1551
- * @memberof RoomApi
1552
- */
1553
- createRoom(roomConfig?: RoomConfig, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RoomCreateDetailsResponse, any>>;
1554
- /**
1555
- *
1556
- * @summary Delete the component from the room
1557
- * @param {string} roomId Room ID
1558
- * @param {string} id Component ID
1559
- * @param {*} [options] Override http request option.
1560
- * @throws {RequiredError}
1561
- * @memberof RoomApi
1562
- */
1563
- deleteComponent(roomId: string, id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
1564
- /**
1565
- *
1566
- * @summary Delete peer
1567
- * @param {string} roomId Room ID
1568
- * @param {string} id Peer id
1569
- * @param {*} [options] Override http request option.
1570
- * @throws {RequiredError}
1571
- * @memberof RoomApi
1572
- */
1573
- deletePeer(roomId: string, id: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
1574
- /**
1575
- *
1576
- * @summary Delete the room
1577
- * @param {string} roomId Room id
1578
- * @param {*} [options] Override http request option.
1579
- * @throws {RequiredError}
1580
- * @memberof RoomApi
1581
- */
1582
- deleteRoom(roomId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
1583
- /**
1584
- *
1585
- * @summary Show information about all rooms
1586
- * @param {*} [options] Override http request option.
1587
- * @throws {RequiredError}
1588
- * @memberof RoomApi
1589
- */
1590
- getAllRooms(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RoomsListingResponse, any>>;
1591
- /**
1592
- *
1593
- * @summary Shows information about the room
1594
- * @param {string} roomId Room ID
1595
- * @param {*} [options] Override http request option.
1596
- * @throws {RequiredError}
1597
- * @memberof RoomApi
1598
- */
1599
- getRoom(roomId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<RoomDetailsResponse, any>>;
1600
- /**
1601
- *
1602
- * @summary Subscribe component to the tracks of peers or components
1603
- * @param {string} roomId Room ID
1604
- * @param {string} componentId Component ID
1605
- * @param {SubscriptionConfig} [subscriptionConfig] Subscribe configuration
1606
- * @param {*} [options] Override http request option.
1607
- * @throws {RequiredError}
1608
- * @memberof RoomApi
1609
- */
1610
- subscribeTo(roomId: string, componentId: string, subscriptionConfig?: SubscriptionConfig, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
1611
- }
1612
- /**
1613
- * SipApi - axios parameter creator
1614
- * @export
1615
- */
1616
- export declare const SipApiAxiosParamCreator: (configuration?: Configuration) => {
1617
- /**
1618
- *
1619
- * @summary Make a call from the SIP component to the provided phone number
1620
- * @param {string} roomId Room ID
1621
- * @param {string} componentId SIP Component ID
1622
- * @param {DialConfig} [dialConfig] Phone Number configuration
1623
- * @param {*} [options] Override http request option.
1624
- * @throws {RequiredError}
1625
- */
1626
- dial: (roomId: string, componentId: string, dialConfig?: DialConfig, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1627
- /**
1628
- *
1629
- * @summary Finish call made by SIP component
1630
- * @param {string} roomId Room ID
1631
- * @param {string} componentId SIP Component ID
1632
- * @param {*} [options] Override http request option.
1633
- * @throws {RequiredError}
1634
- */
1635
- endCall: (roomId: string, componentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1636
- };
1637
- /**
1638
- * SipApi - functional programming interface
1639
- * @export
1640
- */
1641
- export declare const SipApiFp: (configuration?: Configuration) => {
1642
- /**
1643
- *
1644
- * @summary Make a call from the SIP component to the provided phone number
1645
- * @param {string} roomId Room ID
1646
- * @param {string} componentId SIP Component ID
1647
- * @param {DialConfig} [dialConfig] Phone Number configuration
1648
- * @param {*} [options] Override http request option.
1649
- * @throws {RequiredError}
1650
- */
1651
- dial(roomId: string, componentId: string, dialConfig?: DialConfig, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1652
- /**
1653
- *
1654
- * @summary Finish call made by SIP component
1655
- * @param {string} roomId Room ID
1656
- * @param {string} componentId SIP Component ID
1657
- * @param {*} [options] Override http request option.
1658
- * @throws {RequiredError}
1659
- */
1660
- endCall(roomId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1661
- };
1662
- /**
1663
- * SipApi - factory interface
1664
- * @export
1665
- */
1666
- export declare const SipApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1667
- /**
1668
- *
1669
- * @summary Make a call from the SIP component to the provided phone number
1670
- * @param {string} roomId Room ID
1671
- * @param {string} componentId SIP Component ID
1672
- * @param {DialConfig} [dialConfig] Phone Number configuration
1673
- * @param {*} [options] Override http request option.
1674
- * @throws {RequiredError}
1675
- */
1676
- dial(roomId: string, componentId: string, dialConfig?: DialConfig, options?: any): AxiosPromise<void>;
1677
- /**
1678
- *
1679
- * @summary Finish call made by SIP component
1680
- * @param {string} roomId Room ID
1681
- * @param {string} componentId SIP Component ID
1682
- * @param {*} [options] Override http request option.
1683
- * @throws {RequiredError}
1684
- */
1685
- endCall(roomId: string, componentId: string, options?: any): AxiosPromise<void>;
1686
- };
1687
- /**
1688
- * SipApi - object-oriented interface
1689
- * @export
1690
- * @class SipApi
1691
- * @extends {BaseAPI}
1692
- */
1693
- export declare class SipApi extends BaseAPI {
1694
- /**
1695
- *
1696
- * @summary Make a call from the SIP component to the provided phone number
1697
- * @param {string} roomId Room ID
1698
- * @param {string} componentId SIP Component ID
1699
- * @param {DialConfig} [dialConfig] Phone Number configuration
1700
- * @param {*} [options] Override http request option.
1701
- * @throws {RequiredError}
1702
- * @memberof SipApi
1703
- */
1704
- dial(roomId: string, componentId: string, dialConfig?: DialConfig, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
1705
- /**
1706
- *
1707
- * @summary Finish call made by SIP component
1708
- * @param {string} roomId Room ID
1709
- * @param {string} componentId SIP Component ID
1710
- * @param {*} [options] Override http request option.
1711
- * @throws {RequiredError}
1712
- * @memberof SipApi
1713
- */
1714
- endCall(roomId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
1715
- }