# MeetingsLinksApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createMeetingLink**](#createmeetinglink) | **POST** /meetings/{meetingId}/links | Create a shareable meeting link|
|[**deleteMeetingLink**](#deletemeetinglink) | **DELETE** /meetings/{meetingId}/links/{linkId} | Delete a meeting link|
|[**getMeetingLink**](#getmeetinglink) | **GET** /meetings/{meetingId}/links/{linkId} | Get a single meeting link|
|[**getMeetingLinks**](#getmeetinglinks) | **GET** /meetings/{meetingId}/links | List a meeting\'s join links|
|[**updateMeetingLink**](#updatemeetinglink) | **PUT** /meetings/{meetingId}/links/{linkId} | Update a meeting link|

# **createMeetingLink**
> CreateMeetingLink200Response createMeetingLink(meetingLinkCreateInputs)

Creates a passcode-protected shareable join link for a meeting, auto-generating a unique passcode and associating the given name and preset; requires create and read permissions on meetings.

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

Permanently deletes a shareable meeting link identified by linkId from the given meeting, requiring both read and delete permissions on meetings.

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

Returns the details of one join link for the given meeting, including its passcode and configuration; requires the read permission on meetings.

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

Returns a paginated list of join links configured for the given meeting, with optional search by name; requires the read permission on meetings.

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

Updates the name, preset, or auth requirement of an existing shareable meeting link identified by linkId, requiring both read and update permissions on meetings.

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