# EventsRoomsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addRoomToRoomType**](#addroomtoroomtype) | **POST** /events/{eventId}/roomTypes/{roomTypeId}/rooms | Add a room to a room type|
|[**createRoom**](#createroom) | **POST** /events/{eventId}/rooms | Create an event room|
|[**deleteRoom**](#deleteroom) | **DELETE** /events/{eventId}/rooms/{roomId} | Delete an event room|
|[**getRoom**](#getroom) | **GET** /events/{eventId}/rooms/{roomId} | Get a single event room|
|[**getRoomTypeRooms**](#getroomtyperooms) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/rooms | List rooms belonging to a room type|
|[**getRooms**](#getrooms) | **GET** /events/{eventId}/rooms | List an event\'s rooms|
|[**importRooms**](#importrooms) | **POST** /events/{eventId}/rooms/import | Bulk import event rooms by name|
|[**removeRoomFromRoomType**](#removeroomfromroomtype) | **DELETE** /events/{eventId}/roomTypes/{roomTypeId}/rooms/{roomId} | Remove a room from a room type|
|[**updateRoom**](#updateroom) | **PUT** /events/{eventId}/rooms/{roomId} | Update an event room|

# **addRoomToRoomType**
> CreateEventRoomType200Response addRoomToRoomType(addRoomToRoomTypeRequest)

Connects an existing event room to a room type, verifying the room belongs to the same event, and requires update permission on events.

### Example

```typescript
import {
    EventsRoomsApi,
    Configuration,
    AddRoomToRoomTypeRequest
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsRoomsApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let roomTypeId: string; //The roomType identifier (default to undefined)
let addRoomToRoomTypeRequest: AddRoomToRoomTypeRequest; //

const { status, data } = await apiInstance.addRoomToRoomType(
    eventId,
    roomTypeId,
    addRoomToRoomTypeRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **addRoomToRoomTypeRequest** | **AddRoomToRoomTypeRequest**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **roomTypeId** | [**string**] | The roomType identifier | defaults to undefined|


### Return type

**CreateEventRoomType200Response**

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

# **createRoom**
> CreateRoom200Response createRoom(roomCreateInputs)

Creates a new room for an event, such as a physical or virtual space used for sessions, and requires update permission on events.

### Example

```typescript
import {
    EventsRoomsApi,
    Configuration,
    RoomCreateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsRoomsApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let roomCreateInputs: RoomCreateInputs; //

const { status, data } = await apiInstance.createRoom(
    eventId,
    roomCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **roomCreateInputs** | **RoomCreateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|


### Return type

**CreateRoom200Response**

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

# **deleteRoom**
> CreateAccountInvitations200Response deleteRoom()

Permanently deletes a room from an event and requires update permission on events.

### Example

```typescript
import {
    EventsRoomsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsRoomsApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let roomId: string; //The room identifier (default to undefined)

const { status, data } = await apiInstance.deleteRoom(
    eventId,
    roomId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **roomId** | [**string**] | The room 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)

# **getRoom**
> CreateRoom200Response getRoom()

Returns the details of a single room belonging to an event, verifying the room belongs to the given event and organization before returning it; requires read access to the event.

### Example

```typescript
import {
    EventsRoomsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsRoomsApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let roomId: string; //The room identifier (default to undefined)

const { status, data } = await apiInstance.getRoom(
    eventId,
    roomId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **roomId** | [**string**] | The room identifier | defaults to undefined|


### Return type

**CreateRoom200Response**

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

# **getRoomTypeRooms**
> GetRoomTypeRooms200Response getRoomTypeRooms()

Returns a paginated list of rooms assigned to a specific room type on an event, ordered by room name by default and filterable by search against the room name; requires read access to the event.

### Example

```typescript
import {
    EventsRoomsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsRoomsApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let roomTypeId: string; //The roomType 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.getRoomTypeRooms(
    eventId,
    roomTypeId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **roomTypeId** | [**string**] | The roomType 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

**GetRoomTypeRooms200Response**

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

# **getRooms**
> GetRoomTypeRooms200Response getRooms()

Returns a paginated list of rooms belonging to an event, ordered by room name by default and filterable by search against the room name; requires read access to the event.

### Example

```typescript
import {
    EventsRoomsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsRoomsApi(configuration);

let eventId: string; //The event 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.getRooms(
    eventId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event 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

**GetRoomTypeRooms200Response**

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

# **importRooms**
> ImportRooms200Response importRooms(importRoomsRequest)

Bulk-creates event rooms from a list of room names, skipping any names that already exist for the event, and optionally assigns the newly created rooms to a room type; requires update permission on events.

### Example

```typescript
import {
    EventsRoomsApi,
    Configuration,
    ImportRoomsRequest
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsRoomsApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let importRoomsRequest: ImportRoomsRequest; //

const { status, data } = await apiInstance.importRooms(
    eventId,
    importRoomsRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **importRoomsRequest** | **ImportRoomsRequest**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|


### Return type

**ImportRooms200Response**

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

# **removeRoomFromRoomType**
> CreateEventRoomType200Response removeRoomFromRoomType()

Disconnects a room from a room type without deleting the room itself, and requires update permission on events.

### Example

```typescript
import {
    EventsRoomsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsRoomsApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let roomTypeId: string; //The roomType identifier (default to undefined)
let roomId: string; //The room identifier (default to undefined)

const { status, data } = await apiInstance.removeRoomFromRoomType(
    eventId,
    roomTypeId,
    roomId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **roomTypeId** | [**string**] | The roomType identifier | defaults to undefined|
| **roomId** | [**string**] | The room identifier | defaults to undefined|


### Return type

**CreateEventRoomType200Response**

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

# **updateRoom**
> CreateRoom200Response updateRoom(roomUpdateInputs)

Updates the fields of an existing event room, such as its name or capacity, and requires update permission on events.

### Example

```typescript
import {
    EventsRoomsApi,
    Configuration,
    RoomUpdateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsRoomsApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let roomId: string; //The room identifier (default to undefined)
let roomUpdateInputs: RoomUpdateInputs; //

const { status, data } = await apiInstance.updateRoom(
    eventId,
    roomId,
    roomUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **roomUpdateInputs** | **RoomUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **roomId** | [**string**] | The room identifier | defaults to undefined|


### Return type

**CreateRoom200Response**

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