# EventsRegistrationsPackagesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createEventRegistrationPackage**](#createeventregistrationpackage) | **POST** /events/{eventId}/registrations/{registrationId}/packages | Create a package for an event registration|
|[**deleteEventRegistrationPackage**](#deleteeventregistrationpackage) | **DELETE** /events/{eventId}/registrations/{registrationId}/packages/{packageId} | Delete an event registration\'s package|
|[**getEventRegistrationPackage**](#geteventregistrationpackage) | **GET** /events/{eventId}/registrations/{registrationId}/packages/{packageId} | Get a registration\'s event package|
|[**getEventRegistrationPackages**](#geteventregistrationpackages) | **GET** /events/{eventId}/registrations/{registrationId}/packages | List a registration\'s event packages|
|[**updateEventRegistrationPackage**](#updateeventregistrationpackage) | **PUT** /events/{eventId}/registrations/{registrationId}/packages/{packageId} | Update an event registration\'s package|

# **createEventRegistrationPackage**
> CreateEventRegistrationPackage200Response createEventRegistrationPackage(eventRegistrationPackageCreateInputs)

Creates a new attendee package (e.g. a bundled add-on/room package purchase) for the given registration at an event, requiring read and update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let registrationId: string; //The registration identifier (default to undefined)
let eventRegistrationPackageCreateInputs: EventRegistrationPackageCreateInputs; //

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventRegistrationPackageCreateInputs** | **EventRegistrationPackageCreateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|


### Return type

**CreateEventRegistrationPackage200Response**

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

# **deleteEventRegistrationPackage**
> SyncAccounts200Response deleteEventRegistrationPackage()

Permanently deletes a specific attendee package purchase belonging to the given registration at an event, requiring read and update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let registrationId: string; //The registration identifier (default to undefined)
let packageId: string; //The package identifier (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
| **packageId** | [**string**] | The package identifier | defaults to undefined|


### Return type

**SyncAccounts200Response**

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

# **getEventRegistrationPackage**
> CreateEventRegistrationPackage200Response getEventRegistrationPackage()

Returns a single package purchased under the given registration for the specified event, identified by packageId; requires read permission on events and attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let registrationId: string; //The registration identifier (default to undefined)
let packageId: string; //The package identifier (default to undefined)

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
| **packageId** | [**string**] | The package identifier | defaults to undefined|


### Return type

**CreateEventRegistrationPackage200Response**

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

# **getEventRegistrationPackages**
> GetEventRegistrationPackages200Response getEventRegistrationPackages()

Returns a paginated list of packages purchased under the given registration for the specified event, optionally filtered by purchase status, with search and ordering support; requires read permission on events and attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let registrationId: string; //The registration identifier (default to undefined)
let status: PurchaseStatus; //Filter by status (optional) (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.getEventRegistrationPackages(
    eventId,
    registrationId,
    status,
    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|
| **status** | **PurchaseStatus** | Filter by status | (optional) 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

**GetEventRegistrationPackages200Response**

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

# **updateEventRegistrationPackage**
> CreateEventRegistrationPackage200Response updateEventRegistrationPackage(eventRegistrationPackageUpdateInputs)

Updates the details of an existing attendee package purchase for the given registration at an event, requiring read and update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let registrationId: string; //The registration identifier (default to undefined)
let packageId: string; //The package identifier (default to undefined)
let eventRegistrationPackageUpdateInputs: EventRegistrationPackageUpdateInputs; //

const { status, data } = await apiInstance.updateEventRegistrationPackage(
    eventId,
    registrationId,
    packageId,
    eventRegistrationPackageUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventRegistrationPackageUpdateInputs** | **EventRegistrationPackageUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
| **packageId** | [**string**] | The package identifier | defaults to undefined|


### Return type

**CreateEventRegistrationPackage200Response**

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