@connectedxm/admin-sdk 1.0.0

package/docs/EventsAttendeesApi.md

@@ -0,0 +1,696 @@
+# EventsAttendeesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createEventAttendee**](#createeventattendee) | **POST** /events/{eventId}/attendees | Create Event Attendee|
+|[**deleteEventAttendee**](#deleteeventattendee) | **DELETE** /events/{eventId}/attendees/{accountId} | Delete Event Attendee|
+|[**getEventAttendee**](#geteventattendee) | **GET** /events/{eventId}/attendees/{accountId} | Get Event Attendee|
+|[**getEventAttendeeCoupons**](#geteventattendeecoupons) | **GET** /events/{eventId}/attendees/{accountId}/coupons | Get Event Attendee Coupons|
+|[**getEventAttendeePasses**](#geteventattendeepasses) | **GET** /events/{eventId}/attendees/{accountId}/passes | Get Event Attendee Passes|
+|[**getEventAttendeePayments**](#geteventattendeepayments) | **GET** /events/{eventId}/attendees/{accountId}/payments | Get Event Attendee Payments|
+|[**getEventAttendeeTransfersLogs**](#geteventattendeetransferslogs) | **GET** /events/{eventId}/attendees/{accountId}/transfers/logs | Get Event Attendee Transfers Logs|
+|[**getEventAttendees**](#geteventattendees) | **GET** /events/{eventId}/attendees | Get Event Attendees|
+|[**getEventPassAttendeePasses**](#geteventpassattendeepasses) | **GET** /events/{eventId}/passes/{passId}/attendee/passes | Get Event Pass Attendee Passes|
+|[**resendRegistrationConfirmationEmail**](#resendregistrationconfirmationemail) | **POST** /events/{eventId}/attendees/{accountId}/resendEmail | Resend Registration Confirmation Email|
+|[**updateEventAttendee**](#updateeventattendee) | **PUT** /events/{eventId}/attendees/{accountId} | Update Event Attendee|
+
+# **createEventAttendee**
+> CreateEventAttendee200Response createEventAttendee()
+
+Create Event Attendee endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let accountId: string; //Filter by accountId (default to undefined)
+
+const { status, data } = await apiInstance.createEventAttendee(
+    eventId,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **accountId** | [**string**] | Filter by accountId | defaults to undefined|
+
+
+### Return type
+
+**CreateEventAttendee200Response**
+
+### 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)
+
+# **deleteEventAttendee**
+> CreateEventAttendee200Response deleteEventAttendee()
+
+Delete Event Attendee endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let accountId: string; //The account identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventAttendee(
+    eventId,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **accountId** | [**string**] | The account identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventAttendee200Response**
+
+### 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)
+
+# **getEventAttendee**
+> CreateEventAttendee200Response getEventAttendee()
+
+Get Event Attendee endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let accountId: string; //The account identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventAttendee(
+    eventId,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **accountId** | [**string**] | The account identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventAttendee200Response**
+
+### 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)
+
+# **getEventAttendeeCoupons**
+> GetEventAttendeeCoupons200Response getEventAttendeeCoupons()
+
+Get Event Attendee Coupons endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let accountId: string; //The account 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.getEventAttendeeCoupons(
+    eventId,
+    accountId,
+    prePaid,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **accountId** | [**string**] | The account 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)
+
+# **getEventAttendeePasses**
+> GetEventAddOnPasses200Response getEventAttendeePasses()
+
+Get Event Attendee Passes endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let accountId: string; //The account identifier (default to undefined)
+let status: PurchaseStatus; //Filter by status (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.getEventAttendeePasses(
+    eventId,
+    accountId,
+    status,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **accountId** | [**string**] | The account identifier | defaults to undefined|
+| **status** | **PurchaseStatus** | Filter by status | (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
+
+**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)
+
+# **getEventAttendeePayments**
+> GetAccountPayments200Response getEventAttendeePayments()
+
+Get Event Attendee Payments endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let accountId: string; //The account 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.getEventAttendeePayments(
+    eventId,
+    accountId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **accountId** | [**string**] | The account 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)
+
+# **getEventAttendeeTransfersLogs**
+> GetAccountInvitations200Response getEventAttendeeTransfersLogs()
+
+Get Event Attendee Transfers Logs endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let accountId: string; //The account 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.getEventAttendeeTransfersLogs(
+    eventId,
+    accountId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **accountId** | [**string**] | The account 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)
+
+# **getEventAttendees**
+> GetEventAttendees200Response getEventAttendees()
+
+Get Event Attendees endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let status: PurchaseStatus; //Filter by status (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.getEventAttendees(
+    eventId,
+    status,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **status** | **PurchaseStatus** | Filter by status | (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
+
+**GetEventAttendees200Response**
+
+### 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)
+
+# **getEventPassAttendeePasses**
+> GetAccountInvitations200Response getEventPassAttendeePasses()
+
+Get Event Pass Attendee Passes endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let passId: string; //The pass identifier (default to undefined)
+let status: PurchaseStatus; //Filter by status (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.getEventPassAttendeePasses(
+    eventId,
+    passId,
+    status,
+    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|
+| **status** | **PurchaseStatus** | Filter by status | (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
+
+**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)
+
+# **resendRegistrationConfirmationEmail**
+> CreateAccountAddress200Response resendRegistrationConfirmationEmail()
+
+Resend Registration Confirmation Email endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let accountId: string; //The account identifier (default to undefined)
+
+const { status, data } = await apiInstance.resendRegistrationConfirmationEmail(
+    eventId,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **accountId** | [**string**] | The account 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)
+
+# **updateEventAttendee**
+> CreateEventAttendee200Response updateEventAttendee(body)
+
+Update Event Attendee endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let accountId: string; //The account identifier (default to undefined)
+let body: object; //
+
+const { status, data } = await apiInstance.updateEventAttendee(
+    eventId,
+    accountId,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **accountId** | [**string**] | The account identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventAttendee200Response**
+
+### 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)
+