# EventsPackagesPassesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createEventPackagePass**](#createeventpackagepass) | **POST** /events/{eventId}/packages/{packageId}/passes | Create a pass for an event package|
|[**deleteEventPackagePass**](#deleteeventpackagepass) | **DELETE** /events/{eventId}/packages/{packageId}/passes/{passId} | Delete a pass from an event package|
|[**getEventPackagePass**](#geteventpackagepass) | **GET** /events/{eventId}/packages/{packageId}/passes/{passId} | Get a single pass in an event package|
|[**getEventPackagePasses**](#geteventpackagepasses) | **GET** /events/{eventId}/packages/{packageId}/passes | List the passes included in an event package|
|[**updateEventPackagePass**](#updateeventpackagepass) | **PUT** /events/{eventId}/packages/{packageId}/passes/{passId} | Update a pass within an event package|

# **createEventPackagePass**
> CreateEventPackagePass200Response createEventPackagePass(eventPackagePassCreateInputs)

Creates a new pass tied to the given event package, defining a purchasable pass option within that package; requires read and update permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateEventPackagePass200Response**

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

# **deleteEventPackagePass**
> CreateAccountInvitations200Response deleteEventPackagePass()

Permanently removes the specified pass from the given event package; requires read and update permission on events.

### Example

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

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

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

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

### Parameters

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

# **getEventPackagePass**
> CreateEventPackagePass200Response getEventPackagePass()

Returns the details of a specific pass belonging to the given event package, identified by its pass ID; requires read access to events.

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateEventPackagePass200Response**

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

# **getEventPackagePasses**
> GetEventPackagePasses200Response getEventPackagePasses()

Returns a paginated list of passes belonging to the given event package, with optional search; requires read access to events.

### Example

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

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

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

### Parameters

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

**GetEventPackagePasses200Response**

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

# **updateEventPackagePass**
> CreateEventPackagePass200Response updateEventPackagePass(eventPackagePassUpdateInputs)

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

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let packageId: string; //The package identifier (default to undefined)
let passId: string; //The pass identifier (default to undefined)
let eventPackagePassUpdateInputs: EventPackagePassUpdateInputs; //

const { status, data } = await apiInstance.updateEventPackagePass(
    eventId,
    packageId,
    passId,
    eventPackagePassUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventPackagePassUpdateInputs** | **EventPackagePassUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **packageId** | [**string**] | The package identifier | defaults to undefined|
| **passId** | [**string**] | The pass identifier | defaults to undefined|


### Return type

**CreateEventPackagePass200Response**

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