@connectedxm/admin-sdk 1.0.0

package/docs/MeetingsLivestreamsApi.md

@@ -0,0 +1,340 @@
+# MeetingsLivestreamsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**disableLivestream**](#disablelivestream) | **POST** /meetings/livestreams/{livestreamId}/disable | Disable Livestream|
+|[**enableLivestream**](#enablelivestream) | **POST** /meetings/livestreams/{livestreamId}/enable | Enable Livestream|
+|[**getLivestream**](#getlivestream) | **GET** /meetings/livestreams/{livestreamId} | Get Livestream|
+|[**getLivestreamSessions**](#getlivestreamsessions) | **GET** /meetings/livestreams/{livestreamId}/sessions | Get Livestream Sessions|
+|[**getLivestreams**](#getlivestreams) | **GET** /meetings/livestreams | Get Livestreams|
+|[**resetLivestreamStreamKey**](#resetlivestreamstreamkey) | **POST** /meetings/livestreams/{livestreamId}/reset-stream-key | Reset Livestream Stream Key|
+
+# **disableLivestream**
+> GetLivestream200Response disableLivestream()
+
+Disable Livestream endpoint
+
+### 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()
+
+Enable Livestream endpoint
+
+### 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()
+
+Get Livestream endpoint
+
+### 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**
+> GetAccountInvitations200Response getLivestreamSessions()
+
+Get Livestream Sessions endpoint
+
+### 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
+
+**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)
+
+# **getLivestreams**
+> GetLivestreams200Response getLivestreams()
+
+Get Livestreams endpoint
+
+### 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**
+> CreateAccountAddress200Response resetLivestreamStreamKey()
+
+Reset Livestream Stream Key endpoint
+
+### 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
+
+**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)
+

package/docs/MeetingsParticipantsApi.md

@@ -0,0 +1,351 @@
+# MeetingsParticipantsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createMeetingParticipant**](#createmeetingparticipant) | **POST** /meetings/{meetingId}/participants | Create Meeting Participant|
+|[**deleteMeetingParticipant**](#deletemeetingparticipant) | **DELETE** /meetings/{meetingId}/participants/{participantId} | Delete Meeting Participant|
+|[**getMeetingParticipant**](#getmeetingparticipant) | **GET** /meetings/{meetingId}/participants/{participantId} | Get Meeting Participant|
+|[**getMeetingParticipants**](#getmeetingparticipants) | **GET** /meetings/{meetingId}/participants | Get Meeting Participants|
+|[**regenerateMeetingParticipantToken**](#regeneratemeetingparticipanttoken) | **POST** /meetings/{meetingId}/participants/{participantId}/regenerate | Regenerate Meeting Participant Token|
+|[**updateMeetingParticipant**](#updatemeetingparticipant) | **PUT** /meetings/{meetingId}/participants/{participantId} | Update Meeting Participant|
+
+# **createMeetingParticipant**
+> CreateAccountAddress200Response createMeetingParticipant(meetingParticipantCreateInputs)
+
+Create Meeting Participant endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsParticipantsApi,
+    Configuration,
+    MeetingParticipantCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsParticipantsApi(configuration);
+
+let meetingId: string; //The meeting identifier (default to undefined)
+let meetingParticipantCreateInputs: MeetingParticipantCreateInputs; //
+
+const { status, data } = await apiInstance.createMeetingParticipant(
+    meetingId,
+    meetingParticipantCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingParticipantCreateInputs** | **MeetingParticipantCreateInputs**|  | |
+| **meetingId** | [**string**] | The meeting 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)
+
+# **deleteMeetingParticipant**
+> CreateAccountInvitations200Response deleteMeetingParticipant()
+
+Delete Meeting Participant endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsParticipantsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsParticipantsApi(configuration);
+
+let meetingId: string; //The meeting identifier (default to undefined)
+let participantId: string; //The participant identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteMeetingParticipant(
+    meetingId,
+    participantId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
+| **participantId** | [**string**] | The participant 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)
+
+# **getMeetingParticipant**
+> CreateAccountAddress200Response getMeetingParticipant()
+
+Get Meeting Participant endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsParticipantsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsParticipantsApi(configuration);
+
+let meetingId: string; //The meeting identifier (default to undefined)
+let participantId: string; //The participant identifier (default to undefined)
+
+const { status, data } = await apiInstance.getMeetingParticipant(
+    meetingId,
+    participantId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
+| **participantId** | [**string**] | The participant 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)
+
+# **getMeetingParticipants**
+> GetAccountInvitations200Response getMeetingParticipants()
+
+Get Meeting Participants endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsParticipantsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsParticipantsApi(configuration);
+
+let meetingId: string; //The meeting 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.getMeetingParticipants(
+    meetingId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingId** | [**string**] | The meeting 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)
+
+# **regenerateMeetingParticipantToken**
+> CreateAccountAddress200Response regenerateMeetingParticipantToken()
+
+Regenerate Meeting Participant Token endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsParticipantsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsParticipantsApi(configuration);
+
+let meetingId: string; //The meeting identifier (default to undefined)
+let participantId: string; //The participant identifier (default to undefined)
+
+const { status, data } = await apiInstance.regenerateMeetingParticipantToken(
+    meetingId,
+    participantId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
+| **participantId** | [**string**] | The participant 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)
+
+# **updateMeetingParticipant**
+> CreateAccountAddress200Response updateMeetingParticipant(meetingParticipantUpdateInputs)
+
+Update Meeting Participant endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsParticipantsApi,
+    Configuration,
+    MeetingParticipantUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsParticipantsApi(configuration);
+
+let meetingId: string; //The meeting identifier (default to undefined)
+let participantId: string; //The participant identifier (default to undefined)
+let meetingParticipantUpdateInputs: MeetingParticipantUpdateInputs; //
+
+const { status, data } = await apiInstance.updateMeetingParticipant(
+    meetingId,
+    participantId,
+    meetingParticipantUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingParticipantUpdateInputs** | **MeetingParticipantUpdateInputs**|  | |
+| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
+| **participantId** | [**string**] | The participant 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)
+