@connectedxm/admin-sdk 11.6.0 → 11.8.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 +30 -9
- package/AdminApi.ts +3 -3
- package/README.md +2 -2
- package/api.ts +544 -113
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/AdminApi.d.ts +2 -2
- package/dist/AdminApi.js +1 -1
- package/dist/api.d.ts +402 -102
- package/dist/api.js +304 -54
- 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/AdminApi.d.ts +2 -2
- package/dist/esm/AdminApi.js +2 -2
- package/dist/esm/api.d.ts +402 -102
- package/dist/esm/api.js +276 -26
- 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/EventPassChange.md +38 -0
- package/docs/{EventsPasschangewebhooksApi.md → EventsPasschangesApi.md} +71 -10
- package/docs/GetEventPassChanges200Response.md +24 -0
- 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/docs/PassChangeLogType.md +22 -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
|
@@ -1,12 +1,13 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventsPasschangesApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addEventPassChangeWebhook**](#addeventpasschangewebhook) | **POST** /events/{eventId}/
|
|
8
|
-
|[**getEventPassChangeWebhooks**](#geteventpasschangewebhooks) | **GET** /events/{eventId}/
|
|
9
|
-
|[**
|
|
7
|
+
|[**addEventPassChangeWebhook**](#addeventpasschangewebhook) | **POST** /events/{eventId}/passChanges/webhooks/{webhookId} | Connect a webhook to an event\'s pass change log|
|
|
8
|
+
|[**getEventPassChangeWebhooks**](#geteventpasschangewebhooks) | **GET** /events/{eventId}/passChanges/webhooks | List an event\'s pass change log webhooks|
|
|
9
|
+
|[**getEventPassChanges**](#geteventpasschanges) | **GET** /events/{eventId}/passChanges | Poll an event\'s pass changes|
|
|
10
|
+
|[**removeEventPassChangeWebhook**](#removeeventpasschangewebhook) | **DELETE** /events/{eventId}/passChanges/webhooks/{webhookId} | Disconnect a webhook from an event\'s pass change log|
|
|
10
11
|
|
|
11
12
|
# **addEventPassChangeWebhook**
|
|
12
13
|
> AddEventPassChangeWebhook200Response addEventPassChangeWebhook()
|
|
@@ -17,12 +18,12 @@ Connects the specified webhook so it receives the event\'s pass change log rows,
|
|
|
17
18
|
|
|
18
19
|
```typescript
|
|
19
20
|
import {
|
|
20
|
-
|
|
21
|
+
EventsPasschangesApi,
|
|
21
22
|
Configuration
|
|
22
23
|
} from '@connectedxm/admin-sdk';
|
|
23
24
|
|
|
24
25
|
const configuration = new Configuration();
|
|
25
|
-
const apiInstance = new
|
|
26
|
+
const apiInstance = new EventsPasschangesApi(configuration);
|
|
26
27
|
|
|
27
28
|
let eventId: string; //The event identifier (default to undefined)
|
|
28
29
|
let webhookId: string; //The webhook identifier (default to undefined)
|
|
@@ -71,12 +72,12 @@ Returns a paginated list of the webhooks connected to the given event\'s pass ch
|
|
|
71
72
|
|
|
72
73
|
```typescript
|
|
73
74
|
import {
|
|
74
|
-
|
|
75
|
+
EventsPasschangesApi,
|
|
75
76
|
Configuration
|
|
76
77
|
} from '@connectedxm/admin-sdk';
|
|
77
78
|
|
|
78
79
|
const configuration = new Configuration();
|
|
79
|
-
const apiInstance = new
|
|
80
|
+
const apiInstance = new EventsPasschangesApi(configuration);
|
|
80
81
|
|
|
81
82
|
let eventId: string; //The event identifier (default to undefined)
|
|
82
83
|
let page: number; //Page number (optional) (default to 1)
|
|
@@ -118,6 +119,66 @@ const { status, data } = await apiInstance.getEventPassChangeWebhooks(
|
|
|
118
119
|
- **Accept**: application/json
|
|
119
120
|
|
|
120
121
|
|
|
122
|
+
### HTTP response details
|
|
123
|
+
| Status code | Description | Response headers |
|
|
124
|
+
|-------------|-------------|------------------|
|
|
125
|
+
|**200** | Successful response | - |
|
|
126
|
+
|
|
127
|
+
[[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)
|
|
128
|
+
|
|
129
|
+
# **getEventPassChanges**
|
|
130
|
+
> GetEventPassChanges200Response getEventPassChanges()
|
|
131
|
+
|
|
132
|
+
Returns a cursor-paginated feed of the event\'s pass change log rows in ascending order; pass the last returned cursor on the next call to tail new changes. Optionally filter by subjectId or change type. Requires read permission on events.
|
|
133
|
+
|
|
134
|
+
### Example
|
|
135
|
+
|
|
136
|
+
```typescript
|
|
137
|
+
import {
|
|
138
|
+
EventsPasschangesApi,
|
|
139
|
+
Configuration
|
|
140
|
+
} from '@connectedxm/admin-sdk';
|
|
141
|
+
|
|
142
|
+
const configuration = new Configuration();
|
|
143
|
+
const apiInstance = new EventsPasschangesApi(configuration);
|
|
144
|
+
|
|
145
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
146
|
+
let subjectId: string; //Filter by subjectId (optional) (default to undefined)
|
|
147
|
+
let type: PassChangeLogType; //Filter by type (optional) (default to undefined)
|
|
148
|
+
let passId: string; //Filter by passId (optional) (default to undefined)
|
|
149
|
+
|
|
150
|
+
const { status, data } = await apiInstance.getEventPassChanges(
|
|
151
|
+
eventId,
|
|
152
|
+
subjectId,
|
|
153
|
+
type,
|
|
154
|
+
passId
|
|
155
|
+
);
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Parameters
|
|
159
|
+
|
|
160
|
+
|Name | Type | Description | Notes|
|
|
161
|
+
|------------- | ------------- | ------------- | -------------|
|
|
162
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
163
|
+
| **subjectId** | [**string**] | Filter by subjectId | (optional) defaults to undefined|
|
|
164
|
+
| **type** | **PassChangeLogType** | Filter by type | (optional) defaults to undefined|
|
|
165
|
+
| **passId** | [**string**] | Filter by passId | (optional) defaults to undefined|
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
### Return type
|
|
169
|
+
|
|
170
|
+
**GetEventPassChanges200Response**
|
|
171
|
+
|
|
172
|
+
### Authorization
|
|
173
|
+
|
|
174
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
175
|
+
|
|
176
|
+
### HTTP request headers
|
|
177
|
+
|
|
178
|
+
- **Content-Type**: Not defined
|
|
179
|
+
- **Accept**: application/json
|
|
180
|
+
|
|
181
|
+
|
|
121
182
|
### HTTP response details
|
|
122
183
|
| Status code | Description | Response headers |
|
|
123
184
|
|-------------|-------------|------------------|
|
|
@@ -134,12 +195,12 @@ Disconnects the specified webhook from the given event\'s pass change log and re
|
|
|
134
195
|
|
|
135
196
|
```typescript
|
|
136
197
|
import {
|
|
137
|
-
|
|
198
|
+
EventsPasschangesApi,
|
|
138
199
|
Configuration
|
|
139
200
|
} from '@connectedxm/admin-sdk';
|
|
140
201
|
|
|
141
202
|
const configuration = new Configuration();
|
|
142
|
-
const apiInstance = new
|
|
203
|
+
const apiInstance = new EventsPasschangesApi(configuration);
|
|
143
204
|
|
|
144
205
|
let eventId: string; //The event identifier (default to undefined)
|
|
145
206
|
let webhookId: string; //The webhook identifier (default to undefined)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# GetEventPassChanges200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**Array<EventPassChange>**](EventPassChange.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GetEventPassChanges200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: GetEventPassChanges200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# GetMeetingSessionParticipantReport200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**MeetingSessionParticipantReport**](MeetingSessionParticipantReport.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GetMeetingSessionParticipantReport200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: GetMeetingSessionParticipantReport200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -18,8 +18,6 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**role** | **string** | | [default to undefined]
|
|
19
19
|
**preset_name** | **string** | | [default to undefined]
|
|
20
20
|
**account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
|
|
21
|
-
**peer_stats** | [**MeetingSessionParticipantAllOfPeerStats**](MeetingSessionParticipantAllOfPeerStats.md) | | [optional] [default to undefined]
|
|
22
|
-
**quality_stats** | [**Array<MeetingSessionParticipantAllOfQualityStats>**](MeetingSessionParticipantAllOfQualityStats.md) | | [optional] [default to undefined]
|
|
23
21
|
|
|
24
22
|
## Example
|
|
25
23
|
|
|
@@ -40,8 +38,6 @@ const instance: MeetingSessionParticipant = {
|
|
|
40
38
|
role,
|
|
41
39
|
preset_name,
|
|
42
40
|
account,
|
|
43
|
-
peer_stats,
|
|
44
|
-
quality_stats,
|
|
45
41
|
};
|
|
46
42
|
```
|
|
47
43
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# MeetingSessionParticipantReport
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**participant** | [**BaseMeetingSessionParticipant**](BaseMeetingSessionParticipant.md) | | [default to undefined]
|
|
9
|
+
**summary** | [**MeetingSessionReportSummary**](MeetingSessionReportSummary.md) | | [default to undefined]
|
|
10
|
+
**series** | [**MeetingSessionReportSeriesMap**](MeetingSessionReportSeriesMap.md) | | [default to undefined]
|
|
11
|
+
**events** | [**Array<MeetingSessionReportEvent>**](MeetingSessionReportEvent.md) | | [default to undefined]
|
|
12
|
+
**devices** | [**Array<MeetingSessionReportDevice>**](MeetingSessionReportDevice.md) | | [default to undefined]
|
|
13
|
+
**meta** | [**MeetingSessionParticipantReportMeta**](MeetingSessionParticipantReportMeta.md) | | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { MeetingSessionParticipantReport } from '@connectedxm/admin-sdk';
|
|
19
|
+
|
|
20
|
+
const instance: MeetingSessionParticipantReport = {
|
|
21
|
+
participant,
|
|
22
|
+
summary,
|
|
23
|
+
series,
|
|
24
|
+
events,
|
|
25
|
+
devices,
|
|
26
|
+
meta,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# MeetingSessionParticipantReportMeta
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**fetched_at** | **string** | | [default to undefined]
|
|
9
|
+
**truncated** | **boolean** | | [default to undefined]
|
|
10
|
+
**peer_id** | **string** | | [default to undefined]
|
|
11
|
+
**has_data** | **boolean** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { MeetingSessionParticipantReportMeta } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: MeetingSessionParticipantReportMeta = {
|
|
19
|
+
fetched_at,
|
|
20
|
+
truncated,
|
|
21
|
+
peer_id,
|
|
22
|
+
has_data,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# MeetingSessionReportConnection
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**peer_id** | **string** | | [default to undefined]
|
|
9
|
+
**joined_at** | **string** | | [default to undefined]
|
|
10
|
+
**left_at** | **string** | | [default to undefined]
|
|
11
|
+
**reconnects** | **number** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { MeetingSessionReportConnection } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: MeetingSessionReportConnection = {
|
|
19
|
+
peer_id,
|
|
20
|
+
joined_at,
|
|
21
|
+
left_at,
|
|
22
|
+
reconnects,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# MeetingSessionReportDevice
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**t** | **string** | | [default to undefined]
|
|
9
|
+
**kind** | **string** | | [default to undefined]
|
|
10
|
+
**action** | **string** | | [default to undefined]
|
|
11
|
+
**label** | **string** | | [default to undefined]
|
|
12
|
+
**device_id** | **string** | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { MeetingSessionReportDevice } from '@connectedxm/admin-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: MeetingSessionReportDevice = {
|
|
20
|
+
t,
|
|
21
|
+
kind,
|
|
22
|
+
action,
|
|
23
|
+
label,
|
|
24
|
+
device_id,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# MeetingSessionReportDistribution
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**avg** | **number** | | [default to undefined]
|
|
9
|
+
**p50** | **number** | | [default to undefined]
|
|
10
|
+
**p75** | **number** | | [default to undefined]
|
|
11
|
+
**p90** | **number** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { MeetingSessionReportDistribution } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: MeetingSessionReportDistribution = {
|
|
19
|
+
avg,
|
|
20
|
+
p50,
|
|
21
|
+
p75,
|
|
22
|
+
p90,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# MeetingSessionReportEvent
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**t** | **string** | | [default to undefined]
|
|
9
|
+
**kind** | **string** | | [default to undefined]
|
|
10
|
+
**name** | **string** | | [default to undefined]
|
|
11
|
+
**detail** | **{ [key: string]: any; }** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { MeetingSessionReportEvent } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: MeetingSessionReportEvent = {
|
|
19
|
+
t,
|
|
20
|
+
kind,
|
|
21
|
+
name,
|
|
22
|
+
detail,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# MeetingSessionReportIssue
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | [**MeetingSessionReportIssueCode**](MeetingSessionReportIssueCode.md) | | [default to undefined]
|
|
9
|
+
**severity** | **string** | | [default to undefined]
|
|
10
|
+
**stream** | [**MeetingSessionStreamKey**](MeetingSessionStreamKey.md) | | [optional] [default to undefined]
|
|
11
|
+
**value** | **number** | | [default to undefined]
|
|
12
|
+
**label** | **string** | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { MeetingSessionReportIssue } from '@connectedxm/admin-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: MeetingSessionReportIssue = {
|
|
20
|
+
code,
|
|
21
|
+
severity,
|
|
22
|
+
stream,
|
|
23
|
+
value,
|
|
24
|
+
label,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# MeetingSessionReportIssueCode
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `LowMos` (value: `'low_mos'`)
|
|
7
|
+
|
|
8
|
+
* `HighPacketLoss` (value: `'high_packet_loss'`)
|
|
9
|
+
|
|
10
|
+
* `HighRtt` (value: `'high_rtt'`)
|
|
11
|
+
|
|
12
|
+
* `AudioGlitches` (value: `'audio_glitches'`)
|
|
13
|
+
|
|
14
|
+
* `BandwidthLimited` (value: `'bandwidth_limited'`)
|
|
15
|
+
|
|
16
|
+
* `CpuLimited` (value: `'cpu_limited'`)
|
|
17
|
+
|
|
18
|
+
* `NoVideo` (value: `'no_video'`)
|
|
19
|
+
|
|
20
|
+
* `PoorResolution` (value: `'poor_resolution'`)
|
|
21
|
+
|
|
22
|
+
* `Lag` (value: `'lag'`)
|
|
23
|
+
|
|
24
|
+
* `HighJitterBuffer` (value: `'high_jitter_buffer'`)
|
|
25
|
+
|
|
26
|
+
* `RelayOnly` (value: `'relay_only'`)
|
|
27
|
+
|
|
28
|
+
* `TurnUnreachable` (value: `'turn_unreachable'`)
|
|
29
|
+
|
|
30
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# MeetingSessionReportLatency
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**avg** | **number** | | [default to undefined]
|
|
9
|
+
**ge_100** | **number** | | [default to undefined]
|
|
10
|
+
**ge_250** | **number** | | [default to undefined]
|
|
11
|
+
**ge_500** | **number** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { MeetingSessionReportLatency } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: MeetingSessionReportLatency = {
|
|
19
|
+
avg,
|
|
20
|
+
ge_100,
|
|
21
|
+
ge_250,
|
|
22
|
+
ge_500,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# MeetingSessionReportPacketLoss
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**avg** | **number** | | [default to undefined]
|
|
9
|
+
**ge_5** | **number** | | [default to undefined]
|
|
10
|
+
**ge_10** | **number** | | [default to undefined]
|
|
11
|
+
**ge_25** | **number** | | [default to undefined]
|
|
12
|
+
**ge_50** | **number** | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { MeetingSessionReportPacketLoss } from '@connectedxm/admin-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: MeetingSessionReportPacketLoss = {
|
|
20
|
+
avg,
|
|
21
|
+
ge_5,
|
|
22
|
+
ge_10,
|
|
23
|
+
ge_25,
|
|
24
|
+
ge_50,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# MeetingSessionReportPoint
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**t** | **string** | | [default to undefined]
|
|
9
|
+
**mos** | **number** | | [default to undefined]
|
|
10
|
+
**packets_lost** | **number** | | [default to undefined]
|
|
11
|
+
**jitter_ms** | **number** | | [default to undefined]
|
|
12
|
+
**rtt_ms** | **number** | | [optional] [default to undefined]
|
|
13
|
+
**jitter_buffer_ms** | **number** | | [optional] [default to undefined]
|
|
14
|
+
**bitrate_kbps** | **number** | | [default to undefined]
|
|
15
|
+
**fps** | **number** | | [optional] [default to undefined]
|
|
16
|
+
**width** | **number** | | [optional] [default to undefined]
|
|
17
|
+
**height** | **number** | | [optional] [default to undefined]
|
|
18
|
+
**frames_dropped** | **number** | | [optional] [default to undefined]
|
|
19
|
+
**limitation** | **string** | | [optional] [default to undefined]
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { MeetingSessionReportPoint } from '@connectedxm/admin-sdk';
|
|
25
|
+
|
|
26
|
+
const instance: MeetingSessionReportPoint = {
|
|
27
|
+
t,
|
|
28
|
+
mos,
|
|
29
|
+
packets_lost,
|
|
30
|
+
jitter_ms,
|
|
31
|
+
rtt_ms,
|
|
32
|
+
jitter_buffer_ms,
|
|
33
|
+
bitrate_kbps,
|
|
34
|
+
fps,
|
|
35
|
+
width,
|
|
36
|
+
height,
|
|
37
|
+
frames_dropped,
|
|
38
|
+
limitation,
|
|
39
|
+
};
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# MeetingSessionReportSeries
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**step_seconds** | **number** | | [default to undefined]
|
|
9
|
+
**downsampled_from** | **number** | | [default to undefined]
|
|
10
|
+
**points** | [**Array<MeetingSessionReportPoint>**](MeetingSessionReportPoint.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { MeetingSessionReportSeries } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: MeetingSessionReportSeries = {
|
|
18
|
+
step_seconds,
|
|
19
|
+
downsampled_from,
|
|
20
|
+
points,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# MeetingSessionReportSeriesMap
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**audio_out** | [**MeetingSessionReportSeries**](MeetingSessionReportSeries.md) | | [optional] [default to undefined]
|
|
9
|
+
**audio_in** | [**MeetingSessionReportSeries**](MeetingSessionReportSeries.md) | | [optional] [default to undefined]
|
|
10
|
+
**video_out** | [**MeetingSessionReportSeries**](MeetingSessionReportSeries.md) | | [optional] [default to undefined]
|
|
11
|
+
**video_in** | [**MeetingSessionReportSeries**](MeetingSessionReportSeries.md) | | [optional] [default to undefined]
|
|
12
|
+
**screenshare_audio_out** | [**MeetingSessionReportSeries**](MeetingSessionReportSeries.md) | | [optional] [default to undefined]
|
|
13
|
+
**screenshare_audio_in** | [**MeetingSessionReportSeries**](MeetingSessionReportSeries.md) | | [optional] [default to undefined]
|
|
14
|
+
**screenshare_video_out** | [**MeetingSessionReportSeries**](MeetingSessionReportSeries.md) | | [optional] [default to undefined]
|
|
15
|
+
**screenshare_video_in** | [**MeetingSessionReportSeries**](MeetingSessionReportSeries.md) | | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { MeetingSessionReportSeriesMap } from '@connectedxm/admin-sdk';
|
|
21
|
+
|
|
22
|
+
const instance: MeetingSessionReportSeriesMap = {
|
|
23
|
+
audio_out,
|
|
24
|
+
audio_in,
|
|
25
|
+
video_out,
|
|
26
|
+
video_in,
|
|
27
|
+
screenshare_audio_out,
|
|
28
|
+
screenshare_audio_in,
|
|
29
|
+
screenshare_video_out,
|
|
30
|
+
screenshare_video_in,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# MeetingSessionReportStreams
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**audio_out** | [**MeetingSessionStreamSummary**](MeetingSessionStreamSummary.md) | | [optional] [default to undefined]
|
|
9
|
+
**audio_in** | [**MeetingSessionStreamSummary**](MeetingSessionStreamSummary.md) | | [optional] [default to undefined]
|
|
10
|
+
**video_out** | [**MeetingSessionStreamSummary**](MeetingSessionStreamSummary.md) | | [optional] [default to undefined]
|
|
11
|
+
**video_in** | [**MeetingSessionStreamSummary**](MeetingSessionStreamSummary.md) | | [optional] [default to undefined]
|
|
12
|
+
**screenshare_audio_out** | [**MeetingSessionStreamSummary**](MeetingSessionStreamSummary.md) | | [optional] [default to undefined]
|
|
13
|
+
**screenshare_audio_in** | [**MeetingSessionStreamSummary**](MeetingSessionStreamSummary.md) | | [optional] [default to undefined]
|
|
14
|
+
**screenshare_video_out** | [**MeetingSessionStreamSummary**](MeetingSessionStreamSummary.md) | | [optional] [default to undefined]
|
|
15
|
+
**screenshare_video_in** | [**MeetingSessionStreamSummary**](MeetingSessionStreamSummary.md) | | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { MeetingSessionReportStreams } from '@connectedxm/admin-sdk';
|
|
21
|
+
|
|
22
|
+
const instance: MeetingSessionReportStreams = {
|
|
23
|
+
audio_out,
|
|
24
|
+
audio_in,
|
|
25
|
+
video_out,
|
|
26
|
+
video_in,
|
|
27
|
+
screenshare_audio_out,
|
|
28
|
+
screenshare_audio_in,
|
|
29
|
+
screenshare_video_out,
|
|
30
|
+
screenshare_video_in,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# MeetingSessionReportSummary
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**connections** | [**Array<MeetingSessionReportConnection>**](MeetingSessionReportConnection.md) | | [default to undefined]
|
|
9
|
+
**platform** | [**MeetingSessionReportSummaryPlatform**](MeetingSessionReportSummaryPlatform.md) | | [default to undefined]
|
|
10
|
+
**device** | [**MeetingSessionReportSummaryDevice**](MeetingSessionReportSummaryDevice.md) | | [default to undefined]
|
|
11
|
+
**location** | [**MeetingSessionReportSummaryLocation**](MeetingSessionReportSummaryLocation.md) | | [default to undefined]
|
|
12
|
+
**connectivity** | [**MeetingSessionReportSummaryConnectivity**](MeetingSessionReportSummaryConnectivity.md) | | [default to undefined]
|
|
13
|
+
**streams** | [**MeetingSessionReportStreams**](MeetingSessionReportStreams.md) | | [default to undefined]
|
|
14
|
+
**issues** | [**Array<MeetingSessionReportIssue>**](MeetingSessionReportIssue.md) | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { MeetingSessionReportSummary } from '@connectedxm/admin-sdk';
|
|
20
|
+
|
|
21
|
+
const instance: MeetingSessionReportSummary = {
|
|
22
|
+
connections,
|
|
23
|
+
platform,
|
|
24
|
+
device,
|
|
25
|
+
location,
|
|
26
|
+
connectivity,
|
|
27
|
+
streams,
|
|
28
|
+
issues,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|