@connectedxm/admin-sdk 13.3.0 → 13.5.0

package/docs/StreamsSessionsApi.md

@@ -6,10 +6,16 @@ All URIs are relative to *https://admin-api.connected.dev*
 |------------- | ------------- | -------------|
 |[**closeStreamSession**](#closestreamsession) | **PUT** /streams/{streamId}/sessions/{sessionId}/close | Close an active stream session|
 |[**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|
 |[**getStreamSession**](#getstreamsession) | **GET** /streams/{streamId}/sessions/{sessionId} | Get a single stream session|
+|[**getStreamSessionById**](#getstreamsessionbyid) | **GET** /streams/sessions/{sessionId} | Get a stream session by id|
+|[**getStreamSessionByIdChat**](#getstreamsessionbyidchat) | **GET** /streams/sessions/{sessionId}/chat | List a stream session\'s chat messages by session id|
+|[**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|
 |[**getStreamSessions**](#getstreamsessions) | **GET** /streams/{streamId}/sessions | List a stream\'s broadcast sessions|
+|[**updateStreamSession**](#updatestreamsession) | **PUT** /streams/sessions/{sessionId} | Update a stream session|
 
 # **closeStreamSession**
 > CreateAccountInvitations200Response closeStreamSession()
@@ -112,6 +118,129 @@ const { status, data } = await apiInstance.exportStreamSession(
  - **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)
+
+# **exportStreamSessionById**
+> CreateAccountInvitations200Response exportStreamSessionById()
+
+Queues an asynchronous export job for the given stream session (sessionId), whether or not its stream input still exists, emailing the requesting user a download when the export completes; requires the 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)
+
+const { status, data } = await apiInstance.exportStreamSessionById(
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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)
+
+# **getAllStreamSessions**
+> GetAllStreamSessions200Response getAllStreamSessions()
+
+Returns a paginated list of the organization\'s broadcast sessions across every stream input, including sessions whose input has been deleted, filterable by stream input, event, event session and status and searchable by session or input name; requires read permission on streams.
+
+### Example
+
+```typescript
+import {
+    StreamsSessionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsSessionsApi(configuration);
+
+let streamId: string; //Filter by streamId (optional) (default to undefined)
+let eventId: string; //Filter by eventId (optional) (default to undefined)
+let eventSessionId: string; //Filter by eventSessionId (optional) (default to undefined)
+let status: string; //Filter by status (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)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getAllStreamSessions(
+    streamId,
+    eventId,
+    eventSessionId,
+    status,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | Filter by streamId | (optional) defaults to undefined|
+| **eventId** | [**string**] | Filter by eventId | (optional) defaults to undefined|
+| **eventSessionId** | [**string**] | Filter by eventSessionId | (optional) defaults to undefined|
+| **status** | [**string**] | Filter by status | (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|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetAllStreamSessions200Response**
+
+### 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 |
 |-------------|-------------|------------------|
@@ -120,7 +249,7 @@ const { status, data } = await apiInstance.exportStreamSession(
 [[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)
 
 # **getStreamSession**
-> GetStreamSession200Response getStreamSession()
+> GetStreamSessionById200Response getStreamSession()
 
 Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
 
@@ -154,7 +283,175 @@ const { status, data } = await apiInstance.getStreamSession(
 
 ### Return type
 
-**GetStreamSession200Response**
+**GetStreamSessionById200Response**
+
+### 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)
+
+# **getStreamSessionById**
+> GetStreamSessionById200Response getStreamSessionById()
+
+Returns one broadcast session by its id alone, whether or not its stream input still exists, with its name, status, timing and the event and event session it belongs to; 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)
+
+const { status, data } = await apiInstance.getStreamSessionById(
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+
+
+### Return type
+
+**GetStreamSessionById200Response**
+
+### 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)
+
+# **getStreamSessionByIdChat**
+> GetStreamSessionByIdChat200Response getStreamSessionByIdChat()
+
+Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, whether or not its stream input still exists; 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)
+
+const { status, data } = await apiInstance.getStreamSessionByIdChat(
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+
+
+### Return type
+
+**GetStreamSessionByIdChat200Response**
+
+### 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)
+
+# **getStreamSessionByIdSubscriptions**
+> GetStreamSessionByIdSubscriptions200Response getStreamSessionByIdSubscriptions()
+
+Returns a paginated list of viewer WebSocket subscriptions for the given stream session, whether or not its stream input still exists, optionally filtered to only active (not yet disconnected) subscriptions; 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 active: boolean; //Filter by active (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)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getStreamSessionByIdSubscriptions(
+    sessionId,
+    active,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **active** | [**boolean**] | Filter by active | (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|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetStreamSessionByIdSubscriptions200Response**
 
 ### Authorization
 
@@ -174,7 +471,7 @@ const { status, data } = await apiInstance.getStreamSession(
 [[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)
 
 # **getStreamSessionChat**
-> GetStreamSessionChat200Response getStreamSessionChat()
+> GetStreamSessionByIdChat200Response getStreamSessionChat()
 
 Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, ordered for chronological display; requires read permission on streams.
 
@@ -208,7 +505,7 @@ const { status, data } = await apiInstance.getStreamSessionChat(
 
 ### Return type
 
-**GetStreamSessionChat200Response**
+**GetStreamSessionByIdChat200Response**
 
 ### Authorization
 
@@ -228,7 +525,7 @@ const { status, data } = await apiInstance.getStreamSessionChat(
 [[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)
 
 # **getStreamSessionSubscriptions**
-> GetStreamSessionSubscriptions200Response getStreamSessionSubscriptions()
+> GetStreamSessionByIdSubscriptions200Response getStreamSessionSubscriptions()
 
 Returns a paginated list of viewer WebSocket subscriptions for the given stream session, each with its connection details, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
 
@@ -277,7 +574,7 @@ const { status, data } = await apiInstance.getStreamSessionSubscriptions(
 
 ### Return type
 
-**GetStreamSessionSubscriptions200Response**
+**GetStreamSessionByIdSubscriptions200Response**
 
 ### Authorization
 
@@ -297,7 +594,7 @@ const { status, data } = await apiInstance.getStreamSessionSubscriptions(
 [[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)
 
 # **getStreamSessions**
-> GetStreamSessions200Response getStreamSessions()
+> GetAllStreamSessions200Response getStreamSessions()
 
 Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
 
@@ -343,7 +640,7 @@ const { status, data } = await apiInstance.getStreamSessions(
 
 ### Return type
 
-**GetStreamSessions200Response**
+**GetAllStreamSessions200Response**
 
 ### Authorization
 
@@ -362,3 +659,58 @@ const { status, data } = await apiInstance.getStreamSessions(
 
 [[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)
 
+# **updateStreamSession**
+> GetStreamSessionById200Response updateStreamSession(streamSessionUpdateInputs)
+
+Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
+
+### Example
+
+```typescript
+import {
+    StreamsSessionsApi,
+    Configuration,
+    StreamSessionUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsSessionsApi(configuration);
+
+let sessionId: string; //The session identifier (default to undefined)
+let streamSessionUpdateInputs: StreamSessionUpdateInputs; //
+
+const { status, data } = await apiInstance.updateStreamSession(
+    sessionId,
+    streamSessionUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamSessionUpdateInputs** | **StreamSessionUpdateInputs**|  | |
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+
+
+### Return type
+
+**GetStreamSessionById200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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/UpdatePlaceMembershipTypeTranslation200Response.md

@@ -0,0 +1,24 @@
+# UpdatePlaceMembershipTypeTranslation200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**PlaceMembershipTypeTranslation**](PlaceMembershipTypeTranslation.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdatePlaceMembershipTypeTranslation200Response } from '@connectedxm/admin-sdk';
+
+const instance: UpdatePlaceMembershipTypeTranslation200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/package.json

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