# MeetingsApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addMeetingLivestream**](#addmeetinglivestream) | **POST** /meetings/{meetingId}/livestream | Add a livestream to a meeting|
|[**createMeeting**](#createmeeting) | **POST** /meetings | Create a meeting|
|[**getMeeting**](#getmeeting) | **GET** /meetings/{meetingId} | Get a meeting|
|[**getMeetingLivestream**](#getmeetinglivestream) | **GET** /meetings/{meetingId}/livestream | Get a meeting\'s livestream|
|[**getMeetings**](#getmeetings) | **GET** /meetings | List meetings|
|[**joinMeeting**](#joinmeeting) | **GET** /meetings/{meetingId}/join | Join a meeting as the current admin|
|[**updateMeeting**](#updatemeeting) | **PUT** /meetings/{meetingId} | Update a meeting|

# **addMeetingLivestream**
> GetLivestream200Response addMeetingLivestream()

Creates and attaches a new livestream to the given meeting so it can be broadcast, requiring the \"create\" permission on meetings.

### 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)

Creates a new video meeting for the organization, optionally linked to an event, event session, group, activity, or booking space, and configured with recording, chat, livestream, and AI settings, requiring the \"create\" permission on meetings.

### 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()

Returns the details of a single meeting by its ID, requires the \"read\" permission on meetings.

### 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()

Returns the livestream configuration associated with the given meeting, requires the \"read\" permission on meetings.

### 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()

Returns a paginated list of meetings for the organization, supports search and requires the \"read\" permission on meetings.

### 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**
> JoinMeeting200Response joinMeeting()

Generates a join token for the authenticated admin user to enter the given meeting as a participant, requiring the \"read\" permission on meetings.

### 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

**JoinMeeting200Response**

### 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)

Updates the settings of an existing meeting, such as its title, recording, chat, livestream, or AI configuration, requiring the \"update\" permission on meetings.

### 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)