@connectedxm/admin-sdk 1.0.0

package/docs/VideosApi.md

@@ -0,0 +1,387 @@
+# VideosApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteManyVideos**](#deletemanyvideos) | **POST** /videos/delete | Delete Many Videos|
+|[**deleteVideo**](#deletevideo) | **DELETE** /videos/{videoId} | Delete Video|
+|[**getVideo**](#getvideo) | **GET** /videos/{videoId} | Get Video|
+|[**getVideoDownloadStatus**](#getvideodownloadstatus) | **GET** /videos/{videoId}/downloads | Get Video Download Status|
+|[**getVideos**](#getvideos) | **GET** /videos | Get Videos|
+|[**initiateVideoDownload**](#initiatevideodownload) | **POST** /videos/{videoId}/downloads | Initiate Video Download|
+|[**updateVideo**](#updatevideo) | **PUT** /videos/{videoId} | Update Video|
+
+# **deleteManyVideos**
+> CreateAccountInvitations200Response deleteManyVideos()
+
+Delete Many Videos endpoint
+
+### Example
+
+```typescript
+import {
+    VideosApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new VideosApi(configuration);
+
+let videoIds: Array<string>; //Filter by videoIds (default to undefined)
+
+const { status, data } = await apiInstance.deleteManyVideos(
+    videoIds
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **videoIds** | **Array&lt;string&gt;** | Filter by videoIds | 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)
+
+# **deleteVideo**
+> CreateAccountInvitations200Response deleteVideo()
+
+Delete Video endpoint
+
+### Example
+
+```typescript
+import {
+    VideosApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new VideosApi(configuration);
+
+let videoId: string; //The video identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteVideo(
+    videoId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **videoId** | [**string**] | The video 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)
+
+# **getVideo**
+> GetVideo200Response getVideo()
+
+Get Video endpoint
+
+### Example
+
+```typescript
+import {
+    VideosApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new VideosApi(configuration);
+
+let videoId: string; //The video identifier (default to undefined)
+
+const { status, data } = await apiInstance.getVideo(
+    videoId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **videoId** | [**string**] | The video identifier | defaults to undefined|
+
+
+### Return type
+
+**GetVideo200Response**
+
+### 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)
+
+# **getVideoDownloadStatus**
+> CreateAccountAddress200Response getVideoDownloadStatus()
+
+Get Video Download Status endpoint
+
+### Example
+
+```typescript
+import {
+    VideosApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new VideosApi(configuration);
+
+let videoId: string; //The video identifier (default to undefined)
+
+const { status, data } = await apiInstance.getVideoDownloadStatus(
+    videoId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **videoId** | [**string**] | The video identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+
+# **getVideos**
+> GetStreamVideos200Response getVideos()
+
+Get Videos endpoint
+
+### Example
+
+```typescript
+import {
+    VideosApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new VideosApi(configuration);
+
+let source: string; //Filter by source (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.getVideos(
+    source,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **source** | [**string**] | Filter by source | (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
+
+**GetStreamVideos200Response**
+
+### 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)
+
+# **initiateVideoDownload**
+> CreateAccountAddress200Response initiateVideoDownload()
+
+Initiate Video Download endpoint
+
+### Example
+
+```typescript
+import {
+    VideosApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new VideosApi(configuration);
+
+let videoId: string; //The video identifier (default to undefined)
+
+const { status, data } = await apiInstance.initiateVideoDownload(
+    videoId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **videoId** | [**string**] | The video identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+
+# **updateVideo**
+> GetVideo200Response updateVideo(videoUpdateInputs)
+
+Update Video endpoint
+
+### Example
+
+```typescript
+import {
+    VideosApi,
+    Configuration,
+    VideoUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new VideosApi(configuration);
+
+let videoId: string; //The video identifier (default to undefined)
+let videoUpdateInputs: VideoUpdateInputs; //
+
+const { status, data } = await apiInstance.updateVideo(
+    videoId,
+    videoUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **videoUpdateInputs** | **VideoUpdateInputs**|  | |
+| **videoId** | [**string**] | The video identifier | defaults to undefined|
+
+
+### Return type
+
+**GetVideo200Response**
+
+### 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/VideosCaptionsApi.md

@@ -0,0 +1,297 @@
+# VideosCaptionsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteVideoCaption**](#deletevideocaption) | **DELETE** /videos/{videoId}/captions/{language} | Delete Video Caption|
+|[**downloadVideoCaption**](#downloadvideocaption) | **GET** /videos/{videoId}/captions/{language}/download | Download Video Caption|
+|[**generateVideoCaptions**](#generatevideocaptions) | **POST** /videos/{videoId}/captions/{language}/generate | Generate Video Captions|
+|[**getVideoCaptions**](#getvideocaptions) | **GET** /videos/{videoId}/captions | Get Video Captions|
+|[**uploadVideoCaptions**](#uploadvideocaptions) | **PUT** /videos/{videoId}/captions/{language} | Upload Video Captions|
+
+# **deleteVideoCaption**
+> CreateAccountInvitations200Response deleteVideoCaption()
+
+Delete Video Caption endpoint
+
+### Example
+
+```typescript
+import {
+    VideosCaptionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new VideosCaptionsApi(configuration);
+
+let videoId: string; //The video identifier (default to undefined)
+let language: string; //The language identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteVideoCaption(
+    videoId,
+    language
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **videoId** | [**string**] | The video identifier | defaults to undefined|
+| **language** | [**string**] | The language 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)
+
+# **downloadVideoCaption**
+> CreateAccountAddress200Response downloadVideoCaption()
+
+Download Video Caption endpoint
+
+### Example
+
+```typescript
+import {
+    VideosCaptionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new VideosCaptionsApi(configuration);
+
+let videoId: string; //The video identifier (default to undefined)
+let language: string; //The language identifier (default to undefined)
+
+const { status, data } = await apiInstance.downloadVideoCaption(
+    videoId,
+    language
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **videoId** | [**string**] | The video identifier | defaults to undefined|
+| **language** | [**string**] | The language identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+
+# **generateVideoCaptions**
+> UploadVideoCaptions200Response generateVideoCaptions()
+
+Generate Video Captions endpoint
+
+### Example
+
+```typescript
+import {
+    VideosCaptionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new VideosCaptionsApi(configuration);
+
+let videoId: string; //The video identifier (default to undefined)
+let language: string; //The language identifier (default to undefined)
+
+const { status, data } = await apiInstance.generateVideoCaptions(
+    videoId,
+    language
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **videoId** | [**string**] | The video identifier | defaults to undefined|
+| **language** | [**string**] | The language identifier | defaults to undefined|
+
+
+### Return type
+
+**UploadVideoCaptions200Response**
+
+### 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)
+
+# **getVideoCaptions**
+> GetVideoCaptions200Response getVideoCaptions()
+
+Get Video Captions endpoint
+
+### Example
+
+```typescript
+import {
+    VideosCaptionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new VideosCaptionsApi(configuration);
+
+let videoId: string; //The video 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.getVideoCaptions(
+    videoId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **videoId** | [**string**] | The video 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
+
+**GetVideoCaptions200Response**
+
+### 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)
+
+# **uploadVideoCaptions**
+> UploadVideoCaptions200Response uploadVideoCaptions()
+
+Upload Video Captions endpoint
+
+### Example
+
+```typescript
+import {
+    VideosCaptionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new VideosCaptionsApi(configuration);
+
+let videoId: string; //The video identifier (default to undefined)
+let language: string; //The language identifier (default to undefined)
+let file: string; //Filter by file (default to undefined)
+let filename: string; //Filter by filename (optional) (default to undefined)
+
+const { status, data } = await apiInstance.uploadVideoCaptions(
+    videoId,
+    language,
+    file,
+    filename
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **videoId** | [**string**] | The video identifier | defaults to undefined|
+| **language** | [**string**] | The language identifier | defaults to undefined|
+| **file** | [**string**] | Filter by file | defaults to undefined|
+| **filename** | [**string**] | Filter by filename | (optional) defaults to undefined|
+
+
+### Return type
+
+**UploadVideoCaptions200Response**
+
+### 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/Webhook.md

@@ -0,0 +1,22 @@
+# Webhook
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Webhook } from '@connectedxm/admin-sdk';
+
+const instance: Webhook = {
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)