@connectedxm/admin-sdk 6.14.0 → 6.17.4

package/docs/EventsPassesAddonsApi.md

@@ -0,0 +1,190 @@
+# EventsPassesAddonsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addEventPassAddOn**](#addeventpassaddon) | **POST** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Add Event Pass Add On|
+|[**getEventPassAddOns**](#geteventpassaddons) | **GET** /events/{eventId}/passes/{passId}/addOns | Get Event Pass Add Ons|
+|[**removeEventPassAddOn**](#removeeventpassaddon) | **DELETE** /events/{eventId}/passes/{passId}/addOns/{addOnId} | Remove Event Pass Add On|
+
+# **addEventPassAddOn**
+> CreateEventPass200Response addEventPassAddOn()
+
+Add Event Pass Add On endpoint
+
+### Example
+
+```typescript
+import {
+    EventsPassesAddonsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPassesAddonsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let passId: string; //The pass identifier (default to undefined)
+let addOnId: string; //The addOn identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventPassAddOn(
+    eventId,
+    passId,
+    addOnId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **passId** | [**string**] | The pass identifier | defaults to undefined|
+| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventPass200Response**
+
+### 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)
+
+# **getEventPassAddOns**
+> GetEventAddOns200Response getEventPassAddOns()
+
+Get Event Pass Add Ons endpoint
+
+### Example
+
+```typescript
+import {
+    EventsPassesAddonsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPassesAddonsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let passId: string; //The pass 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.getEventPassAddOns(
+    eventId,
+    passId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **passId** | [**string**] | The pass 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)
+
+# **removeEventPassAddOn**
+> CreateEventPass200Response removeEventPassAddOn()
+
+Remove Event Pass Add On endpoint
+
+### Example
+
+```typescript
+import {
+    EventsPassesAddonsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPassesAddonsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let passId: string; //The pass identifier (default to undefined)
+let addOnId: string; //The addOn identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventPassAddOn(
+    eventId,
+    passId,
+    addOnId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **passId** | [**string**] | The pass identifier | defaults to undefined|
+| **addOnId** | [**string**] | The addOn identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventPass200Response**
+
+### 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)
+