# EventsActivationsApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createEventActivation**](#createeventactivation) | **POST** /events/{eventId}/activations | Create an event activation|
|[**createEventActivationCompletion**](#createeventactivationcompletion) | **POST** /events/{eventId}/activations/{activationId}/completions | Record an attendee\'s activation completion|
|[**deleteEventActivation**](#deleteeventactivation) | **DELETE** /events/{eventId}/activations/{activationId} | Delete an event activation|
|[**deleteEventActivationCompletion**](#deleteeventactivationcompletion) | **DELETE** /events/{eventId}/activations/{activationId}/completions/{completionId} | Delete an activation completion record|
|[**getEventActivation**](#geteventactivation) | **GET** /events/{eventId}/activations/{activationId} | Get an event activation|
|[**getEventActivationCompletion**](#geteventactivationcompletion) | **GET** /events/{eventId}/activations/{activationId}/completions/{completionId} | Get an activation completion record|
|[**getEventActivationCompletions**](#geteventactivationcompletions) | **GET** /events/{eventId}/activations/{activationId}/completions | List completions for an activation|
|[**getEventActivationSessions**](#geteventactivationsessions) | **GET** /events/{eventId}/activations/{activationId}/sessions | List sessions linked to an activation|
|[**getEventActivations**](#geteventactivations) | **GET** /events/{eventId}/activations | List an event\'s activations|
|[**updateEventActivation**](#updateeventactivation) | **PUT** /events/{eventId}/activations/{activationId} | Update an event activation|
|[**updateEventActivationCompletion**](#updateeventactivationcompletion) | **PUT** /events/{eventId}/activations/{activationId}/completions/{completionId} | Update an activation completion\'s earned points|

# **createEventActivation**
> CreateEventActivation200Response createEventActivation(eventActivationCreateInputs)

Creates a new activation (e.g. a scavenger-hunt or reward task) on the given event, automatically assigning its display sort order if one is not provided; requires update permission on events.

### 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

**CreateEventActivation200Response**

### 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**
> CreateEventActivationCompletion200Response createEventActivationCompletion(eventActivationCompletionCreateInputs)

Marks an activation as completed for the pass given in the request body, awarding its points (or a specified earned-points amount for \"input\" reward types) and failing if that pass has already completed the activation; requires update permission on events.

### 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

**CreateEventActivationCompletion200Response**

### 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()

Permanently deletes an activation from the given event, along with its association to any sessions; requires update permission on events.

### 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**
> CreateAccountInvitations200Response deleteEventActivationCompletion()

Permanently removes a specific attendee\'s completion record for an event activation, effectively un-completing it; requires update permission on events.

### 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

**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)

# **getEventActivation**
> CreateEventActivation200Response getEventActivation()

Retrieves a single activation by ID or slug for the given event, including its configuration and reward details; requires read access to the event\'s events module.

### 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

**CreateEventActivation200Response**

### 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**
> CreateEventActivationCompletion200Response getEventActivationCompletion()

Retrieves a single completion record for an event activation, showing the pass that completed it and the points earned; requires read access to the event\'s events module.

### 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

**CreateEventActivationCompletion200Response**

### 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**
> GetEventActivationCompletions200Response getEventActivationCompletions()

Returns a paginated list of completion records for an event activation, searchable by the completing attendee\'s name, username, or email; requires read access to the event\'s events module.

### 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

**GetEventActivationCompletions200Response**

### 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)

# **getEventActivationSessions**
> GetEventActivationSessions200Response getEventActivationSessions()

Returns a paginated list of event sessions associated with the specified activation, supporting search and ordering; requires read access to the event\'s events module.

### 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.getEventActivationSessions(
    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

**GetEventActivationSessions200Response**

### 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**
> GetEventActivations200Response getEventActivations()

Returns a paginated list of activations configured for the given event, supporting search and ordering; requires read access to the event\'s events module.

### 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

**GetEventActivations200Response**

### 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**
> CreateEventActivation200Response updateEventActivation(eventActivationUpdateInputs)

Updates the fields of a gamification activation for the given event, such as its name, points, or configuration; requires the update permission on events.

### 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

**CreateEventActivation200Response**

### 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**
> CreateEventActivationCompletion200Response updateEventActivationCompletion(eventActivationCompletionUpdateInputs)

Updates the earned points on an existing completion record for the given event activation, identified by completion id; requires the update permission on events.

### 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

**CreateEventActivationCompletion200Response**

### 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)