@connectedxm/admin-sdk 1.0.0

package/docs/EventsAddonsApi.md

@@ -0,0 +1,738 @@
+# EventsAddonsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addEventAddOnPassType**](#addeventaddonpasstype) | **POST** /events/{eventId}/addOns/{addOnId}/passTypes/{passTypeId} | Add Event Add On Pass Type|
+|[**addEventAddOnTier**](#addeventaddontier) | **POST** /events/{eventId}/addOns/{addOnId}/tiers/{tierId} | Add Event Add On Tier|
+|[**createEventAddOn**](#createeventaddon) | **POST** /events/{eventId}/addOns | Create Event Add On|
+|[**deleteEventAddOn**](#deleteeventaddon) | **DELETE** /events/{eventId}/addOns/{addOnId} | Delete Event Add On|
+|[**getEventAddOn**](#geteventaddon) | **GET** /events/{eventId}/addOns/{addOnId} | Get Event Add On|
+|[**getEventAddOnPassTypes**](#geteventaddonpasstypes) | **GET** /events/{eventId}/addOns/{addOnId}/passTypes | Get Event Add On Pass Types|
+|[**getEventAddOnPasses**](#geteventaddonpasses) | **GET** /events/{eventId}/addOns/{addOnId}/passes | Get Event Add On Passes|
+|[**getEventAddOnTiers**](#geteventaddontiers) | **GET** /events/{eventId}/addOns/{addOnId}/tiers | Get Event Add On Tiers|
+|[**getEventAddOns**](#geteventaddons) | **GET** /events/{eventId}/addOns | Get Event Add Ons|
+|[**removeEventAddOnPassType**](#removeeventaddonpasstype) | **DELETE** /events/{eventId}/addOns/{addOnId}/passTypes/{passTypeId} | Remove Event Add On Pass Type|
+|[**removeEventAddOnTier**](#removeeventaddontier) | **DELETE** /events/{eventId}/addOns/{addOnId}/tiers/{tierId} | Remove Event Add On Tier|
+|[**updateEventAddOn**](#updateeventaddon) | **PUT** /events/{eventId}/addOns/{addOnId} | Update Event Add On|
+
+# **addEventAddOnPassType**
+> CreateEventAddOn200Response addEventAddOnPassType()
+
+Add Event Add On Pass Type endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAddonsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAddonsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let addOnId: string; //The addOn identifier (default to undefined)
+let passTypeId: string; //The passType identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventAddOnPassType(
+    eventId,
+    addOnId,
+    passTypeId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
+| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventAddOn200Response**
+
+### 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)
+
+# **addEventAddOnTier**
+> CreateEventAddOn200Response addEventAddOnTier()
+
+Add Event Add On Tier endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAddonsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAddonsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let addOnId: string; //The addOn identifier (default to undefined)
+let tierId: string; //The tier identifier (default to undefined)
+let allowed: boolean; //Filter by allowed (default to undefined)
+
+const { status, data } = await apiInstance.addEventAddOnTier(
+    eventId,
+    addOnId,
+    tierId,
+    allowed
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
+| **tierId** | [**string**] | The tier identifier | defaults to undefined|
+| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|
+
+
+### Return type
+
+**CreateEventAddOn200Response**
+
+### 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)
+
+# **createEventAddOn**
+> CreateEventAddOn200Response createEventAddOn(eventAddOnCreateInputs)
+
+Create Event Add On endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAddonsApi,
+    Configuration,
+    EventAddOnCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAddonsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let eventAddOnCreateInputs: EventAddOnCreateInputs; //
+
+const { status, data } = await apiInstance.createEventAddOn(
+    eventId,
+    eventAddOnCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventAddOnCreateInputs** | **EventAddOnCreateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventAddOn200Response**
+
+### 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)
+
+# **deleteEventAddOn**
+> CreateAccountInvitations200Response deleteEventAddOn()
+
+Delete Event Add On endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAddonsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAddonsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let addOnId: string; //The addOn identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventAddOn(
+    eventId,
+    addOnId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **addOnId** | [**string**] | The addOn 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)
+
+# **getEventAddOn**
+> CreateEventAddOn200Response getEventAddOn()
+
+Get Event Add On endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAddonsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAddonsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let addOnId: string; //The addOn identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventAddOn(
+    eventId,
+    addOnId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventAddOn200Response**
+
+### 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)
+
+# **getEventAddOnPassTypes**
+> GetAccountInvitations200Response getEventAddOnPassTypes()
+
+Get Event Add On Pass Types endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAddonsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAddonsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let addOnId: string; //The addOn 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.getEventAddOnPassTypes(
+    eventId,
+    addOnId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **addOnId** | [**string**] | The addOn 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)
+
+# **getEventAddOnPasses**
+> GetEventAddOnPasses200Response getEventAddOnPasses()
+
+Get Event Add On Passes endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAddonsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAddonsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let addOnId: string; //The addOn 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.getEventAddOnPasses(
+    eventId,
+    addOnId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **addOnId** | [**string**] | The addOn 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
+
+**GetEventAddOnPasses200Response**
+
+### 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)
+
+# **getEventAddOnTiers**
+> GetAccountTiers200Response getEventAddOnTiers()
+
+Get Event Add On Tiers endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAddonsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAddonsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let addOnId: string; //The addOn identifier (default to undefined)
+let allowed: boolean; //Filter by allowed (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.getEventAddOnTiers(
+    eventId,
+    addOnId,
+    allowed,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
+| **allowed** | [**boolean**] | Filter by allowed | 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
+
+**GetAccountTiers200Response**
+
+### 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)
+
+# **getEventAddOns**
+> GetEventAddOns200Response getEventAddOns()
+
+Get Event Add Ons endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAddonsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAddonsApi(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.getEventAddOns(
+    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
+
+**GetEventAddOns200Response**
+
+### 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)
+
+# **removeEventAddOnPassType**
+> CreateAccountAddress200Response removeEventAddOnPassType()
+
+Remove Event Add On Pass Type endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAddonsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAddonsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let addOnId: string; //The addOn identifier (default to undefined)
+let passTypeId: string; //The passType identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventAddOnPassType(
+    eventId,
+    addOnId,
+    passTypeId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **addOnId** | [**string**] | The addOn 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**: 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)
+
+# **removeEventAddOnTier**
+> CreateEventAddOn200Response removeEventAddOnTier()
+
+Remove Event Add On Tier endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAddonsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAddonsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let addOnId: string; //The addOn identifier (default to undefined)
+let tierId: string; //The tier identifier (default to undefined)
+let allowed: boolean; //Filter by allowed (default to undefined)
+
+const { status, data } = await apiInstance.removeEventAddOnTier(
+    eventId,
+    addOnId,
+    tierId,
+    allowed
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
+| **tierId** | [**string**] | The tier identifier | defaults to undefined|
+| **allowed** | [**boolean**] | Filter by allowed | defaults to undefined|
+
+
+### Return type
+
+**CreateEventAddOn200Response**
+
+### 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)
+
+# **updateEventAddOn**
+> CreateEventAddOn200Response updateEventAddOn()
+
+Update Event Add On endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAddonsApi,
+    Configuration,
+    EventAddOnUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAddonsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let addOnId: string; //The addOn identifier (default to undefined)
+let addOn: EventAddOnUpdateInputs; //Filter by addOn (default to undefined)
+
+const { status, data } = await apiInstance.updateEventAddOn(
+    eventId,
+    addOnId,
+    addOn
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
+| **addOn** | **EventAddOnUpdateInputs** | Filter by addOn | defaults to undefined|
+
+
+### Return type
+
+**CreateEventAddOn200Response**
+
+### 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)
+