@connectedxm/admin-sdk 11.6.0 → 11.7.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.
- package/.openapi-generator/FILES +26 -8
- package/README.md +2 -2
- package/api.ts +353 -76
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +287 -76
- package/dist/api.js +173 -23
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +287 -76
- package/dist/esm/api.js +151 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/GetMeetingSessionParticipantReport200Response.md +24 -0
- package/docs/MeetingSessionParticipant.md +0 -4
- package/docs/MeetingSessionParticipantReport.md +30 -0
- package/docs/MeetingSessionParticipantReportMeta.md +26 -0
- package/docs/MeetingSessionReportConnection.md +26 -0
- package/docs/MeetingSessionReportDevice.md +28 -0
- package/docs/MeetingSessionReportDistribution.md +26 -0
- package/docs/MeetingSessionReportEvent.md +26 -0
- package/docs/MeetingSessionReportIssue.md +28 -0
- package/docs/MeetingSessionReportIssueCode.md +30 -0
- package/docs/MeetingSessionReportLatency.md +26 -0
- package/docs/MeetingSessionReportPacketLoss.md +28 -0
- package/docs/MeetingSessionReportPoint.md +42 -0
- package/docs/MeetingSessionReportSeries.md +24 -0
- package/docs/MeetingSessionReportSeriesMap.md +34 -0
- package/docs/MeetingSessionReportStreams.md +34 -0
- package/docs/MeetingSessionReportSummary.md +32 -0
- package/docs/MeetingSessionReportSummaryConnectivity.md +30 -0
- package/docs/MeetingSessionReportSummaryConnectivityTransports.md +22 -0
- package/docs/MeetingSessionReportSummaryDevice.md +32 -0
- package/docs/MeetingSessionReportSummaryLocation.md +26 -0
- package/docs/MeetingSessionReportSummaryPlatform.md +26 -0
- package/docs/MeetingSessionStreamKey.md +22 -0
- package/docs/MeetingSessionStreamSummary.md +32 -0
- package/docs/MeetingSessionStreamVideoSummary.md +26 -0
- package/docs/MeetingSessionStreamVideoSummaryIssues.md +28 -0
- package/docs/MeetingSessionStreamVideoSummaryLimitation.md +26 -0
- package/docs/MeetingsSessionsApi.md +58 -0
- package/package.json +1 -1
- package/docs/MeetingSessionParticipantAllOfAudioStats.md +0 -28
- package/docs/MeetingSessionParticipantAllOfPeerStats.md +0 -30
- package/docs/MeetingSessionParticipantAllOfPeerStatsDeviceInfo.md +0 -42
- package/docs/MeetingSessionParticipantAllOfPeerStatsEvents.md +0 -22
- package/docs/MeetingSessionParticipantAllOfPeerStatsIpInformation.md +0 -34
- package/docs/MeetingSessionParticipantAllOfPeerStatsPrecallNetworkInformation.md +0 -36
- package/docs/MeetingSessionParticipantAllOfQualityStats.md +0 -38
- package/docs/MeetingSessionParticipantAllOfVideoStats.md +0 -34
package/.openapi-generator/FILES
CHANGED
|
@@ -993,6 +993,7 @@ docs/GetMeetingRecordings200Response.md
|
|
|
993
993
|
docs/GetMeetingSession200Response.md
|
|
994
994
|
docs/GetMeetingSessionMessages200Response.md
|
|
995
995
|
docs/GetMeetingSessionParticipant200Response.md
|
|
996
|
+
docs/GetMeetingSessionParticipantReport200Response.md
|
|
996
997
|
docs/GetMeetingSessionParticipants200Response.md
|
|
997
998
|
docs/GetMeetingSessionSummary200Response.md
|
|
998
999
|
docs/GetMeetingSessionTranscript200Response.md
|
|
@@ -1187,14 +1188,31 @@ docs/MeetingRecordingUpdateInputs.md
|
|
|
1187
1188
|
docs/MeetingSession.md
|
|
1188
1189
|
docs/MeetingSessionChatDownload.md
|
|
1189
1190
|
docs/MeetingSessionParticipant.md
|
|
1190
|
-
docs/
|
|
1191
|
-
docs/
|
|
1192
|
-
docs/
|
|
1193
|
-
docs/
|
|
1194
|
-
docs/
|
|
1195
|
-
docs/
|
|
1196
|
-
docs/
|
|
1197
|
-
docs/
|
|
1191
|
+
docs/MeetingSessionParticipantReport.md
|
|
1192
|
+
docs/MeetingSessionParticipantReportMeta.md
|
|
1193
|
+
docs/MeetingSessionReportConnection.md
|
|
1194
|
+
docs/MeetingSessionReportDevice.md
|
|
1195
|
+
docs/MeetingSessionReportDistribution.md
|
|
1196
|
+
docs/MeetingSessionReportEvent.md
|
|
1197
|
+
docs/MeetingSessionReportIssue.md
|
|
1198
|
+
docs/MeetingSessionReportIssueCode.md
|
|
1199
|
+
docs/MeetingSessionReportLatency.md
|
|
1200
|
+
docs/MeetingSessionReportPacketLoss.md
|
|
1201
|
+
docs/MeetingSessionReportPoint.md
|
|
1202
|
+
docs/MeetingSessionReportSeries.md
|
|
1203
|
+
docs/MeetingSessionReportSeriesMap.md
|
|
1204
|
+
docs/MeetingSessionReportStreams.md
|
|
1205
|
+
docs/MeetingSessionReportSummary.md
|
|
1206
|
+
docs/MeetingSessionReportSummaryConnectivity.md
|
|
1207
|
+
docs/MeetingSessionReportSummaryConnectivityTransports.md
|
|
1208
|
+
docs/MeetingSessionReportSummaryDevice.md
|
|
1209
|
+
docs/MeetingSessionReportSummaryLocation.md
|
|
1210
|
+
docs/MeetingSessionReportSummaryPlatform.md
|
|
1211
|
+
docs/MeetingSessionStreamKey.md
|
|
1212
|
+
docs/MeetingSessionStreamSummary.md
|
|
1213
|
+
docs/MeetingSessionStreamVideoSummary.md
|
|
1214
|
+
docs/MeetingSessionStreamVideoSummaryIssues.md
|
|
1215
|
+
docs/MeetingSessionStreamVideoSummaryLimitation.md
|
|
1198
1216
|
docs/MeetingSessionSummaryDownload.md
|
|
1199
1217
|
docs/MeetingSessionTranscriptDownload.md
|
|
1200
1218
|
docs/MeetingType.md
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@11.
|
|
1
|
+
## @connectedxm/admin-sdk@11.7.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @connectedxm/admin-sdk@11.
|
|
39
|
+
npm install @connectedxm/admin-sdk@11.7.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.7.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -9603,6 +9603,16 @@ export enum GetMeetingSessionParticipant200ResponseStatusEnum {
|
|
|
9603
9603
|
Ok = 'ok'
|
|
9604
9604
|
}
|
|
9605
9605
|
|
|
9606
|
+
export interface GetMeetingSessionParticipantReport200Response {
|
|
9607
|
+
'status': GetMeetingSessionParticipantReport200ResponseStatusEnum;
|
|
9608
|
+
'message': string;
|
|
9609
|
+
'data': MeetingSessionParticipantReport;
|
|
9610
|
+
}
|
|
9611
|
+
|
|
9612
|
+
export enum GetMeetingSessionParticipantReport200ResponseStatusEnum {
|
|
9613
|
+
Ok = 'ok'
|
|
9614
|
+
}
|
|
9615
|
+
|
|
9606
9616
|
export interface GetMeetingSessionParticipants200Response {
|
|
9607
9617
|
'status': GetMeetingSessionParticipants200ResponseStatusEnum;
|
|
9608
9618
|
'message': string;
|
|
@@ -11450,84 +11460,246 @@ export interface MeetingSessionParticipant {
|
|
|
11450
11460
|
'role': string;
|
|
11451
11461
|
'preset_name': string;
|
|
11452
11462
|
'account': BaseAccount | null;
|
|
11453
|
-
'peer_stats'?: MeetingSessionParticipantAllOfPeerStats;
|
|
11454
|
-
'quality_stats'?: Array<MeetingSessionParticipantAllOfQualityStats>;
|
|
11455
|
-
}
|
|
11456
|
-
export interface MeetingSessionParticipantAllOfAudioStats {
|
|
11457
|
-
'timestamp': string;
|
|
11458
|
-
'concealment_events'?: number;
|
|
11459
|
-
'packets_lost'?: number;
|
|
11460
|
-
'jitter'?: number;
|
|
11461
|
-
'quality'?: number;
|
|
11462
|
-
}
|
|
11463
|
-
export interface MeetingSessionParticipantAllOfPeerStats {
|
|
11464
|
-
'config'?: string;
|
|
11465
|
-
'status'?: string;
|
|
11466
|
-
'device_info'?: MeetingSessionParticipantAllOfPeerStatsDeviceInfo;
|
|
11467
|
-
'events'?: Array<MeetingSessionParticipantAllOfPeerStatsEvents>;
|
|
11468
|
-
'ip_information'?: MeetingSessionParticipantAllOfPeerStatsIpInformation;
|
|
11469
|
-
'precall_network_information'?: MeetingSessionParticipantAllOfPeerStatsPrecallNetworkInformation;
|
|
11470
|
-
}
|
|
11471
|
-
export interface MeetingSessionParticipantAllOfPeerStatsDeviceInfo {
|
|
11472
|
-
'browser'?: string;
|
|
11473
|
-
'browser_version'?: string;
|
|
11474
|
-
'cpus'?: number;
|
|
11475
|
-
'engine'?: string;
|
|
11476
|
-
'is_mobile'?: boolean;
|
|
11477
|
-
'memory'?: number;
|
|
11478
|
-
'os'?: string;
|
|
11479
|
-
'os_version'?: string;
|
|
11480
|
-
'sdk_name'?: string;
|
|
11481
|
-
'sdk_version'?: string;
|
|
11482
|
-
'user_agent'?: string;
|
|
11483
|
-
'webgl_support'?: string;
|
|
11484
|
-
}
|
|
11485
|
-
export interface MeetingSessionParticipantAllOfPeerStatsEvents {
|
|
11486
|
-
'timestamp': string;
|
|
11487
|
-
'type': string;
|
|
11488
11463
|
}
|
|
11489
|
-
export interface
|
|
11490
|
-
'
|
|
11491
|
-
'
|
|
11492
|
-
'
|
|
11493
|
-
'
|
|
11494
|
-
'
|
|
11495
|
-
'
|
|
11496
|
-
|
|
11497
|
-
|
|
11464
|
+
export interface MeetingSessionParticipantReport {
|
|
11465
|
+
'participant': BaseMeetingSessionParticipant;
|
|
11466
|
+
'summary': MeetingSessionReportSummary;
|
|
11467
|
+
'series': MeetingSessionReportSeriesMap;
|
|
11468
|
+
'events': Array<MeetingSessionReportEvent>;
|
|
11469
|
+
'devices': Array<MeetingSessionReportDevice>;
|
|
11470
|
+
'meta': MeetingSessionParticipantReportMeta;
|
|
11471
|
+
}
|
|
11472
|
+
export interface MeetingSessionParticipantReportMeta {
|
|
11473
|
+
'fetched_at': string;
|
|
11474
|
+
'truncated': boolean;
|
|
11475
|
+
'peer_id': string;
|
|
11476
|
+
'has_data': boolean;
|
|
11498
11477
|
}
|
|
11499
|
-
export interface
|
|
11500
|
-
'backend_rtt'?: number;
|
|
11501
|
-
'turn_connectivity'?: boolean;
|
|
11502
|
-
'effective_networktype'?: string;
|
|
11503
|
-
'throughtput'?: number;
|
|
11504
|
-
'jitter'?: number;
|
|
11505
|
-
'rtt'?: number;
|
|
11506
|
-
'reflexive_connectivity'?: boolean;
|
|
11507
|
-
'relay_connectivity'?: boolean;
|
|
11508
|
-
'fractional_loss'?: number;
|
|
11509
|
-
}
|
|
11510
|
-
export interface MeetingSessionParticipantAllOfQualityStats {
|
|
11478
|
+
export interface MeetingSessionReportConnection {
|
|
11511
11479
|
'peer_id': string;
|
|
11512
|
-
'
|
|
11513
|
-
'
|
|
11514
|
-
'
|
|
11515
|
-
|
|
11516
|
-
|
|
11517
|
-
'
|
|
11518
|
-
'
|
|
11519
|
-
'
|
|
11520
|
-
'
|
|
11521
|
-
|
|
11522
|
-
|
|
11523
|
-
|
|
11524
|
-
|
|
11525
|
-
'
|
|
11526
|
-
'
|
|
11527
|
-
'
|
|
11528
|
-
'
|
|
11529
|
-
|
|
11530
|
-
|
|
11480
|
+
'joined_at': string | null;
|
|
11481
|
+
'left_at': string | null;
|
|
11482
|
+
'reconnects': number;
|
|
11483
|
+
}
|
|
11484
|
+
export interface MeetingSessionReportDevice {
|
|
11485
|
+
't': string;
|
|
11486
|
+
'kind': MeetingSessionReportDeviceKindEnum;
|
|
11487
|
+
'action': MeetingSessionReportDeviceActionEnum;
|
|
11488
|
+
'label': string | null;
|
|
11489
|
+
'device_id': string | null;
|
|
11490
|
+
}
|
|
11491
|
+
|
|
11492
|
+
export enum MeetingSessionReportDeviceKindEnum {
|
|
11493
|
+
Audioinput = 'audioinput',
|
|
11494
|
+
Videoinput = 'videoinput',
|
|
11495
|
+
Audiooutput = 'audiooutput',
|
|
11496
|
+
Unknown = 'unknown'
|
|
11497
|
+
}
|
|
11498
|
+
export enum MeetingSessionReportDeviceActionEnum {
|
|
11499
|
+
Selected = 'selected',
|
|
11500
|
+
Added = 'added',
|
|
11501
|
+
Removed = 'removed'
|
|
11502
|
+
}
|
|
11503
|
+
|
|
11504
|
+
export interface MeetingSessionReportDistribution {
|
|
11505
|
+
'avg': number | null;
|
|
11506
|
+
'p50': number | null;
|
|
11507
|
+
'p75': number | null;
|
|
11508
|
+
'p90': number | null;
|
|
11509
|
+
}
|
|
11510
|
+
export interface MeetingSessionReportEvent {
|
|
11511
|
+
't': string;
|
|
11512
|
+
'kind': MeetingSessionReportEventKindEnum;
|
|
11513
|
+
'name': string;
|
|
11514
|
+
'detail': { [key: string]: any; };
|
|
11515
|
+
}
|
|
11516
|
+
|
|
11517
|
+
export enum MeetingSessionReportEventKindEnum {
|
|
11518
|
+
Join = 'join',
|
|
11519
|
+
Leave = 'leave',
|
|
11520
|
+
Reconnect = 'reconnect',
|
|
11521
|
+
Media = 'media',
|
|
11522
|
+
Network = 'network',
|
|
11523
|
+
Device = 'device',
|
|
11524
|
+
Other = 'other'
|
|
11525
|
+
}
|
|
11526
|
+
|
|
11527
|
+
export interface MeetingSessionReportIssue {
|
|
11528
|
+
'code': MeetingSessionReportIssueCode;
|
|
11529
|
+
'severity': MeetingSessionReportIssueSeverityEnum;
|
|
11530
|
+
'stream'?: MeetingSessionStreamKey;
|
|
11531
|
+
'value': number;
|
|
11532
|
+
'label': string;
|
|
11533
|
+
}
|
|
11534
|
+
|
|
11535
|
+
export enum MeetingSessionReportIssueSeverityEnum {
|
|
11536
|
+
Warning = 'warning',
|
|
11537
|
+
Critical = 'critical'
|
|
11538
|
+
}
|
|
11539
|
+
|
|
11540
|
+
|
|
11541
|
+
export enum MeetingSessionReportIssueCode {
|
|
11542
|
+
LowMos = 'low_mos',
|
|
11543
|
+
HighPacketLoss = 'high_packet_loss',
|
|
11544
|
+
HighRtt = 'high_rtt',
|
|
11545
|
+
AudioGlitches = 'audio_glitches',
|
|
11546
|
+
BandwidthLimited = 'bandwidth_limited',
|
|
11547
|
+
CpuLimited = 'cpu_limited',
|
|
11548
|
+
NoVideo = 'no_video',
|
|
11549
|
+
PoorResolution = 'poor_resolution',
|
|
11550
|
+
Lag = 'lag',
|
|
11551
|
+
HighJitterBuffer = 'high_jitter_buffer',
|
|
11552
|
+
RelayOnly = 'relay_only',
|
|
11553
|
+
TurnUnreachable = 'turn_unreachable'
|
|
11554
|
+
}
|
|
11555
|
+
|
|
11556
|
+
|
|
11557
|
+
export interface MeetingSessionReportLatency {
|
|
11558
|
+
'avg': number | null;
|
|
11559
|
+
'ge_100': number | null;
|
|
11560
|
+
'ge_250': number | null;
|
|
11561
|
+
'ge_500': number | null;
|
|
11562
|
+
}
|
|
11563
|
+
export interface MeetingSessionReportPacketLoss {
|
|
11564
|
+
'avg': number | null;
|
|
11565
|
+
'ge_5': number | null;
|
|
11566
|
+
'ge_10': number | null;
|
|
11567
|
+
'ge_25': number | null;
|
|
11568
|
+
'ge_50': number | null;
|
|
11569
|
+
}
|
|
11570
|
+
export interface MeetingSessionReportPoint {
|
|
11571
|
+
't': string;
|
|
11572
|
+
'mos': number | null;
|
|
11573
|
+
'packets_lost': number | null;
|
|
11574
|
+
'jitter_ms': number | null;
|
|
11575
|
+
'rtt_ms'?: number | null;
|
|
11576
|
+
'jitter_buffer_ms'?: number | null;
|
|
11577
|
+
'bitrate_kbps': number | null;
|
|
11578
|
+
'fps'?: number | null;
|
|
11579
|
+
'width'?: number | null;
|
|
11580
|
+
'height'?: number | null;
|
|
11581
|
+
'frames_dropped'?: number | null;
|
|
11582
|
+
'limitation'?: string | null;
|
|
11583
|
+
}
|
|
11584
|
+
export interface MeetingSessionReportSeries {
|
|
11585
|
+
'step_seconds': number;
|
|
11586
|
+
'downsampled_from': number;
|
|
11587
|
+
'points': Array<MeetingSessionReportPoint>;
|
|
11588
|
+
}
|
|
11589
|
+
export interface MeetingSessionReportSeriesMap {
|
|
11590
|
+
'audio_out'?: MeetingSessionReportSeries;
|
|
11591
|
+
'audio_in'?: MeetingSessionReportSeries;
|
|
11592
|
+
'video_out'?: MeetingSessionReportSeries;
|
|
11593
|
+
'video_in'?: MeetingSessionReportSeries;
|
|
11594
|
+
'screenshare_audio_out'?: MeetingSessionReportSeries;
|
|
11595
|
+
'screenshare_audio_in'?: MeetingSessionReportSeries;
|
|
11596
|
+
'screenshare_video_out'?: MeetingSessionReportSeries;
|
|
11597
|
+
'screenshare_video_in'?: MeetingSessionReportSeries;
|
|
11598
|
+
}
|
|
11599
|
+
export interface MeetingSessionReportStreams {
|
|
11600
|
+
'audio_out'?: MeetingSessionStreamSummary;
|
|
11601
|
+
'audio_in'?: MeetingSessionStreamSummary;
|
|
11602
|
+
'video_out'?: MeetingSessionStreamSummary;
|
|
11603
|
+
'video_in'?: MeetingSessionStreamSummary;
|
|
11604
|
+
'screenshare_audio_out'?: MeetingSessionStreamSummary;
|
|
11605
|
+
'screenshare_audio_in'?: MeetingSessionStreamSummary;
|
|
11606
|
+
'screenshare_video_out'?: MeetingSessionStreamSummary;
|
|
11607
|
+
'screenshare_video_in'?: MeetingSessionStreamSummary;
|
|
11608
|
+
}
|
|
11609
|
+
export interface MeetingSessionReportSummary {
|
|
11610
|
+
'connections': Array<MeetingSessionReportConnection>;
|
|
11611
|
+
'platform': MeetingSessionReportSummaryPlatform;
|
|
11612
|
+
'device': MeetingSessionReportSummaryDevice;
|
|
11613
|
+
'location': MeetingSessionReportSummaryLocation;
|
|
11614
|
+
'connectivity': MeetingSessionReportSummaryConnectivity;
|
|
11615
|
+
'streams': MeetingSessionReportStreams;
|
|
11616
|
+
'issues': Array<MeetingSessionReportIssue>;
|
|
11617
|
+
}
|
|
11618
|
+
export interface MeetingSessionReportSummaryConnectivity {
|
|
11619
|
+
'effective_network_type': string | null;
|
|
11620
|
+
'reflexive': boolean | null;
|
|
11621
|
+
'relay': boolean | null;
|
|
11622
|
+
'turn': boolean | null;
|
|
11623
|
+
'relay_only': boolean;
|
|
11624
|
+
'transports': MeetingSessionReportSummaryConnectivityTransports;
|
|
11625
|
+
}
|
|
11626
|
+
export interface MeetingSessionReportSummaryConnectivityTransports {
|
|
11627
|
+
'producing': MeetingSessionReportSummaryConnectivityTransportsProducingEnum | null;
|
|
11628
|
+
'consuming': MeetingSessionReportSummaryConnectivityTransportsConsumingEnum | null;
|
|
11629
|
+
}
|
|
11630
|
+
|
|
11631
|
+
export enum MeetingSessionReportSummaryConnectivityTransportsProducingEnum {
|
|
11632
|
+
Host = 'host',
|
|
11633
|
+
Srflx = 'srflx',
|
|
11634
|
+
Relay = 'relay'
|
|
11635
|
+
}
|
|
11636
|
+
export enum MeetingSessionReportSummaryConnectivityTransportsConsumingEnum {
|
|
11637
|
+
Host = 'host',
|
|
11638
|
+
Srflx = 'srflx',
|
|
11639
|
+
Relay = 'relay'
|
|
11640
|
+
}
|
|
11641
|
+
|
|
11642
|
+
export interface MeetingSessionReportSummaryDevice {
|
|
11643
|
+
'os': string | null;
|
|
11644
|
+
'os_version': string | null;
|
|
11645
|
+
'is_mobile': boolean | null;
|
|
11646
|
+
'cpus': number | null;
|
|
11647
|
+
'browser': string | null;
|
|
11648
|
+
'browser_version': string | null;
|
|
11649
|
+
'webgl_support': boolean | null;
|
|
11650
|
+
}
|
|
11651
|
+
export interface MeetingSessionReportSummaryLocation {
|
|
11652
|
+
'city': string | null;
|
|
11653
|
+
'region': string | null;
|
|
11654
|
+
'country': string | null;
|
|
11655
|
+
'org': string | null;
|
|
11656
|
+
}
|
|
11657
|
+
export interface MeetingSessionReportSummaryPlatform {
|
|
11658
|
+
'sdk_name': string | null;
|
|
11659
|
+
'sdk_type': string | null;
|
|
11660
|
+
'sdk_version': string | null;
|
|
11661
|
+
'room_view_type': string | null;
|
|
11662
|
+
}
|
|
11663
|
+
|
|
11664
|
+
export enum MeetingSessionStreamKey {
|
|
11665
|
+
AudioOut = 'audio_out',
|
|
11666
|
+
AudioIn = 'audio_in',
|
|
11667
|
+
VideoOut = 'video_out',
|
|
11668
|
+
VideoIn = 'video_in',
|
|
11669
|
+
ScreenshareAudioOut = 'screenshare_audio_out',
|
|
11670
|
+
ScreenshareAudioIn = 'screenshare_audio_in',
|
|
11671
|
+
ScreenshareVideoOut = 'screenshare_video_out',
|
|
11672
|
+
ScreenshareVideoIn = 'screenshare_video_in'
|
|
11673
|
+
}
|
|
11674
|
+
|
|
11675
|
+
|
|
11676
|
+
export interface MeetingSessionStreamSummary {
|
|
11677
|
+
'sample_count': number;
|
|
11678
|
+
'mos': MeetingSessionReportDistribution;
|
|
11679
|
+
'packet_loss': MeetingSessionReportPacketLoss;
|
|
11680
|
+
'rtt'?: MeetingSessionReportLatency;
|
|
11681
|
+
'jitter_buffer'?: MeetingSessionReportLatency;
|
|
11682
|
+
'glitch_count'?: number;
|
|
11683
|
+
'video'?: MeetingSessionStreamVideoSummary;
|
|
11684
|
+
}
|
|
11685
|
+
export interface MeetingSessionStreamVideoSummary {
|
|
11686
|
+
'fps': MeetingSessionReportDistribution;
|
|
11687
|
+
'width': MeetingSessionReportDistribution;
|
|
11688
|
+
'limitation'?: MeetingSessionStreamVideoSummaryLimitation;
|
|
11689
|
+
'issues': MeetingSessionStreamVideoSummaryIssues;
|
|
11690
|
+
}
|
|
11691
|
+
export interface MeetingSessionStreamVideoSummaryIssues {
|
|
11692
|
+
'bandwidth_fraction': number | null;
|
|
11693
|
+
'cpu_fraction': number | null;
|
|
11694
|
+
'no_video_fraction': number | null;
|
|
11695
|
+
'poor_resolution_fraction': number | null;
|
|
11696
|
+
'lag_fraction': number | null;
|
|
11697
|
+
}
|
|
11698
|
+
export interface MeetingSessionStreamVideoSummaryLimitation {
|
|
11699
|
+
'cpu': number;
|
|
11700
|
+
'bandwidth': number;
|
|
11701
|
+
'other': number;
|
|
11702
|
+
'resolution_changes': number;
|
|
11531
11703
|
}
|
|
11532
11704
|
export interface MeetingSessionSummaryDownload {
|
|
11533
11705
|
'sessionId': string;
|
|
@@ -119519,6 +119691,55 @@ export const MeetingsSessionsApiAxiosParamCreator = function (configuration?: Co
|
|
|
119519
119691
|
options: localVarRequestOptions,
|
|
119520
119692
|
};
|
|
119521
119693
|
},
|
|
119694
|
+
/**
|
|
119695
|
+
* Returns the call-quality report for one of a participant\'s connections (peers) within a meeting session: device, browser, location and connectivity details, per-stream quality roll-ups (audio, video and screenshare, sent and received), a plain-language list of detected issues, downsampled time series for charting, and a timeline of connection and device events. A participant who reconnected owns several peers; the response lists them under summary.connections and defaults to the longest-lived one unless peerId is given. Requires the \"read\" permission on meetings.
|
|
119696
|
+
* @summary Get a meeting session participant\'s call-quality report
|
|
119697
|
+
* @param {string} sessionId The session identifier
|
|
119698
|
+
* @param {string} participantId The participant identifier
|
|
119699
|
+
* @param {string} [peerId] Filter by peerId
|
|
119700
|
+
* @param {*} [options] Override http request option.
|
|
119701
|
+
* @throws {RequiredError}
|
|
119702
|
+
*/
|
|
119703
|
+
getMeetingSessionParticipantReport: async (sessionId: string, participantId: string, peerId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
119704
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
119705
|
+
assertParamExists('getMeetingSessionParticipantReport', 'sessionId', sessionId)
|
|
119706
|
+
// verify required parameter 'participantId' is not null or undefined
|
|
119707
|
+
assertParamExists('getMeetingSessionParticipantReport', 'participantId', participantId)
|
|
119708
|
+
const localVarPath = `/meetings/sessions/{sessionId}/participants/{participantId}/report`
|
|
119709
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)))
|
|
119710
|
+
.replace('{participantId}', encodeURIComponent(String(participantId)));
|
|
119711
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
119712
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
119713
|
+
let baseOptions;
|
|
119714
|
+
if (configuration) {
|
|
119715
|
+
baseOptions = configuration.baseOptions;
|
|
119716
|
+
}
|
|
119717
|
+
|
|
119718
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
119719
|
+
const localVarHeaderParameter = {} as any;
|
|
119720
|
+
const localVarQueryParameter = {} as any;
|
|
119721
|
+
|
|
119722
|
+
// authentication ApiKeyAuth required
|
|
119723
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
119724
|
+
|
|
119725
|
+
// authentication OrganizationId required
|
|
119726
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
119727
|
+
|
|
119728
|
+
if (peerId !== undefined) {
|
|
119729
|
+
localVarQueryParameter['peerId'] = peerId;
|
|
119730
|
+
}
|
|
119731
|
+
|
|
119732
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
119733
|
+
|
|
119734
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
119735
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
119736
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
119737
|
+
|
|
119738
|
+
return {
|
|
119739
|
+
url: toPathString(localVarUrlObj),
|
|
119740
|
+
options: localVarRequestOptions,
|
|
119741
|
+
};
|
|
119742
|
+
},
|
|
119522
119743
|
/**
|
|
119523
119744
|
* Returns a paginated list of participants who joined the given meeting session, with each participant\'s linked account attached when they are a known user, supports search and requires the \"read\" permission on meetings.
|
|
119524
119745
|
* @summary List a meeting session\'s participants
|
|
@@ -119782,6 +120003,21 @@ export const MeetingsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
119782
120003
|
const localVarOperationServerBasePath = operationServerMap['MeetingsSessionsApi.getMeetingSessionParticipant']?.[localVarOperationServerIndex]?.url;
|
|
119783
120004
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
119784
120005
|
},
|
|
120006
|
+
/**
|
|
120007
|
+
* Returns the call-quality report for one of a participant\'s connections (peers) within a meeting session: device, browser, location and connectivity details, per-stream quality roll-ups (audio, video and screenshare, sent and received), a plain-language list of detected issues, downsampled time series for charting, and a timeline of connection and device events. A participant who reconnected owns several peers; the response lists them under summary.connections and defaults to the longest-lived one unless peerId is given. Requires the \"read\" permission on meetings.
|
|
120008
|
+
* @summary Get a meeting session participant\'s call-quality report
|
|
120009
|
+
* @param {string} sessionId The session identifier
|
|
120010
|
+
* @param {string} participantId The participant identifier
|
|
120011
|
+
* @param {string} [peerId] Filter by peerId
|
|
120012
|
+
* @param {*} [options] Override http request option.
|
|
120013
|
+
* @throws {RequiredError}
|
|
120014
|
+
*/
|
|
120015
|
+
async getMeetingSessionParticipantReport(sessionId: string, participantId: string, peerId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMeetingSessionParticipantReport200Response>> {
|
|
120016
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMeetingSessionParticipantReport(sessionId, participantId, peerId, options);
|
|
120017
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
120018
|
+
const localVarOperationServerBasePath = operationServerMap['MeetingsSessionsApi.getMeetingSessionParticipantReport']?.[localVarOperationServerIndex]?.url;
|
|
120019
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
120020
|
+
},
|
|
119785
120021
|
/**
|
|
119786
120022
|
* Returns a paginated list of participants who joined the given meeting session, with each participant\'s linked account attached when they are a known user, supports search and requires the \"read\" permission on meetings.
|
|
119787
120023
|
* @summary List a meeting session\'s participants
|
|
@@ -119891,6 +120127,16 @@ export const MeetingsSessionsApiFactory = function (configuration?: Configuratio
|
|
|
119891
120127
|
getMeetingSessionParticipant(requestParameters: MeetingsSessionsApiGetMeetingSessionParticipantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetMeetingSessionParticipant200Response> {
|
|
119892
120128
|
return localVarFp.getMeetingSessionParticipant(requestParameters.sessionId, requestParameters.participantId, options).then((request) => request(axios, basePath));
|
|
119893
120129
|
},
|
|
120130
|
+
/**
|
|
120131
|
+
* Returns the call-quality report for one of a participant\'s connections (peers) within a meeting session: device, browser, location and connectivity details, per-stream quality roll-ups (audio, video and screenshare, sent and received), a plain-language list of detected issues, downsampled time series for charting, and a timeline of connection and device events. A participant who reconnected owns several peers; the response lists them under summary.connections and defaults to the longest-lived one unless peerId is given. Requires the \"read\" permission on meetings.
|
|
120132
|
+
* @summary Get a meeting session participant\'s call-quality report
|
|
120133
|
+
* @param {MeetingsSessionsApiGetMeetingSessionParticipantReportRequest} requestParameters Request parameters.
|
|
120134
|
+
* @param {*} [options] Override http request option.
|
|
120135
|
+
* @throws {RequiredError}
|
|
120136
|
+
*/
|
|
120137
|
+
getMeetingSessionParticipantReport(requestParameters: MeetingsSessionsApiGetMeetingSessionParticipantReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetMeetingSessionParticipantReport200Response> {
|
|
120138
|
+
return localVarFp.getMeetingSessionParticipantReport(requestParameters.sessionId, requestParameters.participantId, requestParameters.peerId, options).then((request) => request(axios, basePath));
|
|
120139
|
+
},
|
|
119894
120140
|
/**
|
|
119895
120141
|
* Returns a paginated list of participants who joined the given meeting session, with each participant\'s linked account attached when they are a known user, supports search and requires the \"read\" permission on meetings.
|
|
119896
120142
|
* @summary List a meeting session\'s participants
|
|
@@ -119979,6 +120225,26 @@ export interface MeetingsSessionsApiGetMeetingSessionParticipantRequest {
|
|
|
119979
120225
|
readonly participantId: string
|
|
119980
120226
|
}
|
|
119981
120227
|
|
|
120228
|
+
/**
|
|
120229
|
+
* Request parameters for getMeetingSessionParticipantReport operation in MeetingsSessionsApi.
|
|
120230
|
+
*/
|
|
120231
|
+
export interface MeetingsSessionsApiGetMeetingSessionParticipantReportRequest {
|
|
120232
|
+
/**
|
|
120233
|
+
* The session identifier
|
|
120234
|
+
*/
|
|
120235
|
+
readonly sessionId: string
|
|
120236
|
+
|
|
120237
|
+
/**
|
|
120238
|
+
* The participant identifier
|
|
120239
|
+
*/
|
|
120240
|
+
readonly participantId: string
|
|
120241
|
+
|
|
120242
|
+
/**
|
|
120243
|
+
* Filter by peerId
|
|
120244
|
+
*/
|
|
120245
|
+
readonly peerId?: string
|
|
120246
|
+
}
|
|
120247
|
+
|
|
119982
120248
|
/**
|
|
119983
120249
|
* Request parameters for getMeetingSessionParticipants operation in MeetingsSessionsApi.
|
|
119984
120250
|
*/
|
|
@@ -120107,6 +120373,17 @@ export class MeetingsSessionsApi extends BaseAPI {
|
|
|
120107
120373
|
return MeetingsSessionsApiFp(this.configuration).getMeetingSessionParticipant(requestParameters.sessionId, requestParameters.participantId, options).then((request) => request(this.axios, this.basePath));
|
|
120108
120374
|
}
|
|
120109
120375
|
|
|
120376
|
+
/**
|
|
120377
|
+
* Returns the call-quality report for one of a participant\'s connections (peers) within a meeting session: device, browser, location and connectivity details, per-stream quality roll-ups (audio, video and screenshare, sent and received), a plain-language list of detected issues, downsampled time series for charting, and a timeline of connection and device events. A participant who reconnected owns several peers; the response lists them under summary.connections and defaults to the longest-lived one unless peerId is given. Requires the \"read\" permission on meetings.
|
|
120378
|
+
* @summary Get a meeting session participant\'s call-quality report
|
|
120379
|
+
* @param {MeetingsSessionsApiGetMeetingSessionParticipantReportRequest} requestParameters Request parameters.
|
|
120380
|
+
* @param {*} [options] Override http request option.
|
|
120381
|
+
* @throws {RequiredError}
|
|
120382
|
+
*/
|
|
120383
|
+
public getMeetingSessionParticipantReport(requestParameters: MeetingsSessionsApiGetMeetingSessionParticipantReportRequest, options?: RawAxiosRequestConfig) {
|
|
120384
|
+
return MeetingsSessionsApiFp(this.configuration).getMeetingSessionParticipantReport(requestParameters.sessionId, requestParameters.participantId, requestParameters.peerId, options).then((request) => request(this.axios, this.basePath));
|
|
120385
|
+
}
|
|
120386
|
+
|
|
120110
120387
|
/**
|
|
120111
120388
|
* Returns a paginated list of participants who joined the given meeting session, with each participant\'s linked account attached when they are a known user, supports search and requires the \"read\" permission on meetings.
|
|
120112
120389
|
* @summary List a meeting session\'s participants
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.7.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.7.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Connected Admin API
|
|
4
4
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 11.
|
|
6
|
+
* The version of the OpenAPI document: 11.7.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|