# EventsPassesAddonsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addEventPassAddOn**](#addeventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Add an add-on to an attendee\'s pass|
|[**fulfillEventPassAddOn**](#fulfilleventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId}/fulfill | Fulfill an add-on on an attendee\'s pass|
|[**getEventPassAddOns**](#geteventpassaddons) | **GET** /events/{eventId}/passes/{passId}/addOns | List an event pass\'s add-ons|
|[**removeEventPassAddOn**](#removeeventpassaddon) | **DELETE** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Remove an add-on from an attendee\'s pass|
|[**unfulfillEventPassAddOn**](#unfulfilleventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId}/undo | Undo an add-on fulfillment|

# **addEventPassAddOn**
> GetEventPass200Response addEventPassAddOn()

Attaches an event add-on purchase to the specified pass, requires read permission on events and read/update permission on attendees.

### Example

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

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

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

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

### Parameters

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


### Return type

**GetEventPass200Response**

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

# **fulfillEventPassAddOn**
> FulfillEventPassAddOn200Response fulfillEventPassAddOn()

Marks the given pass add-on as fulfilled, requires read permission on events and read/update permission on attendees.

### Example

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

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

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

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

### Parameters

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


### Return type

**FulfillEventPassAddOn200Response**

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

# **getEventPassAddOns**
> GetEventAddOns200Response getEventPassAddOns()

Returns a paginated list of add-ons purchased with the specified event pass, supporting search and sorting; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.

### Example

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

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

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

### Parameters

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

# **removeEventPassAddOn**
> GetEventPass200Response removeEventPassAddOn()

Detaches a previously added event add-on purchase from the specified pass, requires read permission on events and read/update permission on attendees.

### Example

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

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

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

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

### Parameters

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


### Return type

**GetEventPass200Response**

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

# **unfulfillEventPassAddOn**
> FulfillEventPassAddOn200Response unfulfillEventPassAddOn()

Reverses a previous fulfillment of the given pass add-on, requires read permission on events and read/update permission on attendees.

### Example

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

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

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

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

### Parameters

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


### Return type

**FulfillEventPassAddOn200Response**

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