# EventsPasstypesRefundschedulesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createEventPassTypeRefundSchedule**](#createeventpasstyperefundschedule) | **POST** /events/{eventId}/passTypes/{passTypeId}/refundSchedules | Create a pass type refund schedule|
|[**deleteEventPassTypeRefundSchedule**](#deleteeventpasstyperefundschedule) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/refundSchedules/{scheduleId} | Delete a pass type refund schedule|
|[**getEventPassTypeRefundSchedule**](#geteventpasstyperefundschedule) | **GET** /events/{eventId}/passTypes/{passTypeId}/refundSchedules/{scheduleId} | Get a pass type refund schedule|
|[**getEventPassTypeRefundSchedules**](#geteventpasstyperefundschedules) | **GET** /events/{eventId}/passTypes/{passTypeId}/refundSchedules | List a pass type\'s refund schedules|
|[**updateEventPassTypeRefundSchedule**](#updateeventpasstyperefundschedule) | **PUT** /events/{eventId}/passTypes/{passTypeId}/refundSchedules/{scheduleId} | Update a pass type refund schedule|

# **createEventPassTypeRefundSchedule**
> AddEventOnSiteLabelPassType200Response createEventPassTypeRefundSchedule(passTypeRefundScheduleCreateInputs)

Creates a time-windowed refund schedule for an event pass type, defining the refund terms available during that date range; requires update permission on events.

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **passTypeRefundScheduleCreateInputs** | **PassTypeRefundScheduleCreateInputs**|  | |
| **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)

# **deleteEventPassTypeRefundSchedule**
> SyncAccounts200Response deleteEventPassTypeRefundSchedule()

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

### Example

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

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

# **getEventPassTypeRefundSchedule**
> GetEventPassTypeRefundSchedule200Response getEventPassTypeRefundSchedule()

Retrieves a single refund schedule entry for an event pass type by its ID, including the refund window and percentage; requires read access to the event.

### Example

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

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

**GetEventPassTypeRefundSchedule200Response**

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

# **getEventPassTypeRefundSchedules**
> GetEventPassTypeRefundSchedules200Response getEventPassTypeRefundSchedules()

Returns a paginated list of refund schedules configured for an event pass type, ordered by start date by default, and supports search and orderBy filters; requires read access to the event.

### Example

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

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

**GetEventPassTypeRefundSchedules200Response**

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

# **updateEventPassTypeRefundSchedule**
> SyncAccounts200Response updateEventPassTypeRefundSchedule(passTypeRefundScheduleUpdateInputs)

Updates the date range and refund terms of an existing refund schedule on an event pass type; requires update permission on events.

### Example

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

const configuration = new Configuration();
const apiInstance = new EventsPasstypesRefundschedulesApi(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 passTypeRefundScheduleUpdateInputs: PassTypeRefundScheduleUpdateInputs; //

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **passTypeRefundScheduleUpdateInputs** | **PassTypeRefundScheduleUpdateInputs**|  | |
| **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)