OBT Live - Engage AI - Management API

npm install --save @obtlive/[email protected]

yarn add @obtlive/[email protected]

Introduction

This API contains endpoints which enable management of your Engage AI instance.

It is intended to be accessed by LiveOps Operators and Backend System Integrations.

Constants

• ListAchievementsSortOrderEnum
• ListApiKeysSortOrderEnum
• ListFeaturesSortOrderEnum
• ListOperatorsSortOrderEnum
• ListEntityTotalsSortOrderEnum
• ListEventsSortOrderEnum
• ListRuleExecutionsSortOrderEnum
• ListRuleExecutionsByDaySortOrderEnum
• ListConversationsSortOrderEnum
• ListAttributesSortOrderEnum
• ListBoostersSortOrderEnum
• ListConsumablesSortOrderEnum
• ListItemsSortOrderEnum
• ListCustomEventDefinitionsSortOrderEnum
• ListLeaderboardsByTypeTypeEnum
• ListLeaderboardsByTypeSortOrderEnum
• ListLevelsSortOrderEnum
• ListMissionsSortOrderEnum
• ListWebhooksSortOrderEnum
• ListQuestionsSortOrderEnum
• ListQuizzesSortOrderEnum
• ListRulesSortOrderEnum
• ListSegmentUsersSortOrderEnum
• ListSegmentsSortOrderEnum
• ListStreaksSortOrderEnum
• ListTiersSortOrderEnum
• ListMissionsForUserSortOrderEnum
• ListSegmentsForUserSortOrderEnum
• ListStreaksForUserSortOrderEnum
• ListUserAchievementsSortOrderEnum
• ListUserActivitySortOrderEnum
• ListUserBoostersSortOrderEnum
• ListUserConsumablesSortOrderEnum
• ListUserItemsSortOrderEnum
• ListUserQuizzesSortOrderEnum
• ListUsersSortOrderEnum

ListAchievementsSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListAchievementsSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListApiKeysSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListApiKeysSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListFeaturesSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListFeaturesSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListOperatorsSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListOperatorsSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListEntityTotalsSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListEntityTotalsSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListEventsSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListEventsSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListRuleExecutionsSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListRuleExecutionsSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListRuleExecutionsByDaySortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListRuleExecutionsByDaySortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListConversationsSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListConversationsSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListAttributesSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListAttributesSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListBoostersSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListBoostersSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListConsumablesSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListConsumablesSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListItemsSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListItemsSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListCustomEventDefinitionsSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListCustomEventDefinitionsSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListLeaderboardsByTypeTypeEnum

