# EventsAddonsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addEventAddOnPassType**](#addeventaddonpasstype) | **POST** /events/{eventId}/addOns/{addOnId}/passTypes/{passTypeId} | Allow a pass type to purchase an add-on|
|[**addEventAddOnTier**](#addeventaddontier) | **POST** /events/{eventId}/addOns/{addOnId}/tiers/{tierId} | Set an account tier\'s access to an add-on|
|[**createEventAddOn**](#createeventaddon) | **POST** /events/{eventId}/addOns | Create an event add-on|
|[**deleteEventAddOn**](#deleteeventaddon) | **DELETE** /events/{eventId}/addOns/{addOnId} | Delete an event add-on|
|[**getEventAddOn**](#geteventaddon) | **GET** /events/{eventId}/addOns/{addOnId} | Get an event add-on|
|[**getEventAddOnPassTypes**](#geteventaddonpasstypes) | **GET** /events/{eventId}/addOns/{addOnId}/passTypes | List pass types eligible for an add-on|
|[**getEventAddOnPasses**](#geteventaddonpasses) | **GET** /events/{eventId}/addOns/{addOnId}/passes | List purchases of an event add-on|
|[**getEventAddOnTiers**](#geteventaddontiers) | **GET** /events/{eventId}/addOns/{addOnId}/tiers | List account tiers allowed or disallowed for an add-on|
|[**getEventAddOns**](#geteventaddons) | **GET** /events/{eventId}/addOns | List an event\'s add-ons|
|[**removeEventAddOnPassType**](#removeeventaddonpasstype) | **DELETE** /events/{eventId}/addOns/{addOnId}/passTypes/{passTypeId} | Revoke a pass type\'s access to an add-on|
|[**removeEventAddOnTier**](#removeeventaddontier) | **DELETE** /events/{eventId}/addOns/{addOnId}/tiers/{tierId} | Remove an account tier\'s access setting from an add-on|
|[**updateEventAddOn**](#updateeventaddon) | **PUT** /events/{eventId}/addOns/{addOnId} | Update an event add-on|

# **addEventAddOnPassType**
> CreateEventAddOn200Response addEventAddOnPassType()

Adds the given pass type to the add-on\'s allowed pass types, permitting attendees with that pass type to purchase the event add-on; requires the update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let addOnId: string; //The addOn identifier (default to undefined)
let passTypeId: string; //The passType identifier (default to undefined)

const { status, data } = await apiInstance.addEventAddOnPassType(
    eventId,
    addOnId,
    passTypeId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|


### Return type

**CreateEventAddOn200Response**

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

# **addEventAddOnTier**
> CreateEventAddOn200Response addEventAddOnTier(addEventAddOnTierRequest)

Adds the given account tier to the add-on\'s allowed or disallowed tier list, controlling whether members of that tier can purchase the event add-on, based on the `allowed` flag; requires the update permission on events.

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **addEventAddOnTierRequest** | **AddEventAddOnTierRequest**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
| **tierId** | [**string**] | The tier identifier | defaults to undefined|


### Return type

**CreateEventAddOn200Response**

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

# **createEventAddOn**
> CreateEventAddOn200Response createEventAddOn(eventAddOnCreateInputs)

Creates a new purchasable add-on (e.g. merchandise, upgrade) for the given event; requires the update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let eventAddOnCreateInputs: EventAddOnCreateInputs; //

const { status, data } = await apiInstance.createEventAddOn(
    eventId,
    eventAddOnCreateInputs
);
```

### Parameters

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


### Return type

**CreateEventAddOn200Response**

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

# **deleteEventAddOn**
> CreateAccountInvitations200Response deleteEventAddOn()

Permanently removes a purchasable add-on from the given event; requires the update permission on events.

### Example

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

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

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

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

### Parameters

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

# **getEventAddOn**
> CreateEventAddOn200Response getEventAddOn()

Retrieves a single add-on by ID for the given event, including its pricing and configuration details; requires read access to the event\'s events module.

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateEventAddOn200Response**

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

# **getEventAddOnPassTypes**
> GetEventAddOnPassTypes200Response getEventAddOnPassTypes()

Returns a paginated list of the event\'s pass types (tickets) that the given add-on is available for, supporting search and ordering; requires read permission on events.

### Example

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

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

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

### Parameters

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

**GetEventAddOnPassTypes200Response**

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

# **getEventAddOnPasses**
> GetEventAddOnPasses200Response getEventAddOnPasses()

Returns a paginated list of pass purchases (in needsInfo, ready, or pending status) that include the given add-on for the specified event, supporting search and ordering; requires read permission on events and attendees.

### Example

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

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

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

### Parameters

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

# **getEventAddOnTiers**
> GetAccountTiers200Response getEventAddOnTiers()

Returns a paginated list of account tiers that are either allowed or disallowed (per the required `allowed` flag) from purchasing the given event add-on, supporting search and ordering; requires read permission on events and tiers.

### Example

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

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

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

### Parameters

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

# **getEventAddOns**
> GetEventAddOns200Response getEventAddOns()

Returns a paginated list of add-ons configured for the specified event, supporting search and ordering; requires read permission on events.

### Example

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

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

**GetEventAddOns200Response**

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

# **removeEventAddOnPassType**
> CreateEventAddOn200Response removeEventAddOnPassType()

Removes the given pass type from the add-on\'s allowed pass types, preventing attendees with that pass type from purchasing the event add-on; requires the update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let addOnId: string; //The addOn identifier (default to undefined)
let passTypeId: string; //The passType identifier (default to undefined)

const { status, data } = await apiInstance.removeEventAddOnPassType(
    eventId,
    addOnId,
    passTypeId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|


### Return type

**CreateEventAddOn200Response**

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

# **removeEventAddOnTier**
> CreateEventAddOn200Response removeEventAddOnTier()

Removes the given account tier from the add-on\'s allowed or disallowed tier list (per the `allowed` flag), clearing that tier\'s explicit access rule for the event add-on; requires the update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let addOnId: string; //The addOn 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.removeEventAddOnTier(
    eventId,
    addOnId,
    tierId,
    allowed
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
| **tierId** | [**string**] | The tier identifier | defaults to undefined|
| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|


### Return type

**CreateEventAddOn200Response**

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

# **updateEventAddOn**
> CreateEventAddOn200Response updateEventAddOn(eventAddOnUpdateInputs)

Updates an existing add-on for an event, including its name, pricing, and related settings; if a new sortOrder is provided the other add-ons for the event are reordered around it, and this requires read and update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let addOnId: string; //The addOn identifier (default to undefined)
let eventAddOnUpdateInputs: EventAddOnUpdateInputs; //

const { status, data } = await apiInstance.updateEventAddOn(
    eventId,
    addOnId,
    eventAddOnUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventAddOnUpdateInputs** | **EventAddOnUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|


### Return type

**CreateEventAddOn200Response**

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