@connectedxm/admin-sdk 11.5.2 → 11.7.0

package/docs/MeetingSessionStreamKey.md

@@ -0,0 +1,22 @@
+# MeetingSessionStreamKey
+
+
+## Enum
+
+* `AudioOut` (value: `'audio_out'`)
+
+* `AudioIn` (value: `'audio_in'`)
+
+* `VideoOut` (value: `'video_out'`)
+
+* `VideoIn` (value: `'video_in'`)
+
+* `ScreenshareAudioOut` (value: `'screenshare_audio_out'`)
+
+* `ScreenshareAudioIn` (value: `'screenshare_audio_in'`)
+
+* `ScreenshareVideoOut` (value: `'screenshare_video_out'`)
+
+* `ScreenshareVideoIn` (value: `'screenshare_video_in'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MeetingSessionStreamSummary.md

@@ -0,0 +1,32 @@
+# MeetingSessionStreamSummary
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sample_count** | **number** |  | [default to undefined]
+**mos** | [**MeetingSessionReportDistribution**](MeetingSessionReportDistribution.md) |  | [default to undefined]
+**packet_loss** | [**MeetingSessionReportPacketLoss**](MeetingSessionReportPacketLoss.md) |  | [default to undefined]
+**rtt** | [**MeetingSessionReportLatency**](MeetingSessionReportLatency.md) |  | [optional] [default to undefined]
+**jitter_buffer** | [**MeetingSessionReportLatency**](MeetingSessionReportLatency.md) |  | [optional] [default to undefined]
+**glitch_count** | **number** |  | [optional] [default to undefined]
+**video** | [**MeetingSessionStreamVideoSummary**](MeetingSessionStreamVideoSummary.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MeetingSessionStreamSummary } from '@connectedxm/admin-sdk';
+
+const instance: MeetingSessionStreamSummary = {
+    sample_count,
+    mos,
+    packet_loss,
+    rtt,
+    jitter_buffer,
+    glitch_count,
+    video,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MeetingSessionStreamVideoSummary.md

@@ -0,0 +1,26 @@
+# MeetingSessionStreamVideoSummary
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fps** | [**MeetingSessionReportDistribution**](MeetingSessionReportDistribution.md) |  | [default to undefined]
+**width** | [**MeetingSessionReportDistribution**](MeetingSessionReportDistribution.md) |  | [default to undefined]
+**limitation** | [**MeetingSessionStreamVideoSummaryLimitation**](MeetingSessionStreamVideoSummaryLimitation.md) |  | [optional] [default to undefined]
+**issues** | [**MeetingSessionStreamVideoSummaryIssues**](MeetingSessionStreamVideoSummaryIssues.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MeetingSessionStreamVideoSummary } from '@connectedxm/admin-sdk';
+
+const instance: MeetingSessionStreamVideoSummary = {
+    fps,
+    width,
+    limitation,
+    issues,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MeetingSessionStreamVideoSummaryIssues.md

@@ -0,0 +1,28 @@
+# MeetingSessionStreamVideoSummaryIssues
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bandwidth_fraction** | **number** |  | [default to undefined]
+**cpu_fraction** | **number** |  | [default to undefined]
+**no_video_fraction** | **number** |  | [default to undefined]
+**poor_resolution_fraction** | **number** |  | [default to undefined]
+**lag_fraction** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MeetingSessionStreamVideoSummaryIssues } from '@connectedxm/admin-sdk';
+
+const instance: MeetingSessionStreamVideoSummaryIssues = {
+    bandwidth_fraction,
+    cpu_fraction,
+    no_video_fraction,
+    poor_resolution_fraction,
+    lag_fraction,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MeetingSessionStreamVideoSummaryLimitation.md

@@ -0,0 +1,26 @@
+# MeetingSessionStreamVideoSummaryLimitation
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cpu** | **number** |  | [default to undefined]
+**bandwidth** | **number** |  | [default to undefined]
+**other** | **number** |  | [default to undefined]
+**resolution_changes** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MeetingSessionStreamVideoSummaryLimitation } from '@connectedxm/admin-sdk';
+
+const instance: MeetingSessionStreamVideoSummaryLimitation = {
+    cpu,
+    bandwidth,
+    other,
+    resolution_changes,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MeetingsSessionsApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://admin-api.connected.dev*
 |[**getMeetingSession**](#getmeetingsession) | **GET** /meetings/sessions/{sessionId} | Get a meeting session|
 |[**getMeetingSessionMessages**](#getmeetingsessionmessages) | **GET** /meetings/sessions/{sessionId}/messages | Download a meeting session\'s chat messages|
 |[**getMeetingSessionParticipant**](#getmeetingsessionparticipant) | **GET** /meetings/sessions/{sessionId}/participants/{participantId} | Get a meeting session participant|
+|[**getMeetingSessionParticipantReport**](#getmeetingsessionparticipantreport) | **GET** /meetings/sessions/{sessionId}/participants/{participantId}/report | Get a meeting session participant\'s call-quality report|
 |[**getMeetingSessionParticipants**](#getmeetingsessionparticipants) | **GET** /meetings/sessions/{sessionId}/participants | List a meeting session\'s participants|
 |[**getMeetingSessionSummary**](#getmeetingsessionsummary) | **GET** /meetings/sessions/{sessionId}/summary | Get a meeting session\'s AI-generated summary|
 |[**getMeetingSessionTranscript**](#getmeetingsessiontranscript) | **GET** /meetings/sessions/{sessionId}/transcript | Download a meeting session\'s transcript|
@@ -213,6 +214,63 @@ const { status, data } = await apiInstance.getMeetingSessionParticipant(
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getMeetingSessionParticipantReport**
+> GetMeetingSessionParticipantReport200Response getMeetingSessionParticipantReport()
+
+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.
+
+### Example
+
+```typescript
+import {
+    MeetingsSessionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsSessionsApi(configuration);
+
+let sessionId: string; //The session identifier (default to undefined)
+let participantId: string; //The participant identifier (default to undefined)
+let peerId: string; //Filter by peerId (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getMeetingSessionParticipantReport(
+    sessionId,
+    participantId,
+    peerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **participantId** | [**string**] | The participant identifier | defaults to undefined|
+| **peerId** | [**string**] | Filter by peerId | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetMeetingSessionParticipantReport200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/admin-sdk",
-  "version": "11.5.2",
+  "version": "11.7.0",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {

package/docs/MeetingSessionParticipantAllOfAudioStats.md

@@ -1,28 +0,0 @@
-# MeetingSessionParticipantAllOfAudioStats
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**timestamp** | **string** |  | [default to undefined]
-**concealment_events** | **number** |  | [optional] [default to undefined]
-**packets_lost** | **number** |  | [optional] [default to undefined]
-**jitter** | **number** |  | [optional] [default to undefined]
-**quality** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { MeetingSessionParticipantAllOfAudioStats } from '@connectedxm/admin-sdk';
-
-const instance: MeetingSessionParticipantAllOfAudioStats = {
-    timestamp,
-    concealment_events,
-    packets_lost,
-    jitter,
-    quality,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MeetingSessionParticipantAllOfPeerStats.md

@@ -1,30 +0,0 @@
-# MeetingSessionParticipantAllOfPeerStats
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**config** | **string** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-**device_info** | [**MeetingSessionParticipantAllOfPeerStatsDeviceInfo**](MeetingSessionParticipantAllOfPeerStatsDeviceInfo.md) |  | [optional] [default to undefined]
-**events** | [**Array<MeetingSessionParticipantAllOfPeerStatsEvents>**](MeetingSessionParticipantAllOfPeerStatsEvents.md) |  | [optional] [default to undefined]
-**ip_information** | [**MeetingSessionParticipantAllOfPeerStatsIpInformation**](MeetingSessionParticipantAllOfPeerStatsIpInformation.md) |  | [optional] [default to undefined]
-**precall_network_information** | [**MeetingSessionParticipantAllOfPeerStatsPrecallNetworkInformation**](MeetingSessionParticipantAllOfPeerStatsPrecallNetworkInformation.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { MeetingSessionParticipantAllOfPeerStats } from '@connectedxm/admin-sdk';
-
-const instance: MeetingSessionParticipantAllOfPeerStats = {
-    config,
-    status,
-    device_info,
-    events,
-    ip_information,
-    precall_network_information,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MeetingSessionParticipantAllOfPeerStatsDeviceInfo.md

@@ -1,42 +0,0 @@
-# MeetingSessionParticipantAllOfPeerStatsDeviceInfo
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**browser** | **string** |  | [optional] [default to undefined]
-**browser_version** | **string** |  | [optional] [default to undefined]
-**cpus** | **number** |  | [optional] [default to undefined]
-**engine** | **string** |  | [optional] [default to undefined]
-**is_mobile** | **boolean** |  | [optional] [default to undefined]
-**memory** | **number** |  | [optional] [default to undefined]
-**os** | **string** |  | [optional] [default to undefined]
-**os_version** | **string** |  | [optional] [default to undefined]
-**sdk_name** | **string** |  | [optional] [default to undefined]
-**sdk_version** | **string** |  | [optional] [default to undefined]
-**user_agent** | **string** |  | [optional] [default to undefined]
-**webgl_support** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { MeetingSessionParticipantAllOfPeerStatsDeviceInfo } from '@connectedxm/admin-sdk';
-
-const instance: MeetingSessionParticipantAllOfPeerStatsDeviceInfo = {
-    browser,
-    browser_version,
-    cpus,
-    engine,
-    is_mobile,
-    memory,
-    os,
-    os_version,
-    sdk_name,
-    sdk_version,
-    user_agent,
-    webgl_support,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MeetingSessionParticipantAllOfPeerStatsEvents.md

@@ -1,22 +0,0 @@
-# MeetingSessionParticipantAllOfPeerStatsEvents
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**timestamp** | **string** |  | [default to undefined]
-**type** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { MeetingSessionParticipantAllOfPeerStatsEvents } from '@connectedxm/admin-sdk';
-
-const instance: MeetingSessionParticipantAllOfPeerStatsEvents = {
-    timestamp,
-    type,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MeetingSessionParticipantAllOfPeerStatsIpInformation.md

@@ -1,34 +0,0 @@
-# MeetingSessionParticipantAllOfPeerStatsIpInformation
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**city** | **string** |  | [optional] [default to undefined]
-**country** | **string** |  | [optional] [default to undefined]
-**ip_location** | **string** |  | [optional] [default to undefined]
-**ipv4** | **string** |  | [optional] [default to undefined]
-**org** | **string** |  | [optional] [default to undefined]
-**portal** | **string** |  | [optional] [default to undefined]
-**region** | **string** |  | [optional] [default to undefined]
-**timezone** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { MeetingSessionParticipantAllOfPeerStatsIpInformation } from '@connectedxm/admin-sdk';
-
-const instance: MeetingSessionParticipantAllOfPeerStatsIpInformation = {
-    city,
-    country,
-    ip_location,
-    ipv4,
-    org,
-    portal,
-    region,
-    timezone,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MeetingSessionParticipantAllOfPeerStatsPrecallNetworkInformation.md

@@ -1,36 +0,0 @@
-# MeetingSessionParticipantAllOfPeerStatsPrecallNetworkInformation
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**backend_rtt** | **number** |  | [optional] [default to undefined]
-**turn_connectivity** | **boolean** |  | [optional] [default to undefined]
-**effective_networktype** | **string** |  | [optional] [default to undefined]
-**throughtput** | **number** |  | [optional] [default to undefined]
-**jitter** | **number** |  | [optional] [default to undefined]
-**rtt** | **number** |  | [optional] [default to undefined]
-**reflexive_connectivity** | **boolean** |  | [optional] [default to undefined]
-**relay_connectivity** | **boolean** |  | [optional] [default to undefined]
-**fractional_loss** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { MeetingSessionParticipantAllOfPeerStatsPrecallNetworkInformation } from '@connectedxm/admin-sdk';
-
-const instance: MeetingSessionParticipantAllOfPeerStatsPrecallNetworkInformation = {
-    backend_rtt,
-    turn_connectivity,
-    effective_networktype,
-    throughtput,
-    jitter,
-    rtt,
-    reflexive_connectivity,
-    relay_connectivity,
-    fractional_loss,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MeetingSessionParticipantAllOfQualityStats.md

@@ -1,38 +0,0 @@
-# MeetingSessionParticipantAllOfQualityStats
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**peer_id** | **string** |  | [default to undefined]
-**audio_bandwidth** | **number** |  | [optional] [default to undefined]
-**video_bandwidth** | **number** |  | [optional] [default to undefined]
-**average_quality** | **number** |  | [optional] [default to undefined]
-**start** | **string** |  | [optional] [default to undefined]
-**end** | **string** |  | [optional] [default to undefined]
-**audio_packet_loss** | **number** |  | [optional] [default to undefined]
-**video_packet_loss** | **number** |  | [optional] [default to undefined]
-**audio_stats** | [**Array<MeetingSessionParticipantAllOfAudioStats>**](MeetingSessionParticipantAllOfAudioStats.md) |  | [optional] [default to undefined]
-**video_stats** | [**Array<MeetingSessionParticipantAllOfVideoStats>**](MeetingSessionParticipantAllOfVideoStats.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { MeetingSessionParticipantAllOfQualityStats } from '@connectedxm/admin-sdk';
-
-const instance: MeetingSessionParticipantAllOfQualityStats = {
-    peer_id,
-    audio_bandwidth,
-    video_bandwidth,
-    average_quality,
-    start,
-    end,
-    audio_packet_loss,
-    video_packet_loss,
-    audio_stats,
-    video_stats,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MeetingSessionParticipantAllOfVideoStats.md

@@ -1,34 +0,0 @@
-# MeetingSessionParticipantAllOfVideoStats
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**timestamp** | **string** |  | [default to undefined]
-**frame_width** | **number** |  | [optional] [default to undefined]
-**frame_height** | **number** |  | [optional] [default to undefined]
-**frames_dropped** | **number** |  | [optional] [default to undefined]
-**frames_per_second** | **number** |  | [optional] [default to undefined]
-**packets_lost** | **number** |  | [optional] [default to undefined]
-**jitter** | **number** |  | [optional] [default to undefined]
-**quality** | **number** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { MeetingSessionParticipantAllOfVideoStats } from '@connectedxm/admin-sdk';
-
-const instance: MeetingSessionParticipantAllOfVideoStats = {
-    timestamp,
-    frame_width,
-    frame_height,
-    frames_dropped,
-    frames_per_second,
-    packets_lost,
-    jitter,
-    quality,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)