# EventsRegistrationsReservationsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addEventReservationPass**](#addeventreservationpass) | **POST** /events/{eventId}/reservations/{reservationId}/passes/{passId} | Attach a pass to a room reservation|
|[**createEventReservation**](#createeventreservation) | **POST** /events/{eventId}/reservations | Create a room type reservation for an event|
|[**deleteEventReservation**](#deleteeventreservation) | **DELETE** /events/{eventId}/reservations/{reservationId} | Delete an event room reservation|
|[**getEventRegistrationReservations**](#geteventregistrationreservations) | **GET** /events/{eventId}/registrations/{registrationId}/reservations | List a registration\'s room reservations|
|[**getEventReservation**](#geteventreservation) | **GET** /events/{eventId}/reservations/{reservationId} | Get an event room reservation|
|[**getEventReservationPasses**](#geteventreservationpasses) | **GET** /events/{eventId}/reservations/{reservationId}/passes | List passes attached to a room reservation|
|[**getEventReservations**](#geteventreservations) | **GET** /events/{eventId}/reservations | List an event\'s room reservations|
|[**removeEventReservationPass**](#removeeventreservationpass) | **DELETE** /events/{eventId}/reservations/{reservationId}/passes/{passId} | Detach a pass from a room reservation|
|[**updateEventReservation**](#updateeventreservation) | **PUT** /events/{eventId}/reservations/{reservationId} | Update an event room reservation|

# **addEventReservationPass**
> CreateEventReservation200Response addEventReservationPass()

Connects an existing event pass (purchase) to a room type reservation for an event, allowing that pass holder to occupy the room; the pass must currently be in a needsInfo, ready, or pending status, and this requires read and update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let reservationId: string; //The reservation identifier (default to undefined)
let passId: string; //The pass identifier (default to undefined)
let registrationId: string; //Filter by registrationId (optional) (default to undefined)

const { status, data } = await apiInstance.addEventReservationPass(
    eventId,
    reservationId,
    passId,
    registrationId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **reservationId** | [**string**] | The reservation identifier | defaults to undefined|
| **passId** | [**string**] | The pass identifier | defaults to undefined|
| **registrationId** | [**string**] | Filter by registrationId | (optional) defaults to undefined|


### Return type

**CreateEventReservation200Response**

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

# **createEventReservation**
> CreateEventReservation200Response createEventReservation(eventRoomTypeReservationCreateInputs)

Creates a new room reservation for an event, linking it to an event room type and room and optionally connecting existing passes to it, requiring read and update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let eventRoomTypeReservationCreateInputs: EventRoomTypeReservationCreateInputs; //
let registrationId: string; //Filter by registrationId (optional) (default to undefined)

const { status, data } = await apiInstance.createEventReservation(
    eventId,
    eventRoomTypeReservationCreateInputs,
    registrationId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventRoomTypeReservationCreateInputs** | **EventRoomTypeReservationCreateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **registrationId** | [**string**] | Filter by registrationId | (optional) defaults to undefined|


### Return type

**CreateEventReservation200Response**

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

# **deleteEventReservation**
> CreateAccountInvitations200Response deleteEventReservation()

Permanently deletes a room type reservation from an event, requiring read and update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let reservationId: string; //The reservation identifier (default to undefined)
let registrationId: string; //Filter by registrationId (optional) (default to undefined)

const { status, data } = await apiInstance.deleteEventReservation(
    eventId,
    reservationId,
    registrationId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **reservationId** | [**string**] | The reservation identifier | defaults to undefined|
| **registrationId** | [**string**] | Filter by registrationId | (optional) 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)

# **getEventRegistrationReservations**
> GetEventRegistrationReservations200Response getEventRegistrationReservations()

Returns a paginated list of room-type reservations belonging to the given registration for the specified event, with search and ordering support; requires read permission on events and attendees.

### Example

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

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

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

### Parameters

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

# **getEventReservation**
> CreateEventReservation200Response getEventReservation()

Returns a single room-type reservation for the specified event, identified by reservationId; requires read permission on events and attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let reservationId: string; //The reservation identifier (default to undefined)

const { status, data } = await apiInstance.getEventReservation(
    eventId,
    reservationId
);
```

### Parameters

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


### Return type

**CreateEventReservation200Response**

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

# **getEventReservationPasses**
> GetEventAddOnPasses200Response getEventReservationPasses()

Returns a paginated list of attendee passes associated with the given room-type reservation for the specified event, with search and ordering support; requires read permission on events and attendees.

### Example

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

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

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

### Parameters

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

# **getEventReservations**
> GetEventRegistrationReservations200Response getEventReservations()

Returns a paginated list of room-type reservations for the specified event, with search and ordering support; requires read permission on events and attendees.

### Example

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

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

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

# **removeEventReservationPass**
> CreateEventReservation200Response removeEventReservationPass()

Disconnects an event pass (purchase) from a room type reservation for an event, freeing up that spot in the room, requiring read and update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let reservationId: string; //The reservation identifier (default to undefined)
let passId: string; //The pass identifier (default to undefined)
let registrationId: string; //Filter by registrationId (optional) (default to undefined)

const { status, data } = await apiInstance.removeEventReservationPass(
    eventId,
    reservationId,
    passId,
    registrationId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **reservationId** | [**string**] | The reservation identifier | defaults to undefined|
| **passId** | [**string**] | The pass identifier | defaults to undefined|
| **registrationId** | [**string**] | Filter by registrationId | (optional) defaults to undefined|


### Return type

**CreateEventReservation200Response**

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

# **updateEventReservation**
> CreateEventReservation200Response updateEventReservation(eventRoomTypeReservationUpdateInputs)

Updates an existing room type reservation for an event, such as its assigned room or room type, requiring read and update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let reservationId: string; //The reservation identifier (default to undefined)
let eventRoomTypeReservationUpdateInputs: EventRoomTypeReservationUpdateInputs; //
let registrationId: string; //Filter by registrationId (optional) (default to undefined)

const { status, data } = await apiInstance.updateEventReservation(
    eventId,
    reservationId,
    eventRoomTypeReservationUpdateInputs,
    registrationId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventRoomTypeReservationUpdateInputs** | **EventRoomTypeReservationUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **reservationId** | [**string**] | The reservation identifier | defaults to undefined|
| **registrationId** | [**string**] | Filter by registrationId | (optional) defaults to undefined|


### Return type

**CreateEventReservation200Response**

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