@connectedxm/admin-sdk 1.0.0

package/docs/StreamsApi.md

@@ -0,0 +1,413 @@
+# StreamsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createStreamInput**](#createstreaminput) | **POST** /streams | Create Stream Input|
+|[**deleteStreamInput**](#deletestreaminput) | **DELETE** /streams/{streamId} | Delete Stream Input|
+|[**getStreamInput**](#getstreaminput) | **GET** /streams/{streamId} | Get Stream Input|
+|[**getStreamInputs**](#getstreaminputs) | **GET** /streams | Get Stream Inputs|
+|[**getStreamVideos**](#getstreamvideos) | **GET** /streams/{streamId}/videos | Get Stream Videos|
+|[**updateStream**](#updatestream) | **PUT** /streams/{streamId} | Update Stream|
+|[**updateStreamInputConfig**](#updatestreaminputconfig) | **PUT** /streams/{streamId}/config | Update Stream Input Config|
+
+# **createStreamInput**
+> CreateStreamInput200Response createStreamInput(streamInputCreateInputs)
+
+Create Stream Input endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsApi,
+    Configuration,
+    StreamInputCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsApi(configuration);
+
+let streamInputCreateInputs: StreamInputCreateInputs; //
+
+const { status, data } = await apiInstance.createStreamInput(
+    streamInputCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamInputCreateInputs** | **StreamInputCreateInputs**|  | |
+
+
+### Return type
+
+**CreateStreamInput200Response**
+
+### 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)
+
+# **deleteStreamInput**
+> CreateAccountInvitations200Response deleteStreamInput()
+
+Delete Stream Input endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsApi(configuration);
+
+let streamId: string; //The stream identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteStreamInput(
+    streamId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | The stream 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)
+
+# **getStreamInput**
+> CreateStreamInput200Response getStreamInput()
+
+Get Stream Input endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsApi(configuration);
+
+let streamId: string; //The stream identifier (default to undefined)
+
+const { status, data } = await apiInstance.getStreamInput(
+    streamId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | The stream identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateStreamInput200Response**
+
+### 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)
+
+# **getStreamInputs**
+> GetStreamInputs200Response getStreamInputs()
+
+Get Stream Inputs endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsApi(configuration);
+
+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 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.getStreamInputs(
+    eventId,
+    sessionId,
+    groupId,
+    meetingId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | Filter by eventId | (optional) defaults to undefined|
+| **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|
+| **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
+
+**GetStreamInputs200Response**
+
+### 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)
+
+# **getStreamVideos**
+> GetStreamVideos200Response getStreamVideos()
+
+Get Stream Videos endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsApi(configuration);
+
+let streamId: string; //The stream 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.getStreamVideos(
+    streamId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | The stream 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
+
+**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)
+
+# **updateStream**
+> CreateStreamInput200Response updateStream()
+
+Update Stream endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsApi,
+    Configuration,
+    StreamInputUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsApi(configuration);
+
+let streamId: string; //The stream identifier (default to undefined)
+let stream: StreamInputUpdateInputs; //Filter by stream (default to undefined)
+
+const { status, data } = await apiInstance.updateStream(
+    streamId,
+    stream
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | The stream identifier | defaults to undefined|
+| **stream** | **StreamInputUpdateInputs** | Filter by stream | defaults to undefined|
+
+
+### Return type
+
+**CreateStreamInput200Response**
+
+### 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)
+
+# **updateStreamInputConfig**
+> CreateStreamInput200Response updateStreamInputConfig(streamInputUpdateInputs)
+
+Update Stream Input Config endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsApi,
+    Configuration,
+    StreamInputUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsApi(configuration);
+
+let streamId: string; //The stream identifier (default to undefined)
+let streamInputUpdateInputs: StreamInputUpdateInputs; //
+
+const { status, data } = await apiInstance.updateStreamInputConfig(
+    streamId,
+    streamInputUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamInputUpdateInputs** | **StreamInputUpdateInputs**|  | |
+| **streamId** | [**string**] | The stream identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateStreamInput200Response**
+
+### 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/StreamsOutputsApi.md

@@ -0,0 +1,296 @@
+# StreamsOutputsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createStreamInputOutput**](#createstreaminputoutput) | **POST** /streams/{streamId}/outputs | Create Stream Input Output|
+|[**deleteStreamInputOutput**](#deletestreaminputoutput) | **DELETE** /streams/{streamId}/outputs/{outputId} | Delete Stream Input Output|
+|[**getStreamInputOutput**](#getstreaminputoutput) | **GET** /streams/{streamId}/outputs/{output} | Get Stream Input Output|
+|[**getStreamInputOutputs**](#getstreaminputoutputs) | **GET** /streams/{streamId}/outputs | Get Stream Input Outputs|
+|[**updateStreamInputOutput**](#updatestreaminputoutput) | **PUT** /streams/{streamId}/outputs/{outputId} | Update Stream Input Output|
+
+# **createStreamInputOutput**
+> CreateAccountAddress200Response createStreamInputOutput(streamInputOutputCreateInputs)
+
+Create Stream Input Output endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsOutputsApi,
+    Configuration,
+    StreamInputOutputCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsOutputsApi(configuration);
+
+let streamId: string; //The stream identifier (default to undefined)
+let streamInputOutputCreateInputs: StreamInputOutputCreateInputs; //
+
+const { status, data } = await apiInstance.createStreamInputOutput(
+    streamId,
+    streamInputOutputCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamInputOutputCreateInputs** | **StreamInputOutputCreateInputs**|  | |
+| **streamId** | [**string**] | The stream identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+
+# **deleteStreamInputOutput**
+> CreateAccountInvitations200Response deleteStreamInputOutput()
+
+Delete Stream Input Output endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsOutputsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsOutputsApi(configuration);
+
+let streamId: string; //The stream identifier (default to undefined)
+let outputId: string; //The output identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteStreamInputOutput(
+    streamId,
+    outputId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | The stream identifier | defaults to undefined|
+| **outputId** | [**string**] | The output 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)
+
+# **getStreamInputOutput**
+> CreateAccountAddress200Response getStreamInputOutput()
+
+Get Stream Input Output endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsOutputsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsOutputsApi(configuration);
+
+let streamId: string; //The stream identifier (default to undefined)
+let output: string; //The output identifier (default to undefined)
+
+const { status, data } = await apiInstance.getStreamInputOutput(
+    streamId,
+    output
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | The stream identifier | defaults to undefined|
+| **output** | [**string**] | The output 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)
+
+# **getStreamInputOutputs**
+> GetAccountInvitations200Response getStreamInputOutputs()
+
+Get Stream Input Outputs endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsOutputsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsOutputsApi(configuration);
+
+let streamId: string; //The stream 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.getStreamInputOutputs(
+    streamId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | The stream 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
+
+**GetAccountInvitations200Response**
+
+### 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)
+
+# **updateStreamInputOutput**
+> CreateAccountAddress200Response updateStreamInputOutput()
+
+Update Stream Input Output endpoint
+
+### Example
+
+```typescript
+import {
+    StreamsOutputsApi,
+    Configuration,
+    StreamInputOutputUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsOutputsApi(configuration);
+
+let streamId: string; //The stream identifier (default to undefined)
+let outputId: string; //The output identifier (default to undefined)
+let output: StreamInputOutputUpdateInputs; //Filter by output (default to undefined)
+
+const { status, data } = await apiInstance.updateStreamInputOutput(
+    streamId,
+    outputId,
+    output
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **streamId** | [**string**] | The stream identifier | defaults to undefined|
+| **outputId** | [**string**] | The output identifier | defaults to undefined|
+| **output** | **StreamInputOutputUpdateInputs** | Filter by output | 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)
+