@connectedxm/admin-sdk 1.0.0

package/docs/EventsAttendeesReservationsApi.md

@@ -0,0 +1,561 @@
+# EventsAttendeesReservationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addEventReservationPass**](#addeventreservationpass) | **POST** /events/{eventId}/reservations/{reservationId}/passes/{passId} | Add Event Reservation Pass|
+|[**createEventReservation**](#createeventreservation) | **POST** /events/{eventId}/reservations | Create Event Reservation|
+|[**deleteEventReservation**](#deleteeventreservation) | **DELETE** /events/{eventId}/reservations/{reservationId} | Delete Event Reservation|
+|[**getEventAttendeeReservations**](#geteventattendeereservations) | **GET** /events/{eventId}/attendees/{accountId}/reservations | Get Event Attendee Reservations|
+|[**getEventReservation**](#geteventreservation) | **GET** /events/{eventId}/reservations/{reservationId} | Get Event Reservation|
+|[**getEventReservationPasses**](#geteventreservationpasses) | **GET** /events/{eventId}/reservations/{reservationId}/passes | Get Event Reservation Passes|
+|[**getEventReservations**](#geteventreservations) | **GET** /events/{eventId}/reservations | Get Event Reservations|
+|[**removeEventReservationPass**](#removeeventreservationpass) | **DELETE** /events/{eventId}/reservations/{reservationId}/passes/{passId} | Remove Event Reservation Pass|
+|[**updateEventReservation**](#updateeventreservation) | **PUT** /events/{eventId}/reservations/{reservationId} | Update Event Reservation|
+
+# **addEventReservationPass**
+> CreateAccountAddress200Response addEventReservationPass()
+
+Add Event Reservation Pass endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesReservationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesReservationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let reservationId: string; //The reservation identifier (default to undefined)
+let passId: string; //The pass identifier (default to undefined)
+let accountId: string; //Filter by accountId (optional) (default to undefined)
+
+const { status, data } = await apiInstance.addEventReservationPass(
+    eventId,
+    reservationId,
+    passId,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **reservationId** | [**string**] | The reservation identifier | defaults to undefined|
+| **passId** | [**string**] | The pass identifier | defaults to undefined|
+| **accountId** | [**string**] | Filter by accountId | (optional) 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)
+
+# **createEventReservation**
+> CreateAccountAddress200Response createEventReservation(eventRoomTypeReservationCreateInputs)
+
+Create Event Reservation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesReservationsApi,
+    Configuration,
+    EventRoomTypeReservationCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesReservationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let eventRoomTypeReservationCreateInputs: EventRoomTypeReservationCreateInputs; //
+let accountId: string; //Filter by accountId (optional) (default to undefined)
+
+const { status, data } = await apiInstance.createEventReservation(
+    eventId,
+    eventRoomTypeReservationCreateInputs,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventRoomTypeReservationCreateInputs** | **EventRoomTypeReservationCreateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **accountId** | [**string**] | Filter by accountId | (optional) 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)
+
+# **deleteEventReservation**
+> CreateAccountInvitations200Response deleteEventReservation()
+
+Delete Event Reservation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesReservationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesReservationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let reservationId: string; //The reservation identifier (default to undefined)
+let accountId: string; //Filter by accountId (optional) (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventReservation(
+    eventId,
+    reservationId,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **reservationId** | [**string**] | The reservation identifier | defaults to undefined|
+| **accountId** | [**string**] | Filter by accountId | (optional) 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)
+
+# **getEventAttendeeReservations**
+> GetAccountInvitations200Response getEventAttendeeReservations()
+
+Get Event Attendee Reservations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesReservationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesReservationsApi(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.getEventAttendeeReservations(
+    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)
+
+# **getEventReservation**
+> CreateAccountAddress200Response getEventReservation()
+
+Get Event Reservation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesReservationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesReservationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let reservationId: string; //The reservation identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventReservation(
+    eventId,
+    reservationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **reservationId** | [**string**] | The reservation 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)
+
+# **getEventReservationPasses**
+> GetAccountInvitations200Response getEventReservationPasses()
+
+Get Event Reservation Passes endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesReservationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesReservationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let reservationId: string; //The reservation 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.getEventReservationPasses(
+    eventId,
+    reservationId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **reservationId** | [**string**] | The reservation 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)
+
+# **getEventReservations**
+> GetAccountInvitations200Response getEventReservations()
+
+Get Event Reservations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesReservationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesReservationsApi(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.getEventReservations(
+    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
+
+**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)
+
+# **removeEventReservationPass**
+> CreateAccountAddress200Response removeEventReservationPass()
+
+Remove Event Reservation Pass endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesReservationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesReservationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let reservationId: string; //The reservation identifier (default to undefined)
+let passId: string; //The pass identifier (default to undefined)
+let accountId: string; //Filter by accountId (optional) (default to undefined)
+
+const { status, data } = await apiInstance.removeEventReservationPass(
+    eventId,
+    reservationId,
+    passId,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **reservationId** | [**string**] | The reservation identifier | defaults to undefined|
+| **passId** | [**string**] | The pass identifier | defaults to undefined|
+| **accountId** | [**string**] | Filter by accountId | (optional) 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)
+
+# **updateEventReservation**
+> CreateAccountAddress200Response updateEventReservation(eventRoomTypeReservationUpdateInputs)
+
+Update Event Reservation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsAttendeesReservationsApi,
+    Configuration,
+    EventRoomTypeReservationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsAttendeesReservationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let reservationId: string; //The reservation identifier (default to undefined)
+let eventRoomTypeReservationUpdateInputs: EventRoomTypeReservationUpdateInputs; //
+let accountId: string; //Filter by accountId (optional) (default to undefined)
+
+const { status, data } = await apiInstance.updateEventReservation(
+    eventId,
+    reservationId,
+    eventRoomTypeReservationUpdateInputs,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventRoomTypeReservationUpdateInputs** | **EventRoomTypeReservationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **reservationId** | [**string**] | The reservation identifier | defaults to undefined|
+| **accountId** | [**string**] | Filter by accountId | (optional) 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/EventsBenefitsApi.md

@@ -0,0 +1,117 @@
+# EventsBenefitsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addEventBenefit**](#addeventbenefit) | **POST** /events/{eventId}/benefits/{benefitId} | Add Event Benefit|
+|[**removeEventBenefit**](#removeeventbenefit) | **DELETE** /events/{eventId}/benefits/{benefitId} | Remove Event Benefit|
+
+# **addEventBenefit**
+> CreateBenefit200Response addEventBenefit()
+
+Add Event Benefit endpoint
+
+### Example
+
+```typescript
+import {
+    EventsBenefitsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsBenefitsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let benefitId: string; //The benefit identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventBenefit(
+    eventId,
+    benefitId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **benefitId** | [**string**] | The benefit identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateBenefit200Response**
+
+### 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)
+
+# **removeEventBenefit**
+> CreateBenefit200Response removeEventBenefit()
+
+Remove Event Benefit endpoint
+
+### Example
+
+```typescript
+import {
+    EventsBenefitsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsBenefitsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let benefitId: string; //The benefit identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventBenefit(
+    eventId,
+    benefitId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **benefitId** | [**string**] | The benefit identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateBenefit200Response**
+
+### 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)
+