| Constant | Type | | ---------- | ---------- | | ListLeaderboardsByTypeTypeEnum | { readonly Quiz: "quiz"; readonly UserAttribute: "user-attribute"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListLeaderboardsByTypeSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListLeaderboardsByTypeSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListLevelsSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListLevelsSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListMissionsSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListMissionsSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListWebhooksSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListWebhooksSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListQuestionsSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListQuestionsSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListQuizzesSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListQuizzesSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListRulesSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListRulesSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListSegmentUsersSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListSegmentUsersSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListSegmentsSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListSegmentsSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListStreaksSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListStreaksSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListTiersSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListTiersSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListMissionsForUserSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListMissionsForUserSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListSegmentsForUserSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListSegmentsForUserSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListStreaksForUserSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListStreaksForUserSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListUserAchievementsSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListUserAchievementsSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListUserActivitySortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListUserActivitySortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListUserBoostersSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListUserBoostersSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListUserConsumablesSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListUserConsumablesSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListUserItemsSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListUserItemsSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListUserQuizzesSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListUserQuizzesSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

ListUsersSortOrderEnum

| Constant | Type | | ---------- | ---------- | | ListUsersSortOrderEnum | { readonly Asc: "ASC"; readonly Desc: "DESC"; readonly UnknownDefaultOpenApi: "11184809"; } |

AchievementsApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• deleteAchievement
• getAchievementById
• listAchievements
• setAchievement

deleteAchievement

This endpoint is used to delete an Achievement. Delete a Achievement

| Method | Type | | ---------- | ---------- | | deleteAchievement | (achievementId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

getAchievementById

Get a single Achievement specified by its ID

| Method | Type | | ---------- | ---------- | | getAchievementById | (achievementId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetAchievementByIdResponseDto> |

listAchievements

Retrieve multiple Achievements

| Method | Type | | ---------- | ---------- | | listAchievements | (fields: string, sortOrder?: ListAchievementsSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, name?: string[] or undefined, description?: string[] or undefined, initOverrides?: RequestInit or ... 1 more ... or un... |

setAchievement

This endpoint is used to update properties of an Achievement. Create or Update a Achievement

| Method | Type | | ---------- | ---------- | | setAchievement | (achievementId: string, setAchievementCommand: SetAchievementCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

AdminApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• createApiKey
• createFeature
• createOperator
• deleteApiKey
• deleteFeature
• deleteOperator
• getApiKeyById
• getEngageFeatures
• getFeatureById
• getOperatorById
• isFeatureEnabled
• listApiKeys
• listFeatures
• listOperators
• login
• requestPasswordReset
• resetPassword
• setFeatureEnabled
• updateApiKey
• updateOperator

createApiKey

Create an API Key

| Method | Type | | ---------- | ---------- | | createApiKey | (createApiKeyBodyCommand: CreateApiKeyBodyCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

createFeature

Create a Feature

| Method | Type | | ---------- | ---------- | | createFeature | (createFeatureCommand: CreateFeatureCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

createOperator

Create an Operator User

| Method | Type | | ---------- | ---------- | | createOperator | (createOperatorBodyDto: CreateOperatorBodyDto, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

deleteApiKey

This endpoint is used to delete an ApiKey. Delete an API Key

| Method | Type | | ---------- | ---------- | | deleteApiKey | (id: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

deleteFeature

This endpoint is used to delete a Feature. Delete a Feature

| Method | Type | | ---------- | ---------- | | deleteFeature | (featureId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

deleteOperator

This endpoint is used to delete an Operator. Delete an Operator

| Method | Type | | ---------- | ---------- | | deleteOperator | (operatorId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

getApiKeyById

Get a single API Key specified by its ID

| Method | Type | | ---------- | ---------- | | getApiKeyById | (id: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetApiKeyByIdResponseDto> |

getEngageFeatures

Get the config for all visible engage Features

| Method | Type | | ---------- | ---------- | | getEngageFeatures | (initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<FeaturesResponseDto> |

getFeatureById

Get a single Feature specified by its ID

| Method | Type | | ---------- | ---------- | | getFeatureById | (featureId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetFeatureResponseDto> |

getOperatorById

Get a single Operator specified by its ID

| Method | Type | | ---------- | ---------- | | getOperatorById | (operatorId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetOperatorByIdResponseDto> |

isFeatureEnabled

Check whether a specific feature is enabled

| Method | Type | | ---------- | ---------- | | isFeatureEnabled | (id: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<IsFeatureEnabledResponseDto> |

listApiKeys

Retrieve multiple API Keys

| Method | Type | | ---------- | ---------- | | listApiKeys | (fields: string, sortOrder?: ListApiKeysSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, createdAt?: string[] or undefined, expiresOn?: string[] or undefined, isEnabled?: string[] or undefined, initOverrides?: RequestInit or ... 1 more ...... |

listFeatures

Retrieve multiple Features

| Method | Type | | ---------- | ---------- | | listFeatures | (fields: string, sortOrder?: ListFeaturesSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, createDate?: string[] or undefined, updateDate?: string[] or undefined, isEnabled?: string[] or undefined, title?: string... |

listOperators

Retrieve multiple Operators

| Method | Type | | ---------- | ---------- | | listOperators | (fields: string, sortOrder?: ListOperatorsSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, externalIdentifier?: string[] or undefined, createDate?: string[] or undefined, updateDate?: string[] or undefined, role... |

login

Login as an Operator

| Method | Type | | ---------- | ---------- | | login | (loginBodyDto: LoginBodyDto, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<LoginResponseDto> |

requestPasswordReset

Request a Password Reset Link for an Operator

| Method | Type | | ---------- | ---------- | | requestPasswordReset | (requestPasswordResetBodyDto: RequestPasswordResetBodyDto, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

resetPassword

Reset an Operator's Password

| Method | Type | | ---------- | ---------- | | resetPassword | (resetPasswordBodyDto: ResetPasswordBodyDto, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

setFeatureEnabled

Set a Feature's enabled status

| Method | Type | | ---------- | ---------- | | setFeatureEnabled | (featureId: string, setFeatureEnabledCommand: SetFeatureEnabledCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

updateApiKey

Update an API Key

| Method | Type | | ---------- | ---------- | | updateApiKey | (id: string, updateApiKeyBodyCommand: UpdateApiKeyBodyCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

updateOperator

This endpoint is used to update an Operator. Update an Operator

| Method | Type | | ---------- | ---------- | | updateOperator | (operatorId: string, updateOperatorBodyDto: UpdateOperatorBodyDto, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

AnalyticsApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• generateReportData
• listEntityTotals
• listEvents
• listRuleExecutions
• listRuleExecutionsByDay

generateReportData

Generate Report Data

| Method | Type | | ---------- | ---------- | | generateReportData | (executeSqlBodyDto: ExecuteSqlBodyDto, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<ExecuteSqlResponseDto> |

listEntityTotals

List the count of various entities in the system day-by-day

| Method | Type | | ---------- | ---------- | | listEntityTotals | (fields: string, sortOrder?: ListEntityTotalsSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, day?: string[] or undefined, quizzesCreatedCount?: string[] or undefined, quizzesDeletedCount?: string[] or undefined, quizzesDelta?: string[] |... |

listEvents

List all Events in the event log

| Method | Type | | ---------- | ---------- | | listEvents | (fields: string, sortOrder?: ListEventsSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, eventId?: string[] or undefined, correlationId?: string[] or undefined, aggregateId?: string[] or undefined, eventName?: string[] or undefined, initOve... |

listRuleExecutions

Retrieve multiple RuleExecutions

| Method | Type | | ---------- | ---------- | | listRuleExecutions | (fields: string, sortOrder?: ListRuleExecutionsSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, ruleId?: string[] or undefined, timestamp?: string[] or undefined, status?: string[] or undefined, reason?: string[... |

listRuleExecutionsByDay

Retrieve multiple RuleExecutionsByDay

| Method | Type | | ---------- | ---------- | | listRuleExecutionsByDay | (fields: string, sortOrder?: ListRuleExecutionsByDaySortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, day?: string[] or undefined, count?: string[] or undefined, executedCount?: string[] or undefined, initOverrides?: RequestInit or ... 1 mo... |

AssistantApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• createConversation
• createCustomInsights
• createMessages
• getConversationById
• listConversations

createConversation

Create a Conversation

| Method | Type | | ---------- | ---------- | | createConversation | (initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<CreateConversationResponseDto> |

createCustomInsights

Create a insights based on a set of questions

| Method | Type | | ---------- | ---------- | | createCustomInsights | (createCustomInsightsDto: CreateCustomInsightsDto, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

createMessages

Create messages for a conversation

| Method | Type | | ---------- | ---------- | | createMessages | (conversationId: string, createChatMessageBodyDto: CreateChatMessageBodyDto, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

getConversationById

Get a conversation specified by its ID

| Method | Type | | ---------- | ---------- | | getConversationById | (conversationId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetConversationByIdResponseDto> |

listConversations

List conversations

| Method | Type | | ---------- | ---------- | | listConversations | (fields: string, sortOrder?: ListConversationsSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, ownerId?: string[] or undefined, createdAt?: string[] or undefined, initOverrides?: RequestInit or ... 1 more ... or undefined) => Promise<...> |

AttributesApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• deleteAttribute
• getAttributeById
• listAttributes
• updateAttribute

deleteAttribute

This endpoint is used to delete an Attribute. Delete a Attribute

| Method | Type | | ---------- | ---------- | | deleteAttribute | (attributeId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

getAttributeById

Get a single Attribute specified by its ID

| Method | Type | | ---------- | ---------- | | getAttributeById | (attributeId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetAttributeByIdResponseDto> |

listAttributes

Retrieve multiple Attributes

| Method | Type | | ---------- | ---------- | | listAttributes | (fields: string, sortOrder?: ListAttributesSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, displayName?: string[] or undefined, description?: string[] or undefined, cannotDecrease?: string[] or undefined, canno... |

updateAttribute

This endpoint is used to update properties of an Attribute. Create or Update a Attribute

| Method | Type | | ---------- | ---------- | | updateAttribute | (attributeId: string, setAttributeCommand: SetAttributeCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

ConsumablesApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• deleteBooster
• deleteItem
• getBoosterById
• getItemById
• listBoosters
• listConsumables
• listItems
• setBooster
• setItem

deleteBooster

This endpoint is used to remove a Booster from the system. All values stored on Users for this Booster will be removed. No feedback is provided if the referenced Booster was not found. Remove a Booster

| Method | Type | | ---------- | ---------- | | deleteBooster | (boosterId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

deleteItem

This endpoint is used to remove an Item from the system. All values stored on Users for this Item will be removed. No feedback is provided if the referenced Item was not found. Remove an Item

| Method | Type | | ---------- | ---------- | | deleteItem | (itemId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

getBoosterById

This endpoint is used to retrieve a single Booster. The boosterId parameter specifies which Booster to retrieve. Get a single Booster by its ID

| Method | Type | | ---------- | ---------- | | getBoosterById | (boosterId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetBoosterByIdResponseDto> |

getItemById

This endpoint is used to retrieve a single Item. The itemId parameter specifies which Item to retrieve. Get a single Item by its ID

| Method | Type | | ---------- | ---------- | | getItemById | (itemId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetItemByIdResponseDto> |

listBoosters

This endpoint is used to query for multiple Boosters. It supports the standard filtering and pagination syntax described in the API Overview. Retrieve multiple Boosters

| Method | Type | | ---------- | ---------- | | listBoosters | (fields: string, sortOrder?: ListBoostersSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, displayName?: string[] or undefined, initOverrides?: RequestInit or ... 1 more ... or undefined) => Promise<...> |

listConsumables

This endpoint is used to query for multiple Consumables regardless of their type. It supports the standard filtering and pagination syntax described in the API Overview. Retrieve multiple Consumables

| Method | Type | | ---------- | ---------- | | listConsumables | (fields: string, sortOrder?: ListConsumablesSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, displayName?: string[] or undefined, initOverrides?: RequestInit or ... 1 more ... or undefined) => Promise<...> |

listItems

This endpoint is used to query for multiple Items. It supports the standard filtering and pagination syntax described in the API Overview. Retrieve multiple Items

| Method | Type | | ---------- | ---------- | | listItems | (fields: string, sortOrder?: ListItemsSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, displayName?: string[] or undefined, initOverrides?: RequestInit or ... 1 more ... or undefined) => Promise<...> |

setBooster

This endpoint is used to set the properties of a Booster. If the Booster referenced by the provided boosterId does not already exist, it is created. If the Booster already exists, then only the provided values are updated. Create or Update a Booster Consumable

| Method | Type | | ---------- | ---------- | | setBooster | (boosterId: string, setBoosterCommand: SetBoosterCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

setItem

This endpoint is used to set the properties of an Item. If the Item referenced by the provided itemId does not already exist, it is created. If the Item already exists, then only the provided values are updated. Create or Update an Item Consumable

| Method | Type | | ---------- | ---------- | | setItem | (itemId: string, setItemCommand: SetItemCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

CustomEventsApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• createCustomEventDefinition
• deleteCustomEventDefinition
• getCustomEventDefinitionById
• listCustomEventDefinitions
• publishUserCustomEvent
• updateCustomEventDefinition

createCustomEventDefinition

This endpoint is used to create a CustomEvent definition in Engage which can subsequently be published. Define a new CustomEvent Definition

| Method | Type | | ---------- | ---------- | | createCustomEventDefinition | (createCustomEventDefinitionCommand: CreateCustomEventDefinitionCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

deleteCustomEventDefinition

This endpoint is used to remove a CustomEvent definition from the system. Remove a CustomEvent definition from the system

| Method | Type | | ---------- | ---------- | | deleteCustomEventDefinition | (customEventDefinitionId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

getCustomEventDefinitionById

Get a single Custom Event Definition specified by its ID and, optionally, version

| Method | Type | | ---------- | ---------- | | getCustomEventDefinitionById | (customEventDefinitionId: string, version?: string or undefined, version2?: string or undefined, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

listCustomEventDefinitions

Retrieve multiple CustomEvent Definitions

| Method | Type | | ---------- | ---------- | | listCustomEventDefinitions | (fields: string, sortOrder?: ListCustomEventDefinitionsSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, eventName?: string[] or undefined, version?: string[] or undefined, initOverrides?: RequestInit or ... 1 mo... |

publishUserCustomEvent

This endpoint is used to publish a CustomEvent for a specific User. Publish a CustomEvent for a specific User

| Method | Type | | ---------- | ---------- | | publishUserCustomEvent | (userId: string, customEventDefinitionId: string, requestBody: { [key: string]: AnyPrimitiveValueOrNull; }, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

updateCustomEventDefinition

This endpoint is used to update an existing CustomEvent definition. Update an existing CustomEvent definition

| Method | Type | | ---------- | ---------- | | updateCustomEventDefinition | (customEventDefinitionId: string, updateCustomEventDefinitionCommand: UpdateCustomEventDefinitionCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

EventsApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• getEventProperties

getEventProperties

Get all properties of an event, expressed as dot-notation strings. These can be used as the value for the eventProperty field of Rule Queries and Rule Query Inputs. Get an Event's properties

| Method | Type | | ---------- | ---------- | | getEventProperties | (eventVersion: number, eventName: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetEventPropertiesResponseDto> |

HealthApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• terminusControllerCheck

terminusControllerCheck

| Method | Type | | ---------- | ---------- | | terminusControllerCheck | (initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<TerminusControllerCheck200Response> |

LeaderboardsApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• listLeaderboardsByType

listLeaderboardsByType

Retrieve multiple Leaderboards

| Method | Type | | ---------- | ---------- | | listLeaderboardsByType | (type: ListLeaderboardsByTypeTypeEnum, fields: string, sortOrder?: ListLeaderboardsByTypeSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, itemId?: string[] or undefined, userId?: string[] or undefined, value?: string[] or undefined, posit... |

LevelsApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• deleteLevels
• listLevels
• setLevels

deleteLevels

This endpoint is used to delete all Level entities related to an Attribute. Delete all Levels relating to a specific Attribute

| Method | Type | | ---------- | ---------- | | deleteLevels | (attributeId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

listLevels

Retrieve multiple Levels

| Method | Type | | ---------- | ---------- | | listLevels | (fields: string, sortOrder?: ListLevelsSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, attributeId?: string[] or undefined, levelNumber?: string[] or undefined, minimumAttributeValue?: string[] or undefined, maximumAttributeValue?: strin... |

setLevels

This endpoint is used to set all of the Levels for a specific Attribute Set all the Levels for an Attribute

| Method | Type | | ---------- | ---------- | | setLevels | (attributeId: string, setLevelsCommand: SetLevelsCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

MissionsApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• deleteMission
• getMissionById
• listMissions
• updateMission

deleteMission

This endpoint is used to delete a Mission. Delete a Mission

| Method | Type | | ---------- | ---------- | | deleteMission | (missionId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

getMissionById

Get a single Mission specified by its ID

| Method | Type | | ---------- | ---------- | | getMissionById | (missionId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetMissionByIdResponseDto> |

listMissions

Retrieve multiple Missions

| Method | Type | | ---------- | ---------- | | listMissions | (fields: string, sortOrder?: ListMissionsSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, displayName?: string[] or undefined, description?: string[] or undefined, tags?: string[] or undefined, initOverrides?: R... |

updateMission

This endpoint is used to update a Mission. Create or Update a Mission

| Method | Type | | ---------- | ---------- | | updateMission | (missionId: string, setMissionCommand: SetMissionCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

NotificationsApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• createWebhook
• deleteWebhook
• getWebhookById
• listWebhooks
• updateWebhook

createWebhook

This endpoint is used to create a Webhook Create a Webhook

| Method | Type | | ---------- | ---------- | | createWebhook | (createWebhookCommand: CreateWebhookCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

deleteWebhook

This endpoint is used to remove a Webhook from the system. Remove a Webhook

| Method | Type | | ---------- | ---------- | | deleteWebhook | (webhookId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

getWebhookById

This endpoint is used to retrieve a single Webhook. The webhookId parameter specifies which Webhook to retrieve. Get a single Webhook by its ID

| Method | Type | | ---------- | ---------- | | getWebhookById | (webhookId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetWebhookByIdResponseDto> |

listWebhooks

This endpoint is used to query for multiple Webhooks regardless of their type. It supports the standard filtering and pagination syntax described in the API Overview. Retrieve multiple Webhooks

| Method | Type | | ---------- | ---------- | | listWebhooks | (fields: string, sortOrder?: ListWebhooksSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, createDate?: string[] or undefined, updateDate?: string[] or undefined, listenerUrl?: string[] or undefined, isEnabled?: ... |

updateWebhook

This endpoint is used to update a Webhook Update a Webhook

| Method | Type | | ---------- | ---------- | | updateWebhook | (webhookId: string, updateWebhookCommand: UpdateWebhookCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

QuizzesApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• deleteQuiz
• getQuizById
• listQuestions
• listQuizzes
• setQuestion
• setQuestionAnswer
• updateQuiz

deleteQuiz

This endpoint is used to delete a Quiz. Delete a Quiz

| Method | Type | | ---------- | ---------- | | deleteQuiz | (quizId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

getQuizById

Get a single Quiz specified by its ID

| Method | Type | | ---------- | ---------- | | getQuizById | (quizId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetQuizByIdResponseDto> |

listQuestions

This endpoint is used to query for multiple Questions. It supports the standard filtering and pagination syntax described in the API Overview. Retrieve multiple Questions

| Method | Type | | ---------- | ---------- | | listQuestions | (quizId: string, fields: string, sortOrder?: ListQuestionsSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, text?: string[] or undefined, type?: string[] or undefined, initOverrides?: RequestInit or ... 1 more ..... |

listQuizzes

Retrieve multiple Quizzes

| Method | Type | | ---------- | ---------- | | listQuizzes | (fields: string, sortOrder?: ListQuizzesSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, name?: string[] or undefined, description?: string[] or undefined, category?: string[] or undefined, isActive?: string[] |... |

setQuestion

This endpoint is used to set the properties of a Question. If the Multiple Chocie Question referenced by the provided questionId does not already exist, it is created. If the Question already exists, then only the properties provided are updated. Create or Update a Question

| Method | Type | | ---------- | ---------- | | setQuestion | (quizId: string, questionId: string, setQuestionCommand: SetQuestionCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

setQuestionAnswer

This endpoint is used to set the properties of an Answer. If the Answer referenced by the provided questionId and answerId does not already exist, it is created. If the Answer already exists, then only the properties provided are updated. Create or Update an Answer

| Method | Type | | ---------- | ---------- | | setQuestionAnswer | (quizId: string, questionId: string, answerId: string, setQuestionAnswerRequest: SetQuestionAnswerRequest, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

updateQuiz

This endpoint is used to set the properties of a Quiz. Create or Update a Quiz

| Method | Type | | ---------- | ---------- | | updateQuiz | (quizId: string, setQuizCommand: SetQuizCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

RulesApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• deleteRule
• getRuleById
• listActions
• listQueries
• listRules
• listTriggers
• updateRule
• updateRuleV2

deleteRule

This endpoint is used to delete a Rule. Delete a Rule

| Method | Type | | ---------- | ---------- | | deleteRule | (ruleId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

getRuleById

Get a single Rule specified by its ID

| Method | Type | | ---------- | ---------- | | getRuleById | (ruleId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetRuleByIdResponseDto> |

listActions

List all known Actions

| Method | Type | | ---------- | ---------- | | listActions | (initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<ListActionsResponseDto> |

listQueries

List all known Queries

| Method | Type | | ---------- | ---------- | | listQueries | (initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<ListQueriesResponseDto> |

listRules

Retrieve multiple Rules

| Method | Type | | ---------- | ---------- | | listRules | (fields: string, sortOrder?: ListRulesSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, displayName?: string[] or undefined, description?: string[] or undefined, ownedByEntityType?: string[] or undefined, ownedBy... |

listTriggers

List all known Triggers

| Method | Type | | ---------- | ---------- | | listTriggers | (initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<ListTriggersResponseDto> |

updateRule

This endpoint is used to update a Rule. Create or Update a Rule

| Method | Type | | ---------- | ---------- | | updateRule | (ruleId: string, setRuleCommandWithoutId: SetRuleCommandWithoutId, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

updateRuleV2

This endpoint is used to set the properties of a V2 Rule. If the Rule referenced by the provided ruleId does not already exist, it is created. If the Rule already exists, then only the provided values are updated. Create or Update a V2 Rule

| Method | Type | | ---------- | ---------- | | updateRuleV2 | (ruleId: string, updateRuleV2Request: UpdateRuleV2Request, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

SegmentsApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• deleteSegment
• getSegmentById
• listSegmentUsers
• listSegments
• updateSegment
• updateSegmentV2

deleteSegment

This endpoint is used to delete an Segment. Delete a Segment

| Method | Type | | ---------- | ---------- | | deleteSegment | (segmentId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

getSegmentById

Get a single Segment specified by its ID

| Method | Type | | ---------- | ---------- | | getSegmentById | (segmentId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetSegmentByIdResponseDto> |

listSegmentUsers

Retrieve the Users that belong to a Segment

| Method | Type | | ---------- | ---------- | | listSegmentUsers | (segmentId: string, fields: string, sortOrder?: ListSegmentUsersSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, userId?: string[] or undefined, displayName?: string[] or undefined, initOverrides?: RequestInit or ... 1 more ... or undefine... |

listSegments

Retrieve multiple Segments

| Method | Type | | ---------- | ---------- | | listSegments | (fields: string, sortOrder?: ListSegmentsSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, displayName?: string[] or undefined, initOverrides?: RequestInit or ... 1 more ... or undefined) => Promise<...> |

updateSegment

This endpoint is used to update properties of a Segment. Create or Update a Segment

| Method | Type | | ---------- | ---------- | | updateSegment | (segmentId: string, setSegmentCommand: SetSegmentCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

updateSegmentV2

This endpoint is used to set the properties of a V2 Segment with entry and exit criteria rules. If the Segment referenced by the provided segmentId does not already exist, it is created. If the Segment already exists, then only the provided values are updated. Create or Update a V2 Segment

| Method | Type | | ---------- | ---------- | | updateSegmentV2 | (segmentId: string, setSegmentV2Command: SetSegmentV2Command, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

StreaksApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• createStreak
• deleteStreak
• getStreakById
• listStreaks
• updateStreak

createStreak

This endpoint is used to Create a Streak. Create a Streak

| Method | Type | | ---------- | ---------- | | createStreak | (createStreakRequest: CreateStreakRequest, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

deleteStreak

This endpoint is used to delete a Streak. Delete a Streak

| Method | Type | | ---------- | ---------- | | deleteStreak | (streakId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

getStreakById

Get a single Streak specified by its ID

| Method | Type | | ---------- | ---------- | | getStreakById | (streakId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetStreakByIdResponseDto> |

listStreaks

Retrieve multiple Streaks

| Method | Type | | ---------- | ---------- | | listStreaks | (fields: string, sortOrder?: ListStreaksSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, name?: string[] or undefined, milestonesFields?: string or undefined, milestonesOrder?: string[] or undefined, milestonesN... |

updateStreak

This endpoint is used to update a Streak. Update a Streak

| Method | Type | | ---------- | ---------- | | updateStreak | (streakId: string, updateStreakRequest: UpdateStreakRequest, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

TiersApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• deleteTiers
• listTiers
• setTiers

deleteTiers

This endpoint is used to delete all Tier entities related to an Attribute. Delete all Tiers relating to a specific Attribute

| Method | Type | | ---------- | ---------- | | deleteTiers | (attributeId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

listTiers

Retrieve multiple Tiers

| Method | Type | | ---------- | ---------- | | listTiers | (fields: string, sortOrder?: ListTiersSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, attributeId?: string[] or undefined, tierName?: string[] or undefined, minimumLevelValue?: string[] or undefined, maximumLevelValue?: string[] or undefi... |

setTiers

This endpoint is used to set all of the Tiers for a specific Attribute Set all the Tiers for an Attribute

| Method | Type | | ---------- | ---------- | | setTiers | (attributeId: string, setTiersCommand: SetTiersCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

UsersApi

Constructors

public: Creates an instance of the API class

Parameters:

• configuration

Methods

• addUserToSegment
• createUser
• deleteUser
• enrolUserInQuiz
• getUserAchievementById
• getUserAttributeById
• getUserById
• getUserLevelByUserIdAndAttributeId
• getUserMissionByUserIdAndMissionId
• getUserQuizById
• getUserSegmentByUserIdAndSegmentId
• getUserStreakById
• getUserTierByUserIdAndAttributeId
• getUsersSchema
• grantUserAchievement
• grantUserBooster
• grantUserItem
• listMissionsForUser
• listSegmentsForUser
• listStreaksForUser
• listUserAchievements
• listUserActivity
• listUserAttributes
• listUserBoosters
• listUserConsumables
• listUserItems
• listUserQuizzes
• listUserStreakRewards
• listUsers
• removeUserAchievement
• removeUserFromSegment
• setUserLoginStatus
• setUserMissionCompleted
• setUserMissionEnrolled
• setUserMissionObjectiveCompleted
• setUserMissionUnlocked
• setUsersSchema
• startUserBooster
• startUserStreak
• submitQuestionAnswer
• updateUser
• updateUserAttribute
• useUserItem

addUserToSegment

This endpoint is used to adds a User to a Segment. Add a User to a Segment

| Method | Type | | ---------- | ---------- | | addUserToSegment | (userId: string, segmentId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericSetResponseDto> |

createUser

Create A User

| Method | Type | | ---------- | ---------- | | createUser | (userId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericSetResponseDto> |

deleteUser

This endpoint is used to delete a User. Delete a User

| Method | Type | | ---------- | ---------- | | deleteUser | (userId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

enrolUserInQuiz

This endpoint is used to enrol a User in a Quiz. Enrol a user in a quiz

| Method | Type | | ---------- | ---------- | | enrolUserInQuiz | (userId: string, quizId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericSetResponseDto> |

getUserAchievementById

Get a single User Achievement by their IDs

| Method | Type | | ---------- | ---------- | | getUserAchievementById | (userId: string, achievementId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetUserAchievementByIdResponseDto> |

getUserAttributeById

Get a single User Attribute by their IDs

| Method | Type | | ---------- | ---------- | | getUserAttributeById | (userId: string, attributeId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetUserAttributeResponseDto> |

getUserById

Get a single User specified by its ID

| Method | Type | | ---------- | ---------- | | getUserById | (userId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetUserByIdResponseDto> |

getUserLevelByUserIdAndAttributeId

Retrieve a User Level based on userId and attributeId

| Method | Type | | ---------- | ---------- | | getUserLevelByUserIdAndAttributeId | (userId: string, attributeId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetLevelByUserIdAndAttributeIdDto> |

getUserMissionByUserIdAndMissionId

Get a single User Mission by its ID including it's objectives

| Method | Type | | ---------- | ---------- | | getUserMissionByUserIdAndMissionId | (userId: string, missionId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetUserMissionByUserIdAndMissionIdResponseDto> |

getUserQuizById

Get a quiz assigned to a user

| Method | Type | | ---------- | ---------- | | getUserQuizById | (userId: string, quizId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetUserQuizByIdResponseDto> |

getUserSegmentByUserIdAndSegmentId

Check if a User is in a Segment

| Method | Type | | ---------- | ---------- | | getUserSegmentByUserIdAndSegmentId | (userId: string, segmentId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetUserSegmentByUserIdAndSegmentIdResponseDto> |

getUserStreakById

Get a single User Streak by its ID including it's milestones

| Method | Type | | ---------- | ---------- | | getUserStreakById | (userId: string, streakId: string, attemptNumber?: number or undefined, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

getUserTierByUserIdAndAttributeId

Retrieve a User Tier based on userId and attributeId

| Method | Type | | ---------- | ---------- | | getUserTierByUserIdAndAttributeId | (userId: string, attributeId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetTierByUserIdAndAttributeIdDto> |

getUsersSchema

This endpoint retrieves the current SchemaFields defined on the UsersSchema. Get the current UsersSchema

| Method | Type | | ---------- | ---------- | | getUsersSchema | (initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GetSchemaByIdResponseDto> |

grantUserAchievement

Grant an Achievement to a User by their IDs

| Method | Type | | ---------- | ---------- | | grantUserAchievement | (userId: string, achievementId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericSetResponseDto> |

grantUserBooster

This endpoint is used to grant a Booster to a User. Grant a Booster to a User

| Method | Type | | ---------- | ---------- | | grantUserBooster | (userId: string, grantUserBoosterCommand: GrantUserBoosterCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

grantUserItem

This endpoint is used to grant an Item to a User. Grant an Item to a User

| Method | Type | | ---------- | ---------- | | grantUserItem | (userId: string, grantUserItemCommand: GrantUserItemCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

listMissionsForUser

List the Missions a User is associated with

| Method | Type | | ---------- | ---------- | | listMissionsForUser | (userId: string, fields: string, sortOrder?: ListMissionsForUserSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, unlocked?: string[] or undefined, enrolled?: string[] or undefined, completed?: string[] or undefined, autoEnrol?: string[] |... |

listSegmentsForUser

List the Segments a User belongs to

| Method | Type | | ---------- | ---------- | | listSegmentsForUser | (userId: string, fields: string, sortOrder?: ListSegmentsForUserSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, initOverrides?: RequestInit or ... 1 more ... or undefined) => Promise<...> |

listStreaksForUser

List the Streaks a User is associated with

| Method | Type | | ---------- | ---------- | | listStreaksForUser | (userId: string, fields: string, sortOrder?: ListStreaksForUserSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, streakId?: string[] or undefined, status?: string[] or undefined, startedAt?: string[] or undefined, endedAt?: string[] or unde... |

listUserAchievements

List all Achievements for a User

| Method | Type | | ---------- | ---------- | | listUserAchievements | (userId: string, fields: string, sortOrder?: ListUserAchievementsSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, achievementId?: string[] or undefined, achievementFields?: string or undefined, achievementName?: string[] or undefined, ach... |

listUserActivity

List all Activity for a User

| Method | Type | | ---------- | ---------- | | listUserActivity | (userId: string, fields: string, sortOrder?: ListUserActivitySortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, eventId?: string[] or undefined, timestamp?: string[] or undefined, correlationId?: string[] or undefined, entityType?: string[]... |

listUserAttributes

List all Attributes for a User

| Method | Type | | ---------- | ---------- | | listUserAttributes | (userId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<ListUserAttributesResponseDto> |

listUserBoosters

This endpoint is used to query for multiple Boosters that a User owns. It supports the standard filtering and pagination syntax described in the API Overview. List Boosters that the User has obtained

| Method | Type | | ---------- | ---------- | | listUserBoosters | (userId: string, fields: string, sortOrder?: ListUserBoostersSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, boosterName?: string[] or undefined, boosterId?: string[] or undefined, isUsed?: string[] or undefined, initOverrides?: RequestI... |

listUserConsumables

This endpoint is used to query for multiple Consumables that a User owns. It supports the standard filtering and pagination syntax described in the API Overview. List Consumables that the User has obtained

| Method | Type | | ---------- | ---------- | | listUserConsumables | (userId: string, fields: string, sortOrder?: ListUserConsumablesSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, consumableId?: string[] or undefined, initOverrides?: RequestInit or ... 1 more ... or undefined) => Promise<...> |

listUserItems

This endpoint is used to query for multiple Items that a User owns. It supports the standard filtering and pagination syntax described in the API Overview. List Items that the User has obtained

| Method | Type | | ---------- | ---------- | | listUserItems | (userId: string, fields: string, sortOrder?: ListUserItemsSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, itemName?: string[] or undefined, itemId?: string[] or undefined, isUsed?: string[] or undefined, initOverrides?: RequestInit or ...... |

listUserQuizzes

Retrieve multiple Quizzes

| Method | Type | | ---------- | ---------- | | listUserQuizzes | (userId: string, fields: string, sortOrder?: ListUserQuizzesSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, quizId?: string[] or undefined, quizFields?: string or undefined, quizName?: string[] or undefined, questionsFields?: string or un... |

listUserStreakRewards

List the (achieved or potential) Milestone Rewards for a given User

| Method | Type | | ---------- | ---------- | | listUserStreakRewards | (userId: string, streakId: string, attemptNumber?: number or undefined, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

listUsers

Retrieve multiple Users

| Method | Type | | ---------- | ---------- | | listUsers | (fields: string, sortOrder?: ListUsersSortOrderEnum or undefined, sortBy?: string or undefined, paginationSkip?: number or undefined, paginationLimit?: number or undefined, id?: string[] or undefined, initOverrides?: RequestInit or ... 1 more ... or undefined) => Promise<...> |

removeUserAchievement

Remove an Achievement from a User by their IDs

| Method | Type | | ---------- | ---------- | | removeUserAchievement | (userId: string, achievementId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

removeUserFromSegment

This endpoint is used to remove a User from a Segment. Remove a User from a Segment

| Method | Type | | ---------- | ---------- | | removeUserFromSegment | (userId: string, segmentId: string, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<GenericDeleteResponseDto> |

setUserLoginStatus

This endpoint is used to set the login status of a User. Set a User's login status

| Method | Type | | ---------- | ---------- | | setUserLoginStatus | (userId: string, setUserLoginStatusCommand: SetUserLoginStatusCommand, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

setUserMissionCompleted

This endpoint is used to complete a Mission for a User. Complete a Mission for a User

| Method | Type | | ---------- | ---------- | | setUserMissionCompleted | (userId: string, missionId: string, setUserMissionCompletedBodyDto: SetUserMissionCompletedBodyDto, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

setUserMissionEnrolled

This endpoint is used to enrol or un-enrol a User in a Mission. Enrol or unenrol a User in a Mission

| Method | Type | | ---------- | ---------- | | setUserMissionEnrolled | (userId: string, missionId: string, setUserMissionEnrolledBodyDto: SetUserMissionEnrolledBodyDto, initOverrides?: RequestInit or InitOverrideFunction or undefined) => Promise<...> |

setUserMissionObjectiveCompleted

This endpoint is used to complete an Objective in a Mission for a User. Complete a Mission Objective for a User

| Method | Type | | ---------- | ---------- | | `setUserMi