# EventsPackagesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createEventPackage**](#createeventpackage) | **POST** /events/{eventId}/packages | Create an event package|
|[**deleteEventPackage**](#deleteeventpackage) | **DELETE** /events/{eventId}/packages/{packageId} | Delete an event package|
|[**getEventPackage**](#geteventpackage) | **GET** /events/{eventId}/packages/{packageId} | Get a single event package|
|[**getEventPackages**](#geteventpackages) | **GET** /events/{eventId}/packages | List an event\'s packages|
|[**updateEventPackage**](#updateeventpackage) | **PUT** /events/{eventId}/packages/{packageId} | Update an event package|

# **createEventPackage**
> CreateEventPackage200Response createEventPackage(eventPackageCreateInputs)

Creates a new package for the given event, bundling passes and other offerings that attendees can purchase together; requires read and update permission on events.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let eventPackageCreateInputs: EventPackageCreateInputs; //

const { status, data } = await apiInstance.createEventPackage(
    eventId,
    eventPackageCreateInputs
);
```

### Parameters

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


### Return type

**CreateEventPackage200Response**

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

# **deleteEventPackage**
> CreateAccountInvitations200Response deleteEventPackage()

Permanently removes the specified package, along with its association to passes, from the given event; requires read and update permission on events.

### Example

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

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

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

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

### Parameters

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

# **getEventPackage**
> CreateEventPackage200Response getEventPackage()

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

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateEventPackage200Response**

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

# **getEventPackages**
> GetEventPackages200Response getEventPackages()

Returns a paginated list of packages belonging to the given event, with search and ordering support; requires read access to events.

### Example

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

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

**GetEventPackages200Response**

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

# **updateEventPackage**
> CreateEventPackage200Response updateEventPackage(eventPackageUpdateInputs)

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

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateEventPackage200Response**

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