# EventsPasstypesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addEventPassTypeAddOn**](#addeventpasstypeaddon) | **POST** /events/{eventId}/passTypes/{passTypeId}/addOns/{addOnId} | Add an add-on to a pass type|
|[**addEventPassTypeGroupPassTier**](#addeventpasstypegrouppasstier) | **POST** /events/{eventId}/passTypes/{passTypeId}/groupPassTiers/{tierId} | Allow a tier to purchase a group pass type|
|[**addEventPassTypeTier**](#addeventpasstypetier) | **POST** /events/{eventId}/passTypes/{passTypeId}/tiers/{tierId} | Add an account tier to a pass type\'s tier list|
|[**createEventPassType**](#createeventpasstype) | **POST** /events/{eventId}/passTypes | Create an event pass type|
|[**deleteEventPassType**](#deleteeventpasstype) | **DELETE** /events/{eventId}/passTypes/{passTypeId} | Delete an event pass type|
|[**eventGetPassTypeCoupons**](#eventgetpasstypecoupons) | **GET** /events/{eventId}/passTypes/{passTypeId}/coupons | List an event pass type\'s coupons|
|[**getEventPassType**](#geteventpasstype) | **GET** /events/{eventId}/passTypes/{passTypeId} | Get a single event pass type|
|[**getEventPassTypeAddOns**](#geteventpasstypeaddons) | **GET** /events/{eventId}/passTypes/{passTypeId}/addOns | List an event pass type\'s add-ons|
|[**getEventPassTypeGroupPassTiers**](#geteventpasstypegrouppasstiers) | **GET** /events/{eventId}/passTypes/{passTypeId}/groupPassTiers | List an event pass type\'s group pass tiers|
|[**getEventPassTypePasses**](#geteventpasstypepasses) | **GET** /events/{eventId}/passTypes/{passTypeId}/passes | List passes purchased for an event pass type|
|[**getEventPassTypePayments**](#geteventpasstypepayments) | **GET** /events/{eventId}/passTypes/{passTypeId}/payments | List payments for a pass type|
|[**getEventPassTypeTiers**](#geteventpasstypetiers) | **GET** /events/{eventId}/passTypes/{passTypeId}/tiers | List account tiers allowed/disallowed for a pass type|
|[**getEventPassTypes**](#geteventpasstypes) | **GET** /events/{eventId}/passTypes | List an event\'s pass types|
|[**removeEventPassTypeAddOn**](#removeeventpasstypeaddon) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/addOns/{addOnId} | Remove an add-on from a pass type|
|[**removeEventPassTypeGroupPassTier**](#removeeventpasstypegrouppasstier) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/groupPassTiers/{tierId} | Remove an account tier from a pass type\'s group tiers|
|[**removeEventPassTypeTier**](#removeeventpasstypetier) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/tiers/{tierId} | Remove an account tier from a pass type\'s tier list|
|[**updateEventPassType**](#updateeventpasstype) | **PUT** /events/{eventId}/passTypes/{passTypeId} | Update an event pass type|

# **addEventPassTypeAddOn**
> AddEventOnSiteLabelPassType200Response addEventPassTypeAddOn()

Associates an existing event add-on with a pass type so it can be purchased alongside that pass; requires update permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**AddEventOnSiteLabelPassType200Response**

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

# **addEventPassTypeGroupPassTier**
> AddEventOnSiteLabelPassType200Response addEventPassTypeGroupPassTier()

Adds an account tier to the list of tiers allowed to purchase a pass type as a group pass, rejecting the request if the tier has already been added; requires update permission on events and read permission on tiers.

### Example

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

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

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

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

### Parameters

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


### Return type

**AddEventOnSiteLabelPassType200Response**

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

# **addEventPassTypeTier**
> AddEventOnSiteLabelPassType200Response addEventPassTypeTier(addEventAddOnTierRequest)

Adds an account tier to either the allowed or disallowed tier list of an event pass type depending on the `allowed` flag, restricting or permitting which account tiers may purchase that pass type; requires update permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**AddEventOnSiteLabelPassType200Response**

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

# **createEventPassType**
> AddEventOnSiteLabelPassType200Response createEventPassType(passTypeCreateInputs)

Creates a new pass type (ticket type) for the given event using the provided details, such as name, pricing, and availability; requires update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let passTypeCreateInputs: PassTypeCreateInputs; //

const { status, data } = await apiInstance.createEventPassType(
    eventId,
    passTypeCreateInputs
);
```

### Parameters

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


### Return type

**AddEventOnSiteLabelPassType200Response**

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

# **deleteEventPassType**
> CreateAccountInvitations200Response deleteEventPassType()

Permanently deletes a pass type from the given event; requires update permission on events.

### Example

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

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

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

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

### Parameters

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

# **eventGetPassTypeCoupons**
> GetEventCoupons200Response eventGetPassTypeCoupons()

Returns a paginated list of coupons that apply to an event pass type, with optional search and orderBy filters; requires read access to the event.

### Example

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

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

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

### Parameters

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

**GetEventCoupons200Response**

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

# **getEventPassType**
> AddEventOnSiteLabelPassType200Response getEventPassType()

Retrieves the full details of a single pass type belonging to an event, identified by its ID; requires read access to the event.

### Example

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

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

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

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

### Parameters

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


### Return type

**AddEventOnSiteLabelPassType200Response**

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

# **getEventPassTypeAddOns**
> GetEventAddOns200Response getEventPassTypeAddOns()

Returns a paginated list of add-ons linked to an event pass type, with optional search and orderBy filters; requires read access to the event.

### Example

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

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

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

### Parameters

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

# **getEventPassTypeGroupPassTiers**
> GetAccountTiers200Response getEventPassTypeGroupPassTiers()

Returns a paginated list of the registration tiers allowed to purchase an event pass type as part of a group pass, with optional search and orderBy filters; requires read access to the event and to tiers.

### Example

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

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

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

### Parameters

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

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

# **getEventPassTypePasses**
> GetEventAddOnPasses200Response getEventPassTypePasses()

Returns a paginated list of purchased passes for a given event pass type, optionally filtered to only checked-in or not-checked-in passes, with search and orderBy support; requires read access to the event and to attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let passTypeId: string; //The passType identifier (default to undefined)
let checkedIn: boolean; //Filter by checkedIn (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.getEventPassTypePasses(
    eventId,
    passTypeId,
    checkedIn,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
| **checkedIn** | [**boolean**] | Filter by checkedIn | (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

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

# **getEventPassTypePayments**
> GetAccountPayments200Response getEventPassTypePayments()

Returns a paginated list of payments made for a specific pass type on an event, supporting search and ordering; requires read permission on events and payments.

### Example

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

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

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

### Parameters

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

**GetAccountPayments200Response**

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

# **getEventPassTypeTiers**
> GetAccountTiers200Response getEventPassTypeTiers()

Returns a paginated list of account tiers associated with a pass type, filtered by the `allowed` flag to either the tiers permitted to purchase the pass type or those explicitly disallowed, with optional search; requires read permission on events and tiers.

### Example

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

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

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

### Parameters

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

# **getEventPassTypes**
> GetEventAddOnPassTypes200Response getEventPassTypes()

Returns a paginated list of pass types (tickets) for an event, ordered by sort order and price by default, with optional search and custom ordering; requires read permission on events.

### Example

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

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

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

# **removeEventPassTypeAddOn**
> AddEventOnSiteLabelPassType200Response removeEventPassTypeAddOn()

Detaches an add-on from an event pass type so it is no longer offered alongside that pass type; requires update permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**AddEventOnSiteLabelPassType200Response**

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

# **removeEventPassTypeGroupPassTier**
> AddEventOnSiteLabelPassType200Response removeEventPassTypeGroupPassTier()

Removes an account tier from the list of tiers allowed to purchase an event pass type as a group pass; requires update permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**AddEventOnSiteLabelPassType200Response**

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

# **removeEventPassTypeTier**
> AddEventOnSiteLabelPassType200Response removeEventPassTypeTier()

Removes an account tier from either the allowed or disallowed tier list of an event pass type depending on the `allowed` flag; requires update permission on events.

### Example

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

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

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

### Parameters

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


### Return type

**AddEventOnSiteLabelPassType200Response**

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

# **updateEventPassType**
> AddEventOnSiteLabelPassType200Response updateEventPassType(passTypeUpdateInputs)

Updates the details of an existing pass type on the given event, such as its name, pricing, or availability; requires update permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**AddEventOnSiteLabelPassType200Response**

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