@connectedxm/admin-sdk 1.0.0

package/docs/EventsCouponsApi.md

@@ -0,0 +1,673 @@
+# EventsCouponsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createEventCoupon**](#createeventcoupon) | **POST** /events/{eventId}/coupons | Create Event Coupon|
+|[**createEventCouponVariants**](#createeventcouponvariants) | **POST** /events/{eventId}/coupons/{couponId}/variants | Create Event Coupon Variants|
+|[**deleteEventCoupon**](#deleteeventcoupon) | **DELETE** /events/{eventId}/coupons/{couponId} | Delete Event Coupon|
+|[**deleteEventCouponVariants**](#deleteeventcouponvariants) | **DELETE** /events/{eventId}/coupons/{couponId}/variants | Delete Event Coupon Variants|
+|[**getEventCoupon**](#geteventcoupon) | **GET** /events/{eventId}/coupons/{couponId} | Get Event Coupon|
+|[**getEventCouponPasses**](#geteventcouponpasses) | **GET** /events/{eventId}/coupons/{couponId}/passes | Get Event Coupon Passes|
+|[**getEventCouponPayments**](#geteventcouponpayments) | **GET** /events/{eventId}/coupons/{couponId}/payments | Get Event Coupon Payments|
+|[**getEventCouponVariants**](#geteventcouponvariants) | **GET** /events/{eventId}/coupons/{parentCouponId}/variants | Get Event Coupon Variants|
+|[**getEventCoupons**](#geteventcoupons) | **GET** /events/{eventId}/coupons | Get Event Coupons|
+|[**syncEventCouponToVariants**](#synceventcoupontovariants) | **PUT** /events/{eventId}/coupons/{couponId}/variants | Sync Event Coupon To Variants|
+|[**updateEventCoupon**](#updateeventcoupon) | **PUT** /events/{eventId}/coupons/{couponId} | Update Event Coupon|
+
+# **createEventCoupon**
+> CreateEventCoupon200Response createEventCoupon(eventCouponCreateInputs)
+
+Create Event Coupon endpoint
+
+### Example
+
+```typescript
+import {
+    EventsCouponsApi,
+    Configuration,
+    EventCouponCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsCouponsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let eventCouponCreateInputs: EventCouponCreateInputs; //
+
+const { status, data } = await apiInstance.createEventCoupon(
+    eventId,
+    eventCouponCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventCouponCreateInputs** | **EventCouponCreateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventCoupon200Response**
+
+### 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)
+
+# **createEventCouponVariants**
+> CreateEventCouponVariants200Response createEventCouponVariants(eventVariantCouponCreateInputs)
+
+Create Event Coupon Variants endpoint
+
+### Example
+
+```typescript
+import {
+    EventsCouponsApi,
+    Configuration,
+    EventVariantCouponCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsCouponsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let couponId: string; //The coupon identifier (default to undefined)
+let eventVariantCouponCreateInputs: EventVariantCouponCreateInputs; //
+
+const { status, data } = await apiInstance.createEventCouponVariants(
+    eventId,
+    couponId,
+    eventVariantCouponCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventVariantCouponCreateInputs** | **EventVariantCouponCreateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventCouponVariants200Response**
+
+### 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)
+
+# **deleteEventCoupon**
+> CreateAccountInvitations200Response deleteEventCoupon()
+
+Delete Event Coupon endpoint
+
+### Example
+
+```typescript
+import {
+    EventsCouponsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsCouponsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let couponId: string; //The coupon identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventCoupon(
+    eventId,
+    couponId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **couponId** | [**string**] | The coupon 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)
+
+# **deleteEventCouponVariants**
+> CreateAccountInvitations200Response deleteEventCouponVariants()
+
+Delete Event Coupon Variants endpoint
+
+### Example
+
+```typescript
+import {
+    EventsCouponsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsCouponsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let couponId: string; //The coupon identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventCouponVariants(
+    eventId,
+    couponId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **couponId** | [**string**] | The coupon 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)
+
+# **getEventCoupon**
+> CreateEventCoupon200Response getEventCoupon()
+
+Get Event Coupon endpoint
+
+### Example
+
+```typescript
+import {
+    EventsCouponsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsCouponsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let couponId: string; //The coupon identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventCoupon(
+    eventId,
+    couponId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventCoupon200Response**
+
+### 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)
+
+# **getEventCouponPasses**
+> GetEventAddOnPasses200Response getEventCouponPasses()
+
+Get Event Coupon Passes endpoint
+
+### Example
+
+```typescript
+import {
+    EventsCouponsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsCouponsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let couponId: string; //The coupon 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.getEventCouponPasses(
+    eventId,
+    couponId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **couponId** | [**string**] | The coupon 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)
+
+# **getEventCouponPayments**
+> GetAccountPayments200Response getEventCouponPayments()
+
+Get Event Coupon Payments endpoint
+
+### Example
+
+```typescript
+import {
+    EventsCouponsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsCouponsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let couponId: string; //The coupon 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.getEventCouponPayments(
+    eventId,
+    couponId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **couponId** | [**string**] | The coupon 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
+
+**GetAccountPayments200Response**
+
+### 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)
+
+# **getEventCouponVariants**
+> GetEventAttendeeCoupons200Response getEventCouponVariants()
+
+Get Event Coupon Variants endpoint
+
+### Example
+
+```typescript
+import {
+    EventsCouponsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsCouponsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let parentCouponId: string; //The parentCoupon 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.getEventCouponVariants(
+    eventId,
+    parentCouponId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **parentCouponId** | [**string**] | The parentCoupon 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
+
+**GetEventAttendeeCoupons200Response**
+
+### 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)
+
+# **getEventCoupons**
+> GetEventAttendeeCoupons200Response getEventCoupons()
+
+Get Event Coupons endpoint
+
+### Example
+
+```typescript
+import {
+    EventsCouponsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsCouponsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let prePaid: boolean; //Filter by prePaid (optional) (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.getEventCoupons(
+    eventId,
+    prePaid,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **prePaid** | [**boolean**] | Filter by prePaid | (optional) 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
+
+**GetEventAttendeeCoupons200Response**
+
+### 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)
+
+# **syncEventCouponToVariants**
+> CreateEventCoupon200Response syncEventCouponToVariants(eventVariantCouponSyncInputs)
+
+Sync Event Coupon To Variants endpoint
+
+### Example
+
+```typescript
+import {
+    EventsCouponsApi,
+    Configuration,
+    EventVariantCouponSyncInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsCouponsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let couponId: string; //The coupon identifier (default to undefined)
+let eventVariantCouponSyncInputs: EventVariantCouponSyncInputs; //
+
+const { status, data } = await apiInstance.syncEventCouponToVariants(
+    eventId,
+    couponId,
+    eventVariantCouponSyncInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventVariantCouponSyncInputs** | **EventVariantCouponSyncInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventCoupon200Response**
+
+### 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)
+
+# **updateEventCoupon**
+> CreateEventCoupon200Response updateEventCoupon(eventCouponUpdateInputs)
+
+Update Event Coupon endpoint
+
+### Example
+
+```typescript
+import {
+    EventsCouponsApi,
+    Configuration,
+    EventCouponUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsCouponsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let couponId: string; //The coupon identifier (default to undefined)
+let eventCouponUpdateInputs: EventCouponUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventCoupon(
+    eventId,
+    couponId,
+    eventCouponUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventCouponUpdateInputs** | **EventCouponUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **couponId** | [**string**] | The coupon identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventCoupon200Response**
+
+### 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)
+