@connectedxm/admin-sdk 16.13.0 → 16.15.0

package/docs/StreamsReplaysApi.md

@@ -0,0 +1,293 @@
+# StreamsReplaysApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createReplay**](#createreplay) | **POST** /replays | Add a video as a replay|
+|[**deleteReplay**](#deletereplay) | **DELETE** /replays/{replayId} | Remove a replay|
+|[**getReplay**](#getreplay) | **GET** /replays/{replayId} | Get a replay|
+|[**getReplays**](#getreplays) | **GET** /replays | List replays|
+|[**updateReplay**](#updatereplay) | **PUT** /replays/{replayId} | Move a replay|
+
+# **createReplay**
+> CreateReplay200Response createReplay(replayCreateInputs)
+
+Attaches a video from storage as a replay to exactly one session, event or group; a video can be a replay on several targets, but only once on each (a repeat returns 400 \"Replay already exists\"). Requires create permission on streams.
+
+### Example
+
+```typescript
+import {
+    StreamsReplaysApi,
+    Configuration,
+    ReplayCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsReplaysApi(configuration);
+
+let replayCreateInputs: ReplayCreateInputs; //
+
+const { status, data } = await apiInstance.createReplay(
+    replayCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **replayCreateInputs** | **ReplayCreateInputs**|  | |
+
+
+### Return type
+
+**CreateReplay200Response**
+
+### 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)
+
+# **deleteReplay**
+> CreateAccountInvitations200Response deleteReplay()
+
+Detaches a replay from its session, event or group; the video stays in storage. Requires delete permission on streams.
+
+### Example
+
+```typescript
+import {
+    StreamsReplaysApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsReplaysApi(configuration);
+
+let replayId: string; //The replay identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteReplay(
+    replayId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **replayId** | [**string**] | The replay 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)
+
+# **getReplay**
+> CreateReplay200Response getReplay()
+
+Returns a single replay with its video and the name of the session, event or group it is attached to; requires read permission on streams.
+
+### Example
+
+```typescript
+import {
+    StreamsReplaysApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsReplaysApi(configuration);
+
+let replayId: string; //The replay identifier (default to undefined)
+
+const { status, data } = await apiInstance.getReplay(
+    replayId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **replayId** | [**string**] | The replay identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateReplay200Response**
+
+### 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)
+
+# **getReplays**
+> GetReplays200Response getReplays()
+
+Returns a paginated list of the organization\'s replays, newest first, each with its video and the name of the session, event or group it is attached to, filterable by session, event, group or video; requires read permission on streams.
+
+### Example
+
+```typescript
+import {
+    StreamsReplaysApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsReplaysApi(configuration);
+
+let sessionId: string; //Filter by sessionId (optional) (default to undefined)
+let eventId: string; //Filter by eventId (optional) (default to undefined)
+let groupId: string; //Filter by groupId (optional) (default to undefined)
+let videoId: string; //Filter by videoId (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.getReplays(
+    sessionId,
+    eventId,
+    groupId,
+    videoId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | [**string**] | Filter by sessionId | (optional) defaults to undefined|
+| **eventId** | [**string**] | Filter by eventId | (optional) defaults to undefined|
+| **groupId** | [**string**] | Filter by groupId | (optional) defaults to undefined|
+| **videoId** | [**string**] | Filter by videoId | (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
+
+**GetReplays200Response**
+
+### 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)
+
+# **updateReplay**
+> CreateReplay200Response updateReplay(replayUpdateInputs)
+
+Moves a replay to exactly one other session, event or group in the organization; the video itself is unchanged. Requires update permission on streams.
+
+### Example
+
+```typescript
+import {
+    StreamsReplaysApi,
+    Configuration,
+    ReplayUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsReplaysApi(configuration);
+
+let replayId: string; //The replay identifier (default to undefined)
+let replayUpdateInputs: ReplayUpdateInputs; //
+
+const { status, data } = await apiInstance.updateReplay(
+    replayId,
+    replayUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **replayUpdateInputs** | **ReplayUpdateInputs**|  | |
+| **replayId** | [**string**] | The replay identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateReplay200Response**
+
+### 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/Video.md

@@ -15,11 +15,16 @@ Name | Type | Description | Notes
 **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]
 **downloadUrl** | **string** |  | [default to undefined]
 **hlsUrl** | **string** |  | [default to undefined]
 **dashUrl** | **string** |  | [default to undefined]
 **thumbnailPct** | **number** |  | [default to undefined]
+**stream** | [**VideoAllOfStream**](VideoAllOfStream.md) |  | [default to undefined]
+**streamSession** | [**VideoAllOfStreamSession**](VideoAllOfStreamSession.md) |  | [default to undefined]
+**replays** | [**Array<BaseReplay>**](BaseReplay.md) |  | [default to undefined]
 
 ## Example
 
@@ -37,11 +42,16 @@ const instance: Video = {
     previewUrl,
     readyToStream,
     duration,
+    streamId,
+    streamSessionId,
     createdAt,
     downloadUrl,
     hlsUrl,
     dashUrl,
     thumbnailPct,
+    stream,
+    streamSession,
+    replays,
 };
 ```
 

package/docs/VideoAllOfStream.md

@@ -0,0 +1,22 @@
+# VideoAllOfStream
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { VideoAllOfStream } from '@connectedxm/admin-sdk';
+
+const instance: VideoAllOfStream = {
+    id,
+    name,
+};
+```
+
+[[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/VideoAllOfStreamSession.md

@@ -0,0 +1,22 @@
+# VideoAllOfStreamSession
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**startedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { VideoAllOfStreamSession } from '@connectedxm/admin-sdk';
+
+const instance: VideoAllOfStreamSession = {
+    id,
+    startedAt,
+};
+```
+
+[[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": "16.13.0",
+  "version": "16.15.0",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {