# EventsRoomtypesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addEventRoomTypeTier**](#addeventroomtypetier) | **POST** /events/{eventId}/roomTypes/{roomTypeId}/tiers/{tierId} | Add an account tier to a room type|
|[**createEventRoomType**](#createeventroomtype) | **POST** /events/{eventId}/roomTypes | Create an event room type|
|[**deleteEventRoomType**](#deleteeventroomtype) | **DELETE** /events/{eventId}/roomTypes/{roomTypeId} | Delete an event room type|
|[**getEventRoomType**](#geteventroomtype) | **GET** /events/{eventId}/roomTypes/{roomTypeId} | Get an event room type|
|[**getEventRoomTypePasses**](#geteventroomtypepasses) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/passes | List purchases for an event room type|
|[**getEventRoomTypeReservations**](#geteventroomtypereservations) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/reservations | List reservations for an event room type|
|[**getEventRoomTypeTiers**](#geteventroomtypetiers) | **GET** /events/{eventId}/roomTypes/{roomTypeId}/tiers | List account tiers allowed or disallowed for a room type|
|[**getEventRoomTypes**](#geteventroomtypes) | **GET** /events/{eventId}/roomTypes | List an event\&#39;s room types|
|[**removeEventRoomTypeTier**](#removeeventroomtypetier) | **DELETE** /events/{eventId}/roomTypes/{roomTypeId}/tiers/{tierId} | Remove an account tier from a room type|
|[**updateEventRoomType**](#updateeventroomtype) | **PUT** /events/{eventId}/roomTypes/{roomTypeId} | Update an event room type|
|[**updateEventRoomTypeAddOnDetails**](#updateeventroomtypeaddondetails) | **PUT** /events/{eventId}/roomTypes/{roomTypeId}/addOns/{addOnId} | Update a room type\&#39;s add-on details|
|[**updateEventRoomTypePassTypeDetails**](#updateeventroomtypepasstypedetails) | **PUT** /events/{eventId}/roomTypes/{roomTypeId}/passTypes/{passTypeId} | Update a room type\&#39;s pass type details|

# **addEventRoomTypeTier**
> CreateEventRoomType200Response addEventRoomTypeTier(addEventAddOnTierRequest)

Adds an account tier to a room type\'s allowed or disallowed tier list depending on the `allowed` flag, controlling which member tiers may book the room type, and requires the update permission on events plus read permission on tiers.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let roomTypeId: string; //The roomType identifier (default to undefined)
let tierId: string; //The tier identifier (default to undefined)
let addEventAddOnTierRequest: AddEventAddOnTierRequest; //

const { status, data } = await apiInstance.addEventRoomTypeTier(
    eventId,
    roomTypeId,
    tierId,
    addEventAddOnTierRequest
);
```

### Parameters

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

# **createEventRoomType**
> CreateEventRoomType200Response createEventRoomType(eventRoomTypeCreateInputs)

Creates a new room type (a bookable room/reservation category) for the given event, requiring the update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let eventRoomTypeCreateInputs: EventRoomTypeCreateInputs; //

const { status, data } = await apiInstance.createEventRoomType(
    eventId,
    eventRoomTypeCreateInputs
);
```

### Parameters

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

# **deleteEventRoomType**
> CreateAccountInvitations200Response deleteEventRoomType()

Permanently deletes a room type from the given event, requiring the update permission on events.

### Example

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

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

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

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

### Parameters

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

# **getEventRoomType**
> CreateEventRoomType200Response getEventRoomType()

Retrieves a single room type for the given event by ID, including its configured details; requires read permission on events.

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **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**: 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)

# **getEventRoomTypePasses**
> GetEventAddOnPasses200Response getEventRoomTypePasses()

Returns a paginated list of pass purchases tied to reservations for the specified event room type, supporting search by attendee name, email, purchase ID, or response value; requires read permission on events and attendees.

### Example

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

const configuration = new Configuration();
const apiInstance = new EventsRoomtypesApi(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.getEventRoomTypePasses(
    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

**GetEventAddOnPasses200Response**

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

# **getEventRoomTypeReservations**
> GetEventRegistrationReservations200Response getEventRoomTypeReservations()

Returns a paginated list of room reservations made for the specified event room type, searchable by pass name or attendee name/email; requires read permission on events and attendees.

### Example

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

const configuration = new Configuration();
const apiInstance = new EventsRoomtypesApi(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.getEventRoomTypeReservations(
    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

**GetEventRegistrationReservations200Response**

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

# **getEventRoomTypeTiers**
> GetAccountTiers200Response getEventRoomTypeTiers()

Returns a paginated list of account tiers that are either allowed or disallowed to book the specified event room type, selected via the required allowed flag and searchable by name or description; requires read permission on events and tiers.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let roomTypeId: string; //The roomType identifier (default to undefined)
let allowed: boolean; //Filter by allowed (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.getEventRoomTypeTiers(
    eventId,
    roomTypeId,
    allowed,
    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|
| **allowed** | [**boolean**] | Filter by allowed | 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

**GetAccountTiers200Response**

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

# **getEventRoomTypes**
> GetEventRoomTypes200Response getEventRoomTypes()

Returns a paginated list of room types configured for the given event, searchable by name or description; requires read permission on events.

### Example

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

const configuration = new Configuration();
const apiInstance = new EventsRoomtypesApi(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.getEventRoomTypes(
    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

**GetEventRoomTypes200Response**

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

# **removeEventRoomTypeTier**
> CreateEventRoomType200Response removeEventRoomTypeTier()

Removes an account tier from a room type\'s allowed or disallowed tier list depending on the `allowed` flag, requiring the update permission on events plus read permission on tiers.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let roomTypeId: string; //The roomType identifier (default to undefined)
let tierId: string; //The tier identifier (default to undefined)
let allowed: boolean; //Filter by allowed (default to undefined)

const { status, data } = await apiInstance.removeEventRoomTypeTier(
    eventId,
    roomTypeId,
    tierId,
    allowed
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **roomTypeId** | [**string**] | The roomType identifier | defaults to undefined|
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
| **allowed** | [**boolean**] | Filter by allowed | 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)

# **updateEventRoomType**
> CreateEventRoomType200Response updateEventRoomType(eventRoomTypeUpdateInputs)

Updates the details of an existing room type for the given event, requiring the update permission on events.

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventRoomTypeUpdateInputs** | **EventRoomTypeUpdateInputs**|  | |
| **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)

# **updateEventRoomTypeAddOnDetails**
> CreateEventRoomType200Response updateEventRoomTypeAddOnDetails(eventRoomTypeAddOnDetailsUpdateInputs)

Creates or updates the pricing/availability details linking a specific add-on to a room type, requiring the update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let roomTypeId: string; //The roomType identifier (default to undefined)
let addOnId: string; //The addOn identifier (default to undefined)
let eventRoomTypeAddOnDetailsUpdateInputs: EventRoomTypeAddOnDetailsUpdateInputs; //

const { status, data } = await apiInstance.updateEventRoomTypeAddOnDetails(
    eventId,
    roomTypeId,
    addOnId,
    eventRoomTypeAddOnDetailsUpdateInputs
);
```

### Parameters

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

# **updateEventRoomTypePassTypeDetails**
> CreateEventRoomType200Response updateEventRoomTypePassTypeDetails(eventRoomTypePassTypeDetailsUpdateInputs)

Creates or updates the pricing/availability details linking a specific pass type to a room type, requiring the update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let roomTypeId: string; //The roomType identifier (default to undefined)
let passTypeId: string; //The passType identifier (default to undefined)
let eventRoomTypePassTypeDetailsUpdateInputs: EventRoomTypePassTypeDetailsUpdateInputs; //

const { status, data } = await apiInstance.updateEventRoomTypePassTypeDetails(
    eventId,
    roomTypeId,
    passTypeId,
    eventRoomTypePassTypeDetailsUpdateInputs
);
```

### Parameters

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

