@connectedxm/admin-sdk 1.0.0

package/docs/MeetingsApi.md

@@ -0,0 +1,385 @@
+# MeetingsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addMeetingLivestream**](#addmeetinglivestream) | **POST** /meetings/{meetingId}/livestream | Add Meeting Livestream|
+|[**createMeeting**](#createmeeting) | **POST** /meetings | Create Meeting|
+|[**getMeeting**](#getmeeting) | **GET** /meetings/{meetingId} | Get Meeting|
+|[**getMeetingLivestream**](#getmeetinglivestream) | **GET** /meetings/{meetingId}/livestream | Get Meeting Livestream|
+|[**getMeetings**](#getmeetings) | **GET** /meetings | Get Meetings|
+|[**joinMeeting**](#joinmeeting) | **GET** /meetings/{meetingId}/join | Join Meeting|
+|[**updateMeeting**](#updatemeeting) | **PUT** /meetings/{meetingId} | Update Meeting|
+
+# **addMeetingLivestream**
+> GetLivestream200Response addMeetingLivestream()
+
+Add Meeting Livestream endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsApi(configuration);
+
+let meetingId: string; //The meeting identifier (default to undefined)
+
+const { status, data } = await apiInstance.addMeetingLivestream(
+    meetingId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingId** | [**string**] | The meeting 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)
+
+# **createMeeting**
+> CreateMeeting200Response createMeeting(meetingCreateInputs)
+
+Create Meeting endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsApi,
+    Configuration,
+    MeetingCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsApi(configuration);
+
+let meetingCreateInputs: MeetingCreateInputs; //
+
+const { status, data } = await apiInstance.createMeeting(
+    meetingCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingCreateInputs** | **MeetingCreateInputs**|  | |
+
+
+### Return type
+
+**CreateMeeting200Response**
+
+### 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)
+
+# **getMeeting**
+> CreateMeeting200Response getMeeting()
+
+Get Meeting endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsApi(configuration);
+
+let meetingId: string; //The meeting identifier (default to undefined)
+
+const { status, data } = await apiInstance.getMeeting(
+    meetingId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateMeeting200Response**
+
+### 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)
+
+# **getMeetingLivestream**
+> GetLivestream200Response getMeetingLivestream()
+
+Get Meeting Livestream endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsApi(configuration);
+
+let meetingId: string; //The meeting identifier (default to undefined)
+
+const { status, data } = await apiInstance.getMeetingLivestream(
+    meetingId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingId** | [**string**] | The meeting 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)
+
+# **getMeetings**
+> GetMeetings200Response getMeetings()
+
+Get Meetings endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsApi(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.getMeetings(
+    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
+
+**GetMeetings200Response**
+
+### 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)
+
+# **joinMeeting**
+> ImpersonateAccount200Response joinMeeting()
+
+Join Meeting endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsApi(configuration);
+
+let meetingId: string; //The meeting identifier (default to undefined)
+
+const { status, data } = await apiInstance.joinMeeting(
+    meetingId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
+
+
+### Return type
+
+**ImpersonateAccount200Response**
+
+### 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)
+
+# **updateMeeting**
+> CreateMeeting200Response updateMeeting(meetingUpdateInputs)
+
+Update Meeting endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsApi,
+    Configuration,
+    MeetingUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsApi(configuration);
+
+let meetingId: string; //The meeting identifier (default to undefined)
+let meetingUpdateInputs: MeetingUpdateInputs; //
+
+const { status, data } = await apiInstance.updateMeeting(
+    meetingId,
+    meetingUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingUpdateInputs** | **MeetingUpdateInputs**|  | |
+| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateMeeting200Response**
+
+### 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/MeetingsLinksApi.md

@@ -0,0 +1,296 @@
+# MeetingsLinksApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createMeetingLink**](#createmeetinglink) | **POST** /meetings/{meetingId}/links | Create Meeting Link|
+|[**deleteMeetingLink**](#deletemeetinglink) | **DELETE** /meetings/{meetingId}/links/{linkId} | Delete Meeting Link|
+|[**getMeetingLink**](#getmeetinglink) | **GET** /meetings/{meetingId}/links/{linkId} | Get Meeting Link|
+|[**getMeetingLinks**](#getmeetinglinks) | **GET** /meetings/{meetingId}/links | Get Meeting Links|
+|[**updateMeetingLink**](#updatemeetinglink) | **PUT** /meetings/{meetingId}/links/{linkId} | Update Meeting Link|
+
+# **createMeetingLink**
+> CreateMeetingLink200Response createMeetingLink(meetingLinkCreateInputs)
+
+Create Meeting Link endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsLinksApi,
+    Configuration,
+    MeetingLinkCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsLinksApi(configuration);
+
+let meetingId: string; //The meeting identifier (default to undefined)
+let meetingLinkCreateInputs: MeetingLinkCreateInputs; //
+
+const { status, data } = await apiInstance.createMeetingLink(
+    meetingId,
+    meetingLinkCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingLinkCreateInputs** | **MeetingLinkCreateInputs**|  | |
+| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateMeetingLink200Response**
+
+### 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)
+
+# **deleteMeetingLink**
+> CreateAccountInvitations200Response deleteMeetingLink()
+
+Delete Meeting Link endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsLinksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsLinksApi(configuration);
+
+let meetingId: string; //The meeting identifier (default to undefined)
+let linkId: string; //The link identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteMeetingLink(
+    meetingId,
+    linkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
+| **linkId** | [**string**] | The link 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)
+
+# **getMeetingLink**
+> CreateMeetingLink200Response getMeetingLink()
+
+Get Meeting Link endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsLinksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsLinksApi(configuration);
+
+let meetingId: string; //The meeting identifier (default to undefined)
+let linkId: string; //The link identifier (default to undefined)
+
+const { status, data } = await apiInstance.getMeetingLink(
+    meetingId,
+    linkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
+| **linkId** | [**string**] | The link identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateMeetingLink200Response**
+
+### 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)
+
+# **getMeetingLinks**
+> GetMeetingLinks200Response getMeetingLinks()
+
+Get Meeting Links endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsLinksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsLinksApi(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.getMeetingLinks(
+    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
+
+**GetMeetingLinks200Response**
+
+### 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)
+
+# **updateMeetingLink**
+> CreateMeetingLink200Response updateMeetingLink(meetingLinkUpdateInputs)
+
+Update Meeting Link endpoint
+
+### Example
+
+```typescript
+import {
+    MeetingsLinksApi,
+    Configuration,
+    MeetingLinkUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeetingsLinksApi(configuration);
+
+let meetingId: string; //The meeting identifier (default to undefined)
+let linkId: string; //The link identifier (default to undefined)
+let meetingLinkUpdateInputs: MeetingLinkUpdateInputs; //
+
+const { status, data } = await apiInstance.updateMeetingLink(
+    meetingId,
+    linkId,
+    meetingLinkUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **meetingLinkUpdateInputs** | **MeetingLinkUpdateInputs**|  | |
+| **meetingId** | [**string**] | The meeting identifier | defaults to undefined|
+| **linkId** | [**string**] | The link identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateMeetingLink200Response**
+
+### 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)
+