@connectedxm/admin-sdk 1.0.0

package/docs/EventsPasstypesPriceschedulesApi.md

@@ -0,0 +1,311 @@
+# EventsPasstypesPriceschedulesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createEventPassTypePriceSchedule**](#createeventpasstypepriceschedule) | **POST** /events/{eventId}/passTypes/{passTypeId}/priceSchedules | Create Event Pass Type Price Schedule|
+|[**deleteEventPassTypePriceSchedule**](#deleteeventpasstypepriceschedule) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId} | Delete Event Pass Type Price Schedule|
+|[**getEventPassTypePriceSchedule**](#geteventpasstypepriceschedule) | **GET** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId} | Get Event Pass Type Price Schedule|
+|[**getEventPassTypePriceSchedules**](#geteventpasstypepriceschedules) | **GET** /events/{eventId}/passTypes/{passTypeId}/priceSchedules | Get Event Pass Type Price Schedules|
+|[**updateEventPassTypePriceSchedule**](#updateeventpasstypepriceschedule) | **PUT** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId} | Update Event Pass Type Price Schedule|
+
+# **createEventPassTypePriceSchedule**
+> CreateAccountAddress200Response createEventPassTypePriceSchedule(passTypePriceScheduleCreateInputs)
+
+Create Event Pass Type Price Schedule endpoint
+
+### 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
+
+**CreateAccountAddress200Response**
+
+### 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**
+> CreateAccountAddress200Response deleteEventPassTypePriceSchedule()
+
+Delete Event Pass Type Price Schedule endpoint
+
+### 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
+
+**CreateAccountAddress200Response**
+
+### 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**
+> CreateAccountAddress200Response getEventPassTypePriceSchedule()
+
+Get Event Pass Type Price Schedule endpoint
+
+### 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
+
+**CreateAccountAddress200Response**
+
+### 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**
+> GetAccountInvitations200Response getEventPassTypePriceSchedules()
+
+Get Event Pass Type Price Schedules endpoint
+
+### 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
+
+**GetAccountInvitations200Response**
+
+### 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**
+> CreateAccountAddress200Response updateEventPassTypePriceSchedule(passTypePriceScheduleUpdateInputs)
+
+Update Event Pass Type Price Schedule endpoint
+
+### 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
+
+**CreateAccountAddress200Response**
+
+### 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)
+

package/docs/EventsPasstypesRefundschedulesApi.md

@@ -0,0 +1,311 @@
+# EventsPasstypesRefundschedulesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createEventPassTypeRefundSchedule**](#createeventpasstyperefundschedule) | **POST** /events/{eventId}/passTypes/{passTypeId}/refundSchedules | Create Event Pass Type Refund Schedule|
+|[**deleteEventPassTypeRefundSchedule**](#deleteeventpasstyperefundschedule) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/refundSchedules/{scheduleId} | Delete Event Pass Type Refund Schedule|
+|[**getEventPassTypeRefundSchedule**](#geteventpasstyperefundschedule) | **GET** /events/{eventId}/passTypes/{passTypeId}/refundSchedules/{scheduleId} | Get Event Pass Type Refund Schedule|
+|[**getEventPassTypeRefundSchedules**](#geteventpasstyperefundschedules) | **GET** /events/{eventId}/passTypes/{passTypeId}/refundSchedules | Get Event Pass Type Refund Schedules|
+|[**updateEventPassTypeRefundSchedule**](#updateeventpasstyperefundschedule) | **PUT** /events/{eventId}/passTypes/{passTypeId}/refundSchedules/{scheduleId} | Update Event Pass Type Refund Schedule|
+
+# **createEventPassTypeRefundSchedule**
+> CreateAccountAddress200Response createEventPassTypeRefundSchedule(passTypeRefundScheduleCreateInputs)
+
+Create Event Pass Type Refund Schedule endpoint
+
+### 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
+
+**CreateAccountAddress200Response**
+
+### 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**
+> CreateAccountAddress200Response deleteEventPassTypeRefundSchedule()
+
+Delete Event Pass Type Refund Schedule endpoint
+
+### 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
+
+**CreateAccountAddress200Response**
+
+### 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**
+> CreateAccountAddress200Response getEventPassTypeRefundSchedule()
+
+Get Event Pass Type Refund Schedule endpoint
+
+### 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
+
+**CreateAccountAddress200Response**
+
+### 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**
+> GetAccountInvitations200Response getEventPassTypeRefundSchedules()
+
+Get Event Pass Type Refund Schedules endpoint
+
+### 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
+
+**GetAccountInvitations200Response**
+
+### 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**
+> CreateAccountAddress200Response updateEventPassTypeRefundSchedule(passTypeRefundScheduleUpdateInputs)
+
+Update Event Pass Type Refund Schedule endpoint
+
+### 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
+
+**CreateAccountAddress200Response**
+
+### 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)
+