@connectedxm/admin-sdk 16.16.3 → 18.0.0

package/docs/MeetingsLivestreamsApi.md

@@ -1,340 +0,0 @@
-# MeetingsLivestreamsApi
-
-All URIs are relative to *https://admin-api.connected.dev*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**disableLivestream**](#disablelivestream) | **POST** /meetings/livestreams/{livestreamId}/disable | Disable a livestream|
-|[**enableLivestream**](#enablelivestream) | **POST** /meetings/livestreams/{livestreamId}/enable | Enable a livestream|
-|[**getLivestream**](#getlivestream) | **GET** /meetings/livestreams/{livestreamId} | Get a livestream|
-|[**getLivestreamSessions**](#getlivestreamsessions) | **GET** /meetings/livestreams/{livestreamId}/sessions | List a livestream\'s sessions|
-|[**getLivestreams**](#getlivestreams) | **GET** /meetings/livestreams | List livestreams|
-|[**resetLivestreamStreamKey**](#resetlivestreamstreamkey) | **POST** /meetings/livestreams/{livestreamId}/reset-stream-key | Reset a livestream\'s stream key|
-
-# **disableLivestream**
-> GetLivestream200Response disableLivestream()
-
-Disables the livestream identified by livestreamId so it can no longer ingest or broadcast, requiring both read and create permissions on meetings.
-
-### Example
-
-```typescript
-import {
-    MeetingsLivestreamsApi,
-    Configuration
-} from '@connectedxm/admin-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new MeetingsLivestreamsApi(configuration);
-
-let livestreamId: string; //The livestream identifier (default to undefined)
-
-const { status, data } = await apiInstance.disableLivestream(
-    livestreamId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **livestreamId** | [**string**] | The livestream identifier | defaults to undefined|
-
-
-### Return type
-
-**GetLivestream200Response**
-
-### 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)
-
-# **enableLivestream**
-> GetLivestream200Response enableLivestream()
-
-Enables the livestream identified by livestreamId so it can begin ingesting and broadcasting, requiring both read and create permissions on meetings.
-
-### Example
-
-```typescript
-import {
-    MeetingsLivestreamsApi,
-    Configuration
-} from '@connectedxm/admin-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new MeetingsLivestreamsApi(configuration);
-
-let livestreamId: string; //The livestream identifier (default to undefined)
-
-const { status, data } = await apiInstance.enableLivestream(
-    livestreamId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **livestreamId** | [**string**] | The livestream identifier | defaults to undefined|
-
-
-### Return type
-
-**GetLivestream200Response**
-
-### 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)
-
-# **getLivestream**
-> GetLivestream200Response getLivestream()
-
-Returns details for a single livestream by ID, including its Cloudflare RealtimeKit status and stream key; requires \"read\" permission on meetings.
-
-### Example
-
-```typescript
-import {
-    MeetingsLivestreamsApi,
-    Configuration
-} from '@connectedxm/admin-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new MeetingsLivestreamsApi(configuration);
-
-let livestreamId: string; //The livestream identifier (default to undefined)
-
-const { status, data } = await apiInstance.getLivestream(
-    livestreamId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **livestreamId** | [**string**] | The livestream identifier | defaults to undefined|
-
-
-### Return type
-
-**GetLivestream200Response**
-
-### 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)
-
-# **getLivestreamSessions**
-> GetLivestreamSessions200Response getLivestreamSessions()
-
-Returns a paginated list of sessions that occurred on the given livestream, supporting page and pageSize parameters; requires \"read\" permission on meetings.
-
-### Example
-
-```typescript
-import {
-    MeetingsLivestreamsApi,
-    Configuration
-} from '@connectedxm/admin-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new MeetingsLivestreamsApi(configuration);
-
-let livestreamId: string; //The livestream 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.getLivestreamSessions(
-    livestreamId,
-    page,
-    pageSize,
-    orderBy,
-    search
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **livestreamId** | [**string**] | The livestream 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
-
-**GetLivestreamSessions200Response**
-
-### 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)
-
-# **getLivestreams**
-> GetLivestreams200Response getLivestreams()
-
-Returns a paginated list of livestreams for the organization\'s meetings app, supporting page, pageSize, orderBy, and search parameters; requires \"read\" permission on meetings.
-
-### Example
-
-```typescript
-import {
-    MeetingsLivestreamsApi,
-    Configuration
-} from '@connectedxm/admin-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new MeetingsLivestreamsApi(configuration);
-
-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.getLivestreams(
-    page,
-    pageSize,
-    orderBy,
-    search
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **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
-
-**GetLivestreams200Response**
-
-### 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)
-
-# **resetLivestreamStreamKey**
-> GetLivestream200Response resetLivestreamStreamKey()
-
-Rotates the ingest stream key for the livestream identified by livestreamId, invalidating the previous key, and requires both read and create permissions on meetings.
-
-### Example
-
-```typescript
-import {
-    MeetingsLivestreamsApi,
-    Configuration
-} from '@connectedxm/admin-sdk';
-
-const configuration = new Configuration();
-const apiInstance = new MeetingsLivestreamsApi(configuration);
-
-let livestreamId: string; //The livestream identifier (default to undefined)
-
-const { status, data } = await apiInstance.resetLivestreamStreamKey(
-    livestreamId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **livestreamId** | [**string**] | The livestream identifier | defaults to undefined|
-
-
-### Return type
-
-**GetLivestream200Response**
-
-### 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)
-