# EventsPasstypesPriceschedulesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createEventPassTypePriceSchedule**](#createeventpasstypepriceschedule) | **POST** /events/{eventId}/passTypes/{passTypeId}/priceSchedules | Create a pass type price schedule|
|[**deleteEventPassTypePriceSchedule**](#deleteeventpasstypepriceschedule) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId} | Delete a pass type price schedule|
|[**getEventPassTypePriceSchedule**](#geteventpasstypepriceschedule) | **GET** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId} | Get a single pass type price schedule|
|[**getEventPassTypePriceSchedules**](#geteventpasstypepriceschedules) | **GET** /events/{eventId}/passTypes/{passTypeId}/priceSchedules | List a pass type\&#39;s price schedules|
|[**updateEventPassTypePriceSchedule**](#updateeventpasstypepriceschedule) | **PUT** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId} | Update a pass type price schedule|

# **createEventPassTypePriceSchedule**
> AddEventOnSiteLabelPassType200Response createEventPassTypePriceSchedule(passTypePriceScheduleCreateInputs)

Creates a time-windowed price schedule for an event pass type, rejecting the request if its date range overlaps an existing schedule; requires update permission on events.

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **passTypePriceScheduleCreateInputs** | **PassTypePriceScheduleCreateInputs**|  | |
| **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)

# **deleteEventPassTypePriceSchedule**
> SyncAccounts200Response deleteEventPassTypePriceSchedule()

Permanently removes a price schedule from an event pass type by its schedule ID; requires update permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**SyncAccounts200Response**

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

# **getEventPassTypePriceSchedule**
> GetEventPassTypePriceSchedule200Response getEventPassTypePriceSchedule()

Returns a single scheduled price change for a specific event pass type, including its scheduled date and new price, and requires the read events permission.

### Example

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

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

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

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

### Parameters

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


### Return type

**GetEventPassTypePriceSchedule200Response**

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

# **getEventPassTypePriceSchedules**
> GetEventPassTypePriceSchedules200Response getEventPassTypePriceSchedules()

Returns a paginated list of scheduled price changes for a specific event pass type, used to automate price increases or discounts on set dates, and requires the read events permission.

### Example

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

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

**GetEventPassTypePriceSchedules200Response**

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

# **updateEventPassTypePriceSchedule**
> SyncAccounts200Response updateEventPassTypePriceSchedule(passTypePriceScheduleUpdateInputs)

Updates the date range and price of an existing price schedule on an event pass type, rejecting the request if the new date range overlaps another schedule; requires update permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**SyncAccounts200Response**

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

