@connectedxm/admin-sdk 16.13.0 → 16.15.0

package/docs/EventsInterestsApi.md

@@ -0,0 +1,181 @@
+# EventsInterestsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addEventInterest**](#addeventinterest) | **POST** /events/{eventId}/interests/{interestId} | Add an interest to an event|
+|[**getEventInterests**](#geteventinterests) | **GET** /events/{eventId}/interests | List an event\'s interests|
+|[**removeEventInterest**](#removeeventinterest) | **DELETE** /events/{eventId}/interests/{interestId} | Remove an interest from an event|
+
+# **addEventInterest**
+> CreateEvent200Response addEventInterest()
+
+Associates an existing interest with an event, requiring update permission on both events and interests; the event\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
+
+### Example
+
+```typescript
+import {
+    EventsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsInterestsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let interestId: string; //The interest identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventInterest(
+    eventId,
+    interestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **interestId** | [**string**] | The interest identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEvent200Response**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **getEventInterests**
+> GetAccountInterests200Response getEventInterests()
+
+Returns a paginated list of interest tags associated with the given event, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on events and interests.
+
+### Example
+
+```typescript
+import {
+    EventsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsInterestsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getEventInterests(
+    eventId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetAccountInterests200Response**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **removeEventInterest**
+> CreateEvent200Response removeEventInterest()
+
+Removes an interest from an event, requiring update permission on both events and interests; the event\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
+
+### Example
+
+```typescript
+import {
+    EventsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsInterestsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let interestId: string; //The interest identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventInterest(
+    eventId,
+    interestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **interestId** | [**string**] | The interest identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEvent200Response**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+

package/docs/GetReplays200Response.md

@@ -0,0 +1,26 @@
+# GetReplays200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<Replay>**](Replay.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetReplays200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetReplays200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[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/GroupsInterestsApi.md

@@ -11,7 +11,7 @@ All URIs are relative to *https://admin-api.connected.dev*
 # **addGroupInterest**
 > CreateGroup200Response addGroupInterest()
 
-Associates an existing interest with a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list is invalidated.
+Associates an existing interest with a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
 
 ### Example
 
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getGroupInterests(
 # **removeGroupInterest**
 > CreateGroup200Response removeGroupInterest()
 
-Disassociates an interest from a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list is invalidated.
+Disassociates an interest from a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
 
 ### Example
 

package/docs/Replay.md

@@ -0,0 +1,40 @@
+# Replay
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**videoId** | **string** |  | [default to undefined]
+**sessionId** | **string** |  | [default to undefined]
+**eventId** | **string** |  | [default to undefined]
+**groupId** | **string** |  | [default to undefined]
+**session** | [**BaseReplaySession**](BaseReplaySession.md) |  | [default to undefined]
+**event** | [**VideoAllOfStream**](VideoAllOfStream.md) |  | [default to undefined]
+**group** | [**VideoAllOfStream**](VideoAllOfStream.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+**video** | [**ReplayVideo**](ReplayVideo.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Replay } from '@connectedxm/admin-sdk';
+
+const instance: Replay = {
+    id,
+    videoId,
+    sessionId,
+    eventId,
+    groupId,
+    session,
+    event,
+    group,
+    createdAt,
+    updatedAt,
+    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/ReplayCreateInputs.md

@@ -0,0 +1,26 @@
+# ReplayCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**videoId** | **string** |  | [default to undefined]
+**sessionId** | **string** |  | [optional] [default to undefined]
+**eventId** | **string** |  | [optional] [default to undefined]
+**groupId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReplayCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: ReplayCreateInputs = {
+    videoId,
+    sessionId,
+    eventId,
+    groupId,
+};
+```
+
+[[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/ReplayUpdateInputs.md

@@ -0,0 +1,24 @@
+# ReplayUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sessionId** | **string** |  | [optional] [default to undefined]
+**eventId** | **string** |  | [optional] [default to undefined]
+**groupId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReplayUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: ReplayUpdateInputs = {
+    sessionId,
+    eventId,
+    groupId,
+};
+```
+
+[[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/ReplayVideo.md

@@ -0,0 +1,50 @@
+# ReplayVideo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**status** | **string** |  | [default to undefined]
+**source** | [**VideoSource**](VideoSource.md) |  | [default to undefined]
+**width** | **number** |  | [default to undefined]
+**height** | **number** |  | [default to undefined]
+**thumbnailUrl** | **string** |  | [default to undefined]
+**previewUrl** | **string** |  | [default to undefined]
+**readyToStream** | **boolean** |  | [default to undefined]
+**duration** | **number** |  | [default to undefined]
+**streamId** | **string** |  | [default to undefined]
+**streamSessionId** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**hlsUrl** | **string** |  | [default to undefined]
+**stream** | [**VideoAllOfStream**](VideoAllOfStream.md) |  | [default to undefined]
+**streamSession** | [**VideoAllOfStreamSession**](VideoAllOfStreamSession.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ReplayVideo } from '@connectedxm/admin-sdk';
+
+const instance: ReplayVideo = {
+    id,
+    name,
+    status,
+    source,
+    width,
+    height,
+    thumbnailUrl,
+    previewUrl,
+    readyToStream,
+    duration,
+    streamId,
+    streamSessionId,
+    createdAt,
+    hlsUrl,
+    stream,
+    streamSession,
+};
+```
+
+[[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/StreamInput.md

@@ -18,17 +18,21 @@ Name | Type | Description | Notes
 **webRTC** | **boolean** |  | [default to undefined]
 **webRTCPlaybackUrl** | **string** |  | [default to undefined]
 **dvrEnabled** | **boolean** |  | [default to undefined]
+**allowReplays** | **boolean** |  | [default to undefined]
 **connected** | **boolean** |  | [default to undefined]
 **event** | [**BaseEvent**](BaseEvent.md) |  | [default to undefined]
 **session** | [**BaseEventSession**](BaseEventSession.md) |  | [default to undefined]
 **group** | [**BaseGroup**](BaseGroup.md) |  | [default to undefined]
 **meetingId** | **string** |  | [default to undefined]
 **meeting** | [**BaseMeeting**](BaseMeeting.md) |  | [default to undefined]
+**activityId** | **string** |  | [default to undefined]
+**activity** | [**BaseActivity**](BaseActivity.md) |  | [default to undefined]
 **streamInputId** | **string** |  | [default to undefined]
 **streamInput** | [**BaseStreamInput**](BaseStreamInput.md) |  | [default to undefined]
 **details** | [**StreamInputDetails**](StreamInputDetails.md) |  | [optional] [default to undefined]
 **sortOrder** | **number** |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
+**lastStreamSessionStartedAt** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -49,17 +53,21 @@ const instance: StreamInput = {
     webRTC,
     webRTCPlaybackUrl,
     dvrEnabled,
+    allowReplays,
     connected,
     event,
     session,
     group,
     meetingId,
     meeting,
+    activityId,
+    activity,
     streamInputId,
     streamInput,
     details,
     sortOrder,
     createdAt,
+    lastStreamSessionStartedAt,
 };
 ```
 

package/docs/StreamInputCreateInputs.md

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **locale** | **string** |  | [optional] [default to undefined]
 **webRTC** | **boolean** |  | [optional] [default to undefined]
 **dvrEnabled** | **boolean** |  | [optional] [default to undefined]
+**allowReplays** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -40,6 +41,7 @@ const instance: StreamInputCreateInputs = {
     locale,
     webRTC,
     dvrEnabled,
+    allowReplays,
 };
 ```
 

package/docs/StreamInputUpdateInputs.md

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **locale** | **string** |  | [optional] [default to undefined]
 **webRTC** | **boolean** |  | [optional] [default to undefined]
 **dvrEnabled** | **boolean** |  | [optional] [default to undefined]
+**allowReplays** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -40,6 +41,7 @@ const instance: StreamInputUpdateInputs = {
     locale,
     webRTC,
     dvrEnabled,
+    allowReplays,
 };
 ```
 

package/docs/StreamsApi.md

@@ -169,7 +169,7 @@ const { status, data } = await apiInstance.getStreamInput(
 # **getStreamInputs**
 > GetStreamInputs200Response getStreamInputs()
 
-Returns a paginated list of stream inputs for the organization, filterable by associated event, session, group, or meeting, and by free-text search; requires read permission on streams.
+Returns a paginated list of stream inputs for the organization, filterable by associated event, session, group, or meeting, by whether an encoder is connected, by whether the input is attached to an event, session, group or activity (a meeting-only input counts as not attached), and by free-text search; each item includes when its latest broadcast started; requires read permission on streams.
 
 ### Example
 
@@ -186,6 +186,8 @@ let eventId: string; //Filter by eventId (optional) (default to undefined)
 let sessionId: string; //Filter by sessionId (optional) (default to undefined)
 let groupId: string; //Filter by groupId (optional) (default to undefined)
 let meetingId: string; //Filter by meetingId (optional) (default to undefined)
+let connected: boolean; //Filter by connected (optional) (default to undefined)
+let attached: boolean; //Filter by attached (optional) (default to undefined)
 let page: number; //Page number (optional) (default to 1)
 let pageSize: number; //Number of items per page (optional) (default to 25)
 let orderBy: string; //Field to order by (optional) (default to undefined)
@@ -196,6 +198,8 @@ const { status, data } = await apiInstance.getStreamInputs(
     sessionId,
     groupId,
     meetingId,
+    connected,
+    attached,
     page,
     pageSize,
     orderBy,
@@ -211,6 +215,8 @@ const { status, data } = await apiInstance.getStreamInputs(
 | **sessionId** | [**string**] | Filter by sessionId | (optional) defaults to undefined|
 | **groupId** | [**string**] | Filter by groupId | (optional) defaults to undefined|
 | **meetingId** | [**string**] | Filter by meetingId | (optional) defaults to undefined|
+| **connected** | [**boolean**] | Filter by connected | (optional) defaults to undefined|
+| **attached** | [**boolean**] | Filter by attached | (optional) defaults to undefined|
 | **page** | [**number**] | Page number | (optional) defaults to 1|
 | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
 | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|