@connectedxm/admin-sdk 1.0.0

package/docs/EventsActivationsApi.md

@@ -0,0 +1,600 @@
+# EventsActivationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createEventActivation**](#createeventactivation) | **POST** /events/{eventId}/activations | Create Event Activation|
+|[**createEventActivationCompletion**](#createeventactivationcompletion) | **POST** /events/{eventId}/activations/{activationId}/completions | Create Event Activation Completion|
+|[**deleteEventActivation**](#deleteeventactivation) | **DELETE** /events/{eventId}/activations/{activationId} | Delete Event Activation|
+|[**deleteEventActivationCompletion**](#deleteeventactivationcompletion) | **DELETE** /events/{eventId}/activations/{activationId}/completions/{completionId} | Delete Event Activation Completion|
+|[**getEventActivation**](#geteventactivation) | **GET** /events/{eventId}/activations/{activationId} | Get Event Activation|
+|[**getEventActivationCompletion**](#geteventactivationcompletion) | **GET** /events/{eventId}/activations/{activationId}/completions/{completionId} | Get Event Activation Completion|
+|[**getEventActivationCompletions**](#geteventactivationcompletions) | **GET** /events/{eventId}/activations/{activationId}/completions | Get Event Activation Completions|
+|[**getEventActivations**](#geteventactivations) | **GET** /events/{eventId}/activations | Get Event Activations|
+|[**updateEventActivation**](#updateeventactivation) | **PUT** /events/{eventId}/activations/{activationId} | Update Event Activation|
+|[**updateEventActivationCompletion**](#updateeventactivationcompletion) | **PUT** /events/{eventId}/activations/{activationId}/completions/{completionId} | Update Event Activation Completion|
+
+# **createEventActivation**
+> CreateAccountAddress200Response createEventActivation(eventActivationCreateInputs)
+
+Create Event Activation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsActivationsApi,
+    Configuration,
+    EventActivationCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsActivationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let eventActivationCreateInputs: EventActivationCreateInputs; //
+
+const { status, data } = await apiInstance.createEventActivation(
+    eventId,
+    eventActivationCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventActivationCreateInputs** | **EventActivationCreateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | 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)
+
+# **createEventActivationCompletion**
+> CreateAccountAddress200Response createEventActivationCompletion(eventActivationCompletionCreateInputs)
+
+Create Event Activation Completion endpoint
+
+### Example
+
+```typescript
+import {
+    EventsActivationsApi,
+    Configuration,
+    EventActivationCompletionCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsActivationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let activationId: string; //The activation identifier (default to undefined)
+let eventActivationCompletionCreateInputs: EventActivationCompletionCreateInputs; //
+
+const { status, data } = await apiInstance.createEventActivationCompletion(
+    eventId,
+    activationId,
+    eventActivationCompletionCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventActivationCompletionCreateInputs** | **EventActivationCompletionCreateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **activationId** | [**string**] | The activation identifier | 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)
+
+# **deleteEventActivation**
+> CreateAccountInvitations200Response deleteEventActivation()
+
+Delete Event Activation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsActivationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsActivationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let activationId: string; //The activation identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventActivation(
+    eventId,
+    activationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **activationId** | [**string**] | The activation 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)
+
+# **deleteEventActivationCompletion**
+> CreateAccountAddress200Response deleteEventActivationCompletion()
+
+Delete Event Activation Completion endpoint
+
+### Example
+
+```typescript
+import {
+    EventsActivationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsActivationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let activationId: string; //The activation identifier (default to undefined)
+let completionId: string; //The completion identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventActivationCompletion(
+    eventId,
+    activationId,
+    completionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **activationId** | [**string**] | The activation identifier | defaults to undefined|
+| **completionId** | [**string**] | The completion 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)
+
+# **getEventActivation**
+> GetEventActivation200Response getEventActivation()
+
+Get Event Activation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsActivationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsActivationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let activationId: string; //The activation identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventActivation(
+    eventId,
+    activationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **activationId** | [**string**] | The activation identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventActivation200Response**
+
+### 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)
+
+# **getEventActivationCompletion**
+> CreateAccountAddress200Response getEventActivationCompletion()
+
+Get Event Activation Completion endpoint
+
+### Example
+
+```typescript
+import {
+    EventsActivationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsActivationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let activationId: string; //The activation identifier (default to undefined)
+let completionId: string; //The completion identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventActivationCompletion(
+    eventId,
+    activationId,
+    completionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **activationId** | [**string**] | The activation identifier | defaults to undefined|
+| **completionId** | [**string**] | The completion 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)
+
+# **getEventActivationCompletions**
+> GetAccountInvitations200Response getEventActivationCompletions()
+
+Get Event Activation Completions endpoint
+
+### Example
+
+```typescript
+import {
+    EventsActivationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsActivationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let activationId: string; //The activation 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.getEventActivationCompletions(
+    eventId,
+    activationId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **activationId** | [**string**] | The activation 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)
+
+# **getEventActivations**
+> GetAccountInvitations200Response getEventActivations()
+
+Get Event Activations endpoint
+
+### Example
+
+```typescript
+import {
+    EventsActivationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsActivationsApi(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.getEventActivations(
+    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)
+
+# **updateEventActivation**
+> CreateAccountAddress200Response updateEventActivation(eventActivationUpdateInputs)
+
+Update Event Activation endpoint
+
+### Example
+
+```typescript
+import {
+    EventsActivationsApi,
+    Configuration,
+    EventActivationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsActivationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let activationId: string; //The activation identifier (default to undefined)
+let eventActivationUpdateInputs: EventActivationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventActivation(
+    eventId,
+    activationId,
+    eventActivationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventActivationUpdateInputs** | **EventActivationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **activationId** | [**string**] | The activation identifier | 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)
+
+# **updateEventActivationCompletion**
+> CreateAccountAddress200Response updateEventActivationCompletion(eventActivationCompletionUpdateInputs)
+
+Update Event Activation Completion endpoint
+
+### Example
+
+```typescript
+import {
+    EventsActivationsApi,
+    Configuration,
+    EventActivationCompletionUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsActivationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let activationId: string; //The activation identifier (default to undefined)
+let completionId: string; //The completion identifier (default to undefined)
+let eventActivationCompletionUpdateInputs: EventActivationCompletionUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventActivationCompletion(
+    eventId,
+    activationId,
+    completionId,
+    eventActivationCompletionUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventActivationCompletionUpdateInputs** | **EventActivationCompletionUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **activationId** | [**string**] | The activation identifier | defaults to undefined|
+| **completionId** | [**string**] | The completion identifier | 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)
+