@connectedxm/admin-sdk 16.16.2 → 17.0.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 +1 -6
- package/AdminApi.ts +0 -3
- package/README.md +2 -2
- package/api.ts +91 -951
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/AdminApi.d.ts +1 -2
- package/dist/AdminApi.js +0 -1
- package/dist/api.d.ts +25 -482
- package/dist/api.js +51 -697
- 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 +1 -2
- package/dist/esm/AdminApi.js +1 -2
- package/dist/esm/api.d.ts +25 -482
- package/dist/esm/api.js +27 -669
- 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/MeetingCreatableType.md +10 -0
- package/docs/MeetingCreateInputs.md +1 -3
- package/docs/MeetingUpdateInputs.md +1 -3
- package/docs/MeetingsApi.md +2 -106
- package/docs/OrganizationModuleSettings.md +0 -4
- package/docs/OrganizationModuleSettingsUpdateInputs.md +0 -4
- package/docs/OrganizationModulesSettingsApi.md +1 -1
- package/docs/StreamInput.md +0 -4
- package/docs/StreamInputCreateInputs.md +0 -2
- package/docs/StreamInputUpdateInputs.md +0 -2
- package/docs/StreamsApi.md +1 -4
- package/package.json +1 -1
- package/docs/GetLivestream200Response.md +0 -24
- package/docs/GetLivestreamSessions200Response.md +0 -26
- package/docs/GetLivestreams200Response.md +0 -26
- package/docs/Livestream.md +0 -38
- package/docs/LivestreamSession.md +0 -36
- package/docs/MeetingsLivestreamsApi.md +0 -340
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 17.0.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
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:
|
|
7
|
+
* The version of the OpenAPI document: 17.0.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 17.0.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
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:
|
|
7
|
+
* The version of the OpenAPI document: 17.0.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 17.0.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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:
|
|
6
|
+
* The version of the OpenAPI document: 17.0.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# MeetingCreatableType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `GroupCall` (value: `'GROUP_CALL'`)
|
|
7
|
+
|
|
8
|
+
* `Webinar` (value: `'WEBINAR'`)
|
|
9
|
+
|
|
10
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**type** | [**
|
|
8
|
+
**type** | [**MeetingCreatableType**](MeetingCreatableType.md) | | [default to undefined]
|
|
9
9
|
**webAspectRatio** | [**MeetingAspectRatio**](MeetingAspectRatio.md) | | [optional] [default to undefined]
|
|
10
10
|
**mobileAspectRatio** | [**MeetingAspectRatio**](MeetingAspectRatio.md) | | [optional] [default to undefined]
|
|
11
11
|
**eventId** | **string** | | [optional] [default to undefined]
|
|
@@ -16,7 +16,6 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**title** | **string** | | [default to undefined]
|
|
17
17
|
**preferred_region** | **string** | | [default to undefined]
|
|
18
18
|
**record_on_start** | **boolean** | | [default to undefined]
|
|
19
|
-
**live_stream_on_start** | **boolean** | | [default to undefined]
|
|
20
19
|
**persist_chat** | **boolean** | | [default to undefined]
|
|
21
20
|
**summarize_on_end** | **boolean** | | [default to undefined]
|
|
22
21
|
|
|
@@ -37,7 +36,6 @@ const instance: MeetingCreateInputs = {
|
|
|
37
36
|
title,
|
|
38
37
|
preferred_region,
|
|
39
38
|
record_on_start,
|
|
40
|
-
live_stream_on_start,
|
|
41
39
|
persist_chat,
|
|
42
40
|
summarize_on_end,
|
|
43
41
|
};
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**type** | [**
|
|
8
|
+
**type** | [**MeetingCreatableType**](MeetingCreatableType.md) | | [optional] [default to undefined]
|
|
9
9
|
**webAspectRatio** | [**MeetingAspectRatio**](MeetingAspectRatio.md) | | [optional] [default to undefined]
|
|
10
10
|
**mobileAspectRatio** | [**MeetingAspectRatio**](MeetingAspectRatio.md) | | [optional] [default to undefined]
|
|
11
11
|
**eventId** | **string** | | [optional] [default to undefined]
|
|
@@ -16,7 +16,6 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**title** | **string** | | [optional] [default to undefined]
|
|
17
17
|
**preferred_region** | **string** | | [optional] [default to undefined]
|
|
18
18
|
**record_on_start** | **boolean** | | [optional] [default to undefined]
|
|
19
|
-
**live_stream_on_start** | **boolean** | | [optional] [default to undefined]
|
|
20
19
|
**status** | **string** | | [optional] [default to undefined]
|
|
21
20
|
**persist_chat** | **boolean** | | [optional] [default to undefined]
|
|
22
21
|
**summarize_on_end** | **boolean** | | [optional] [default to undefined]
|
|
@@ -38,7 +37,6 @@ const instance: MeetingUpdateInputs = {
|
|
|
38
37
|
title,
|
|
39
38
|
preferred_region,
|
|
40
39
|
record_on_start,
|
|
41
|
-
live_stream_on_start,
|
|
42
40
|
status,
|
|
43
41
|
persist_chat,
|
|
44
42
|
summarize_on_end,
|
package/docs/MeetingsApi.md
CHANGED
|
@@ -4,69 +4,16 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**addMeetingLivestream**](#addmeetinglivestream) | **POST** /meetings/{meetingId}/livestream | Add a livestream to a meeting|
|
|
8
7
|
|[**createMeeting**](#createmeeting) | **POST** /meetings | Create a meeting|
|
|
9
8
|
|[**getMeeting**](#getmeeting) | **GET** /meetings/{meetingId} | Get a meeting|
|
|
10
|
-
|[**getMeetingLivestream**](#getmeetinglivestream) | **GET** /meetings/{meetingId}/livestream | Get a meeting\'s livestream|
|
|
11
9
|
|[**getMeetings**](#getmeetings) | **GET** /meetings | List meetings|
|
|
12
10
|
|[**joinMeeting**](#joinmeeting) | **GET** /meetings/{meetingId}/join | Join a meeting as the current admin|
|
|
13
11
|
|[**updateMeeting**](#updatemeeting) | **PUT** /meetings/{meetingId} | Update a meeting|
|
|
14
12
|
|
|
15
|
-
# **addMeetingLivestream**
|
|
16
|
-
> GetLivestream200Response addMeetingLivestream()
|
|
17
|
-
|
|
18
|
-
Creates and attaches a new livestream to the given meeting so it can be broadcast, requiring the \"create\" permission on meetings.
|
|
19
|
-
|
|
20
|
-
### Example
|
|
21
|
-
|
|
22
|
-
```typescript
|
|
23
|
-
import {
|
|
24
|
-
MeetingsApi,
|
|
25
|
-
Configuration
|
|
26
|
-
} from '@connectedxm/admin-sdk';
|
|
27
|
-
|
|
28
|
-
const configuration = new Configuration();
|
|
29
|
-
const apiInstance = new MeetingsApi(configuration);
|
|
30
|
-
|
|
31
|
-
let meetingId: string; //The meeting identifier (default to undefined)
|
|
32
|
-
|
|
33
|
-
const { status, data } = await apiInstance.addMeetingLivestream(
|
|
34
|
-
meetingId
|
|
35
|
-
);
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
### Parameters
|
|
39
|
-
|
|
40
|
-
|Name | Type | Description | Notes|
|
|
41
|
-
|------------- | ------------- | ------------- | -------------|
|
|
42
|
-
| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
### Return type
|
|
46
|
-
|
|
47
|
-
**GetLivestream200Response**
|
|
48
|
-
|
|
49
|
-
### Authorization
|
|
50
|
-
|
|
51
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
52
|
-
|
|
53
|
-
### HTTP request headers
|
|
54
|
-
|
|
55
|
-
- **Content-Type**: Not defined
|
|
56
|
-
- **Accept**: application/json
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
### HTTP response details
|
|
60
|
-
| Status code | Description | Response headers |
|
|
61
|
-
|-------------|-------------|------------------|
|
|
62
|
-
|**200** | Successful response | - |
|
|
63
|
-
|
|
64
|
-
[[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)
|
|
65
|
-
|
|
66
13
|
# **createMeeting**
|
|
67
14
|
> CreateMeeting200Response createMeeting(meetingCreateInputs)
|
|
68
15
|
|
|
69
|
-
Creates a new video meeting for the organization, optionally linked to an event, event session, group, activity, or booking space, and configured with recording, chat,
|
|
16
|
+
Creates a new video meeting for the organization, optionally linked to an event, event session, group, activity, or booking space, and configured with recording, chat, and AI settings, requiring the \"create\" permission on meetings.
|
|
70
17
|
|
|
71
18
|
### Example
|
|
72
19
|
|
|
@@ -159,57 +106,6 @@ const { status, data } = await apiInstance.getMeeting(
|
|
|
159
106
|
- **Accept**: application/json
|
|
160
107
|
|
|
161
108
|
|
|
162
|
-
### HTTP response details
|
|
163
|
-
| Status code | Description | Response headers |
|
|
164
|
-
|-------------|-------------|------------------|
|
|
165
|
-
|**200** | Successful response | - |
|
|
166
|
-
|
|
167
|
-
[[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)
|
|
168
|
-
|
|
169
|
-
# **getMeetingLivestream**
|
|
170
|
-
> GetLivestream200Response getMeetingLivestream()
|
|
171
|
-
|
|
172
|
-
Returns the livestream configuration associated with the given meeting, requires the \"read\" permission on meetings.
|
|
173
|
-
|
|
174
|
-
### Example
|
|
175
|
-
|
|
176
|
-
```typescript
|
|
177
|
-
import {
|
|
178
|
-
MeetingsApi,
|
|
179
|
-
Configuration
|
|
180
|
-
} from '@connectedxm/admin-sdk';
|
|
181
|
-
|
|
182
|
-
const configuration = new Configuration();
|
|
183
|
-
const apiInstance = new MeetingsApi(configuration);
|
|
184
|
-
|
|
185
|
-
let meetingId: string; //The meeting identifier (default to undefined)
|
|
186
|
-
|
|
187
|
-
const { status, data } = await apiInstance.getMeetingLivestream(
|
|
188
|
-
meetingId
|
|
189
|
-
);
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
### Parameters
|
|
193
|
-
|
|
194
|
-
|Name | Type | Description | Notes|
|
|
195
|
-
|------------- | ------------- | ------------- | -------------|
|
|
196
|
-
| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
### Return type
|
|
200
|
-
|
|
201
|
-
**GetLivestream200Response**
|
|
202
|
-
|
|
203
|
-
### Authorization
|
|
204
|
-
|
|
205
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
206
|
-
|
|
207
|
-
### HTTP request headers
|
|
208
|
-
|
|
209
|
-
- **Content-Type**: Not defined
|
|
210
|
-
- **Accept**: application/json
|
|
211
|
-
|
|
212
|
-
|
|
213
109
|
### HTTP response details
|
|
214
110
|
| Status code | Description | Response headers |
|
|
215
111
|
|-------------|-------------|------------------|
|
|
@@ -331,7 +227,7 @@ const { status, data } = await apiInstance.joinMeeting(
|
|
|
331
227
|
# **updateMeeting**
|
|
332
228
|
> CreateMeeting200Response updateMeeting(meetingUpdateInputs)
|
|
333
229
|
|
|
334
|
-
Updates the settings of an existing meeting, such as its title, recording, chat,
|
|
230
|
+
Updates the settings of an existing meeting, such as its title, recording, chat, or AI configuration, requiring the \"update\" permission on meetings.
|
|
335
231
|
|
|
336
232
|
### Example
|
|
337
233
|
|
|
@@ -10,8 +10,6 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**meetingGroupCallGuestPreset** | **string** | | [default to undefined]
|
|
11
11
|
**meetingWebinarAdminPreset** | **string** | | [default to undefined]
|
|
12
12
|
**meetingWebinarGuestPreset** | **string** | | [default to undefined]
|
|
13
|
-
**meetingLivestreamAdminPreset** | **string** | | [default to undefined]
|
|
14
|
-
**meetingLivestreamGuestPreset** | **string** | | [default to undefined]
|
|
15
13
|
**supportAutoResolve** | **boolean** | | [default to undefined]
|
|
16
14
|
**supportAutoResolveMessage** | **string** | | [optional] [default to undefined]
|
|
17
15
|
**eventConfirmationEmailReplyTo** | **string** | | [default to undefined]
|
|
@@ -40,8 +38,6 @@ const instance: OrganizationModuleSettings = {
|
|
|
40
38
|
meetingGroupCallGuestPreset,
|
|
41
39
|
meetingWebinarAdminPreset,
|
|
42
40
|
meetingWebinarGuestPreset,
|
|
43
|
-
meetingLivestreamAdminPreset,
|
|
44
|
-
meetingLivestreamGuestPreset,
|
|
45
41
|
supportAutoResolve,
|
|
46
42
|
supportAutoResolveMessage,
|
|
47
43
|
eventConfirmationEmailReplyTo,
|
|
@@ -9,8 +9,6 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**meetingGroupCallGuestPreset** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**meetingWebinarAdminPreset** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**meetingWebinarGuestPreset** | **string** | | [optional] [default to undefined]
|
|
12
|
-
**meetingLivestreamAdminPreset** | **string** | | [optional] [default to undefined]
|
|
13
|
-
**meetingLivestreamGuestPreset** | **string** | | [optional] [default to undefined]
|
|
14
12
|
**supportAutoResolve** | **boolean** | | [optional] [default to undefined]
|
|
15
13
|
**supportAutoResolveMessage** | **string** | | [optional] [default to undefined]
|
|
16
14
|
**eventConfirmationEmailReplyTo** | **string** | | [optional] [default to undefined]
|
|
@@ -38,8 +36,6 @@ const instance: OrganizationModuleSettingsUpdateInputs = {
|
|
|
38
36
|
meetingGroupCallGuestPreset,
|
|
39
37
|
meetingWebinarAdminPreset,
|
|
40
38
|
meetingWebinarGuestPreset,
|
|
41
|
-
meetingLivestreamAdminPreset,
|
|
42
|
-
meetingLivestreamGuestPreset,
|
|
43
39
|
supportAutoResolve,
|
|
44
40
|
supportAutoResolveMessage,
|
|
45
41
|
eventConfirmationEmailReplyTo,
|
|
@@ -10,7 +10,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
10
10
|
# **getOrganizationModuleSettings**
|
|
11
11
|
> GetOrganizationModuleSettings200Response getOrganizationModuleSettings()
|
|
12
12
|
|
|
13
|
-
Returns the organization\'s cross-module configuration (e.g. meeting call/webinar
|
|
13
|
+
Returns the organization\'s cross-module configuration (e.g. meeting call/webinar presets and support auto-resolve behavior), creating default settings if none exist yet; requires org read permission.
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
package/docs/StreamInput.md
CHANGED
|
@@ -23,8 +23,6 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**event** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
|
|
24
24
|
**session** | [**BaseEventSession**](BaseEventSession.md) | | [default to undefined]
|
|
25
25
|
**group** | [**BaseGroup**](BaseGroup.md) | | [default to undefined]
|
|
26
|
-
**meetingId** | **string** | | [default to undefined]
|
|
27
|
-
**meeting** | [**BaseMeeting**](BaseMeeting.md) | | [default to undefined]
|
|
28
26
|
**activityId** | **string** | | [default to undefined]
|
|
29
27
|
**activity** | [**BaseActivity**](BaseActivity.md) | | [default to undefined]
|
|
30
28
|
**streamInputId** | **string** | | [default to undefined]
|
|
@@ -58,8 +56,6 @@ const instance: StreamInput = {
|
|
|
58
56
|
event,
|
|
59
57
|
session,
|
|
60
58
|
group,
|
|
61
|
-
meetingId,
|
|
62
|
-
meeting,
|
|
63
59
|
activityId,
|
|
64
60
|
activity,
|
|
65
61
|
streamInputId,
|
|
@@ -11,7 +11,6 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**eventId** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**sessionId** | **string** | | [optional] [default to undefined]
|
|
13
13
|
**groupId** | **string** | | [optional] [default to undefined]
|
|
14
|
-
**meetingId** | **string** | | [optional] [default to undefined]
|
|
15
14
|
**activityId** | **string** | | [optional] [default to undefined]
|
|
16
15
|
**details** | **object** | | [optional] [default to undefined]
|
|
17
16
|
**imageId** | **string** | | [optional] [default to undefined]
|
|
@@ -33,7 +32,6 @@ const instance: StreamInputCreateInputs = {
|
|
|
33
32
|
eventId,
|
|
34
33
|
sessionId,
|
|
35
34
|
groupId,
|
|
36
|
-
meetingId,
|
|
37
35
|
activityId,
|
|
38
36
|
details,
|
|
39
37
|
imageId,
|
|
@@ -11,7 +11,6 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**eventId** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**sessionId** | **string** | | [optional] [default to undefined]
|
|
13
13
|
**groupId** | **string** | | [optional] [default to undefined]
|
|
14
|
-
**meetingId** | **string** | | [optional] [default to undefined]
|
|
15
14
|
**activityId** | **string** | | [optional] [default to undefined]
|
|
16
15
|
**connected** | **boolean** | | [optional] [default to undefined]
|
|
17
16
|
**imageId** | **string** | | [optional] [default to undefined]
|
|
@@ -33,7 +32,6 @@ const instance: StreamInputUpdateInputs = {
|
|
|
33
32
|
eventId,
|
|
34
33
|
sessionId,
|
|
35
34
|
groupId,
|
|
36
|
-
meetingId,
|
|
37
35
|
activityId,
|
|
38
36
|
connected,
|
|
39
37
|
imageId,
|
package/docs/StreamsApi.md
CHANGED
|
@@ -169,7 +169,7 @@ const { status, data } = await apiInstance.getStreamInput(
|
|
|
169
169
|
# **getStreamInputs**
|
|
170
170
|
> GetStreamInputs200Response getStreamInputs()
|
|
171
171
|
|
|
172
|
-
Returns a paginated list of stream inputs for the organization, filterable by associated event, session,
|
|
172
|
+
Returns a paginated list of stream inputs for the organization, filterable by associated event, session, or group, by whether an encoder is connected, by whether the input is attached to an event, session, group or activity, and by free-text search; each item includes when its latest broadcast started; requires read permission on streams.
|
|
173
173
|
|
|
174
174
|
### Example
|
|
175
175
|
|
|
@@ -185,7 +185,6 @@ const apiInstance = new StreamsApi(configuration);
|
|
|
185
185
|
let eventId: string; //Filter by eventId (optional) (default to undefined)
|
|
186
186
|
let sessionId: string; //Filter by sessionId (optional) (default to undefined)
|
|
187
187
|
let groupId: string; //Filter by groupId (optional) (default to undefined)
|
|
188
|
-
let meetingId: string; //Filter by meetingId (optional) (default to undefined)
|
|
189
188
|
let connected: boolean; //Filter by connected (optional) (default to undefined)
|
|
190
189
|
let attached: boolean; //Filter by attached (optional) (default to undefined)
|
|
191
190
|
let page: number; //Page number (optional) (default to 1)
|
|
@@ -197,7 +196,6 @@ const { status, data } = await apiInstance.getStreamInputs(
|
|
|
197
196
|
eventId,
|
|
198
197
|
sessionId,
|
|
199
198
|
groupId,
|
|
200
|
-
meetingId,
|
|
201
199
|
connected,
|
|
202
200
|
attached,
|
|
203
201
|
page,
|
|
@@ -214,7 +212,6 @@ const { status, data } = await apiInstance.getStreamInputs(
|
|
|
214
212
|
| **eventId** | [**string**] | Filter by eventId | (optional) defaults to undefined|
|
|
215
213
|
| **sessionId** | [**string**] | Filter by sessionId | (optional) defaults to undefined|
|
|
216
214
|
| **groupId** | [**string**] | Filter by groupId | (optional) defaults to undefined|
|
|
217
|
-
| **meetingId** | [**string**] | Filter by meetingId | (optional) defaults to undefined|
|
|
218
215
|
| **connected** | [**boolean**] | Filter by connected | (optional) defaults to undefined|
|
|
219
216
|
| **attached** | [**boolean**] | Filter by attached | (optional) defaults to undefined|
|
|
220
217
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
package/package.json
CHANGED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# GetLivestream200Response
|
|
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** | [**Livestream**](Livestream.md) | | [default to undefined]
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
import { GetLivestream200Response } from '@connectedxm/admin-sdk';
|
|
16
|
-
|
|
17
|
-
const instance: GetLivestream200Response = {
|
|
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)
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# GetLivestreamSessions200Response
|
|
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<LivestreamSession>**](LivestreamSession.md) | | [default to undefined]
|
|
11
|
-
**count** | **number** | | [optional] [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { GetLivestreamSessions200Response } from '@connectedxm/admin-sdk';
|
|
17
|
-
|
|
18
|
-
const instance: GetLivestreamSessions200Response = {
|
|
19
|
-
status,
|
|
20
|
-
message,
|
|
21
|
-
data,
|
|
22
|
-
count,
|
|
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)
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# GetLivestreams200Response
|
|
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<Livestream>**](Livestream.md) | | [default to undefined]
|
|
11
|
-
**count** | **number** | | [optional] [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { GetLivestreams200Response } from '@connectedxm/admin-sdk';
|
|
17
|
-
|
|
18
|
-
const instance: GetLivestreams200Response = {
|
|
19
|
-
status,
|
|
20
|
-
message,
|
|
21
|
-
data,
|
|
22
|
-
count,
|
|
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)
|
package/docs/Livestream.md
DELETED
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
# Livestream
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** | | [default to undefined]
|
|
9
|
-
**name** | **string** | | [default to undefined]
|
|
10
|
-
**status** | **string** | | [default to undefined]
|
|
11
|
-
**ingest_server** | **string** | | [default to undefined]
|
|
12
|
-
**stream_key** | **string** | | [default to undefined]
|
|
13
|
-
**playback_url** | **string** | | [default to undefined]
|
|
14
|
-
**meeting_id** | **string** | | [default to undefined]
|
|
15
|
-
**created_at** | **string** | | [default to undefined]
|
|
16
|
-
**updated_at** | **string** | | [default to undefined]
|
|
17
|
-
**disabled** | **boolean** | | [default to undefined]
|
|
18
|
-
|
|
19
|
-
## Example
|
|
20
|
-
|
|
21
|
-
```typescript
|
|
22
|
-
import { Livestream } from '@connectedxm/admin-sdk';
|
|
23
|
-
|
|
24
|
-
const instance: Livestream = {
|
|
25
|
-
id,
|
|
26
|
-
name,
|
|
27
|
-
status,
|
|
28
|
-
ingest_server,
|
|
29
|
-
stream_key,
|
|
30
|
-
playback_url,
|
|
31
|
-
meeting_id,
|
|
32
|
-
created_at,
|
|
33
|
-
updated_at,
|
|
34
|
-
disabled,
|
|
35
|
-
};
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
# LivestreamSession
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** | | [default to undefined]
|
|
9
|
-
**livestream_id** | **string** | | [default to undefined]
|
|
10
|
-
**err_message** | **string** | | [default to undefined]
|
|
11
|
-
**invoked_time** | **string** | | [default to undefined]
|
|
12
|
-
**started_time** | **string** | | [default to undefined]
|
|
13
|
-
**stopped_time** | **string** | | [default to undefined]
|
|
14
|
-
**created_at** | **string** | | [default to undefined]
|
|
15
|
-
**updated_at** | **string** | | [default to undefined]
|
|
16
|
-
**ingest_seconds** | **string** | | [default to undefined]
|
|
17
|
-
|
|
18
|
-
## Example
|
|
19
|
-
|
|
20
|
-
```typescript
|
|
21
|
-
import { LivestreamSession } from '@connectedxm/admin-sdk';
|
|
22
|
-
|
|
23
|
-
const instance: LivestreamSession = {
|
|
24
|
-
id,
|
|
25
|
-
livestream_id,
|
|
26
|
-
err_message,
|
|
27
|
-
invoked_time,
|
|
28
|
-
started_time,
|
|
29
|
-
stopped_time,
|
|
30
|
-
created_at,
|
|
31
|
-
updated_at,
|
|
32
|
-
ingest_seconds,
|
|
33
|
-
};
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|