@connectedxm/admin-sdk 13.6.0 → 13.8.0

package/docs/StreamsSessionsApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://admin-api.connected.dev*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**closeStreamSession**](#closestreamsession) | **PUT** /streams/{streamId}/sessions/{sessionId}/close | Close an active stream session|
+|[**deleteStreamSessionChatMessage**](#deletestreamsessionchatmessage) | **DELETE** /streams/sessions/{sessionId}/chat/{messageId} | Delete a stream session chat message|
 |[**exportStreamSession**](#exportstreamsession) | **POST** /streams/{streamId}/sessions/{sessionId}/export | Request an export of a stream session|
 |[**exportStreamSessionById**](#exportstreamsessionbyid) | **POST** /streams/sessions/{sessionId}/export | Request an export of a stream session by session id|
 |[**getAllStreamSessions**](#getallstreamsessions) | **GET** /streams/sessions | List stream sessions across all stream inputs|
@@ -14,6 +15,7 @@ All URIs are relative to *https://admin-api.connected.dev*
 |[**getStreamSessionByIdSubscriptions**](#getstreamsessionbyidsubscriptions) | **GET** /streams/sessions/{sessionId}/subscriptions | List a stream session\'s viewer connections by session id|
 |[**getStreamSessionChat**](#getstreamsessionchat) | **GET** /streams/{streamId}/sessions/{sessionId}/chat | List a stream session\'s chat messages|
 |[**getStreamSessionSubscriptions**](#getstreamsessionsubscriptions) | **GET** /streams/{streamId}/sessions/{sessionId}/subscriptions | List a stream session\'s viewer connections|
+|[**getStreamSessionViewers**](#getstreamsessionviewers) | **GET** /streams/sessions/{sessionId}/viewers | List the people watching a stream session|
 |[**getStreamSessions**](#getstreamsessions) | **GET** /streams/{streamId}/sessions | List a stream\'s broadcast sessions|
 |[**updateStreamSession**](#updatestreamsession) | **PUT** /streams/sessions/{sessionId} | Update a stream session|
 
@@ -50,6 +52,60 @@ const { status, data } = await apiInstance.closeStreamSession(
 | **sessionId** | [**string**] | The session identifier | defaults to undefined|
 
 
+### Return type
+
+**CreateAccountInvitations200Response**
+
+### 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)
+
+# **deleteStreamSessionChatMessage**
+> CreateAccountInvitations200Response deleteStreamSessionChatMessage()
+
+Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
+
+### Example
+
+```typescript
+import {
+    StreamsSessionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsSessionsApi(configuration);
+
+let sessionId: string; //The session identifier (default to undefined)
+let messageId: string; //The message identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteStreamSessionChatMessage(
+    sessionId,
+    messageId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **messageId** | [**string**] | The message identifier | defaults to undefined|
+
+
 ### Return type
 
 **CreateAccountInvitations200Response**
@@ -586,6 +642,69 @@ const { status, data } = await apiInstance.getStreamSessionSubscriptions(
  - **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)
+
+# **getStreamSessionViewers**
+> GetStreamSessionViewers200Response getStreamSessionViewers()
+
+Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
+
+### Example
+
+```typescript
+import {
+    StreamsSessionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsSessionsApi(configuration);
+
+let sessionId: string; //The session 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.getStreamSessionViewers(
+    sessionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | [**string**] | The session 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
+
+**GetStreamSessionViewers200Response**
+
+### 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": "13.6.0",
+  "version": "13.8.0",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {