knetikcloud-sdk

KnetikCloud - JavaScript client for knetikcloud-sdk
This is the spec for the Knetik API. Use this in conjunction with the documentation found at https://knetikcloud.com.
This SDK is automatically generated by the Swagger Codegen project:

- API version: latest
- Package version: 3.1.4
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
For more information, please visit http://www.knetik.com

Installation

$3

#### npm

To publish the library as a npm,
please follow the procedure in "Publishing npm packages".

Then install it via:

``shell
npm install knetikcloud-sdk --save
`

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

`shell
npm install
`

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

`shell
npm link
`

Finally, switch to the directory you want to use your knetikcloud-sdk from, and run:

`shell
npm link /path/to/
`

You should now be able to require('knetikcloud-sdk') in javascript files from the directory you ran the last
command above from.

#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:

`shell
npm install GIT_USER_ID/GIT_REPO_ID --save
`

$3

The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify,
perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually
use this library):

`shell
browserify main.js > bundle.js
`

Then include bundle.js in the HTML pages.

$3

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

`javascript
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
`

Getting Started

KnetikCloud (JSAPI) uses a strict Oauth 2.0 implementation with the following grant types:

* Password grant: Used for user authentication, usually from an unsecured web or mobile client when a fully authenticated user account is required to perform actions. ex:

`curl
POST /oauth/token?grant_type=password&client_id=web&username=jdoe&password=68a4sd3sd
`

* Client credentials grant:
Used for server authentication or secured clients when the secret key cannot be discovered. This kind of grant is typically used for administrative tasks on the application itself or to access other user's account information.

`curl
POST /oauth/token grant_type=client_credentials&client_id=server-client-id&client_secret=1s31dfas65d4f3sa651c3s54f
`

The endpoint will return a response containing the authentication token as follows:
`json:
{"access_token":"25a0659c-6f4a-40bd-950e-0ba4af7acf0f","token_type":"bearer","expires_in":2145660769,"scope":"write read"}
`

Use the provided access_token in sub-sequent requests to authenticate (see code below). Make sure you refresh your token before it expires to avoid having to re-authenticate.

Please follow the installation instruction and execute the following JS code:

`javascript
var KnetikCloud = require('knetikcloud-sdk');

var api = new KnetikCloud.AccessTokenApi()

var grantType = "client_credentials"; // {String} Grant type

var clientId = "knetik"; // {String} The id of the client

var opts = {
'clientSecret': "clientSecret_example", // {String} The secret key of the client. Used only with a grant_type of client_credentials
'username': "username_example", // {String} The username of the client. Used only with a grant_type of password
'password': "password_example", // {String} The password of the client. Used only with a grant_type of password
'token': "token_example", // {String} The 3rd party authentication token. Used only with a grant_type of facebook, google, etc (social plugins)
'refreshToken': "refreshToken_example" // {String} The refresh token obtained during prior authentication. Used only with a grant_type of refresh_token
};
api.getOAuthToken(grantType, clientId, opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});


``

Documentation for API Endpoints

All URIs are relative to https://devsandbox.knetikcloud.com

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
KnetikCloud.AccessTokenApi | getOAuthToken | POST /oauth/token | Get access token
KnetikCloud.ActivitiesApi | addUser | POST /activity-occurrences/{activity_occurrence_id}/users | Add a user to an occurrence
KnetikCloud.ActivitiesApi | createActivity | POST /activities | Create an activity
KnetikCloud.ActivitiesApi | createActivityOccurrence | POST /activity-occurrences | Create a new activity occurrence. Ex: start a game
KnetikCloud.ActivitiesApi | createActivityTemplate | POST /activities/templates | Create an activity template
KnetikCloud.ActivitiesApi | deleteActivity | DELETE /activities/{id} | Delete an activity
KnetikCloud.ActivitiesApi | deleteActivityTemplate | DELETE /activities/templates/{id} | Delete an activity template
KnetikCloud.ActivitiesApi | getActivities | GET /activities | List activity definitions
KnetikCloud.ActivitiesApi | getActivity | GET /activities/{id} | Get a single activity
KnetikCloud.ActivitiesApi | getActivityOccurrenceDetails | GET /activity-occurrences/{activity_occurrence_id} | Load a single activity occurrence details
KnetikCloud.ActivitiesApi | getActivityTemplate | GET /activities/templates/{id} | Get a single activity template
KnetikCloud.ActivitiesApi | getActivityTemplates | GET /activities/templates | List and search activity templates
KnetikCloud.ActivitiesApi | listActivityOccurrences | GET /activity-occurrences | List activity occurrences
KnetikCloud.ActivitiesApi | removeUser | DELETE /activity-occurrences/{activity_occurrence_id}/users/{user_id} | Remove a user from an occurrence
KnetikCloud.ActivitiesApi | setActivityOccurrenceResults | POST /activity-occurrences/{activity_occurrence_id}/results | Sets the status of an activity occurrence to FINISHED and logs metrics
KnetikCloud.ActivitiesApi | setActivityOccurrenceSettings | PUT /activity-occurrences/{activity_occurrence_id}/settings | Sets the settings of an activity occurrence
KnetikCloud.ActivitiesApi | setUserStatus | PUT /activity-occurrences/{activity_occurrence_id}/users/{user_id}/status | Set a user's status within an occurrence
KnetikCloud.ActivitiesApi | updateActivity | PUT /activities/{id} | Update an activity
KnetikCloud.ActivitiesApi | updateActivityOccurrenceStatus | PUT /activity-occurrences/{activity_occurrence_id}/status | Update the status of an activity occurrence
KnetikCloud.ActivitiesApi | updateActivityTemplate | PATCH /activities/templates/{id} | Update an activity template
KnetikCloud.AmazonWebServicesS3Api | getDownloadURL | GET /amazon/s3/download-url | Get a temporary signed S3 URL for download
KnetikCloud.AmazonWebServicesS3Api | getSignedS3URL | GET /amazon/s3/signed-post-url | Get a signed S3 URL for upload
KnetikCloud.AuthClientsApi | createClient | POST /auth/clients | Create a new client
KnetikCloud.AuthClientsApi | deleteClient | DELETE /auth/clients/{client_key} | Delete a client
KnetikCloud.AuthClientsApi | getClient | GET /auth/clients/{client_key} | Get a single client
KnetikCloud.AuthClientsApi | getClientGrantTypes | GET /auth/clients/grant-types | List available client grant types
KnetikCloud.AuthClientsApi | getClients | GET /auth/clients | List and search clients
KnetikCloud.AuthClientsApi | setClientGrantTypes | PUT /auth/clients/{client_key}/grant-types | Set grant types for a client
KnetikCloud.AuthClientsApi | setClientRedirectUris | PUT /auth/clients/{client_key}/redirect-uris | Set redirect uris for a client
KnetikCloud.AuthClientsApi | updateClient | PUT /auth/clients/{client_key} | Update a client
KnetikCloud.AuthPermissionsApi | createPermission | POST /auth/permissions | Create a new permission
KnetikCloud.AuthPermissionsApi | deletePermission | DELETE /auth/permissions/{permission} | Delete a permission
KnetikCloud.AuthPermissionsApi | getPermission | GET /auth/permissions/{permission} | Get a single permission
KnetikCloud.AuthPermissionsApi | getPermissions | GET /auth/permissions | List and search permissions
KnetikCloud.AuthPermissionsApi | updatePermission | PUT /auth/permissions/{permission} | Update a permission
KnetikCloud.AuthProvidersApi | createProvider | POST /auth/providers | Create a new OAuth 2 provider
KnetikCloud.AuthProvidersApi | deleteProvider | DELETE /auth/providers/{provider_id} | Delete an existing OAuth 2 provider
KnetikCloud.AuthProvidersApi | getProvider | GET /auth/providers/{provider_id} | Get an existing OAuth 2 provider
KnetikCloud.AuthProvidersApi | getProviders | GET /auth/providers | List OAuth 2 providers
KnetikCloud.AuthProvidersApi | updateProvider | PUT /auth/providers/{provider_id} | Update an existing OAuth 2 provider
KnetikCloud.AuthRolesApi | createRole | POST /auth/roles | Create a new role
KnetikCloud.AuthRolesApi | deleteRole | DELETE /auth/roles/{role} | Delete a role
KnetikCloud.AuthRolesApi | getClientRoles | GET /auth/clients/{client_key}/roles | Get roles for a client
KnetikCloud.AuthRolesApi | getRole | GET /auth/roles/{role} | Get a single role
KnetikCloud.AuthRolesApi | getRoles | GET /auth/roles | List and search roles
KnetikCloud.AuthRolesApi | getUserRoles | GET /auth/users/{user_id}/roles | Get roles for a user
KnetikCloud.AuthRolesApi | setClientRoles | PUT /auth/clients/{client_key}/roles | Set roles for a client
KnetikCloud.AuthRolesApi | setPermissionsForRole | PUT /auth/roles/{role}/permissions | Set permissions for a role
KnetikCloud.AuthRolesApi | setUserRoles | PUT /auth/users/{user_id}/roles | Set roles for a user
KnetikCloud.AuthRolesApi | updateRole | PUT /auth/roles/{role} | Update a role
KnetikCloud.AuthTokensApi | deleteTokens | DELETE /auth/tokens | Delete tokens by username, client id, or both
KnetikCloud.AuthTokensApi | getToken | GET /auth/tokens/{username}/{client_id} | Get a single token by username and client id
KnetikCloud.AuthTokensApi | getTokens | GET /auth/tokens | List usernames and client ids
KnetikCloud.AuthTypesApi | allowedResourceActions | GET /access/resources/{type}/{id}/actions | Get allowed action
KnetikCloud.AuthTypesApi | allowedTypeActions | GET /access/types/{type}/actions | Get allowed actions on a type
KnetikCloud.AuthTypesApi | createResource | POST /access/resources/{type} | Create or update resource
KnetikCloud.AuthTypesApi | createType | POST /access/types | Create a new type
KnetikCloud.AuthTypesApi | deleteAllOfType | DELETE /access/resources/{type} | Delete all resources of a type
KnetikCloud.AuthTypesApi | deleteResource | DELETE /access/resources/{type}/{id} | Delete a resource
KnetikCloud.AuthTypesApi | deleteType | DELETE /access/types/{type} | Delete a root type
KnetikCloud.AuthTypesApi | getResource | GET /access/resources/{type}/{id} | Get a single resource
KnetikCloud.AuthTypesApi | getResources | GET /access/resources/{type} | List and search resources
KnetikCloud.AuthTypesApi | getType | GET /access/types/{type} | Get a single root type
KnetikCloud.AuthTypesApi | getTypes | GET /access/types | List and search types
KnetikCloud.AuthTypesApi | updateResource | PUT /access/resources/{type}/{id} | Update a resource
KnetikCloud.AuthTypesApi | updateType | PUT /access/types/{type} | Update a root type
KnetikCloud.AuthUsersApi | addSid | POST /access/users/{user_id}/sids | Add a sid to a user
KnetikCloud.AuthUsersApi | getResources1 | GET /access/users/{user_id}/sids | List and search user sids
KnetikCloud.AuthUsersApi | getSid | GET /access/users/{user_id}/sids/{sid} | Get a user sid
KnetikCloud.AuthUsersApi | removeSid | DELETE /access/users/{user_id}/sids/{sid} | Remove a sid from a user
KnetikCloud.CampaignsApi | addChallengeToCampaign | POST /campaigns/{id}/challenges | Add a challenge to a campaign
KnetikCloud.CampaignsApi | createCampaign | POST /campaigns | Create a campaign
KnetikCloud.CampaignsApi | createCampaignTemplate | POST /campaigns/templates | Create a campaign template
KnetikCloud.CampaignsApi | deleteCampaign | DELETE /campaigns/{id} | Delete a campaign
KnetikCloud.CampaignsApi | deleteCampaignTemplate | DELETE /campaigns/templates/{id} | Delete a campaign template
KnetikCloud.CampaignsApi | getCampaign | GET /campaigns/{id} | Returns a single campaign
KnetikCloud.CampaignsApi | getCampaignChallenges | GET /campaigns/{id}/challenges | List the challenges associated with a campaign
KnetikCloud.CampaignsApi | getCampaignTemplate | GET /campaigns/templates/{id} | Get a single campaign template
KnetikCloud.CampaignsApi | getCampaignTemplates | GET /campaigns/templates | List and search campaign templates
KnetikCloud.CampaignsApi | getCampaigns | GET /campaigns | List and search campaigns
KnetikCloud.CampaignsApi | removeChallengeFromCampaign | DELETE /campaigns/{campaign_id}/challenges/{id} | Remove a challenge from a campaign
KnetikCloud.CampaignsApi | updateCampaign | PUT /campaigns/{id} | Update a campaign
KnetikCloud.CampaignsApi | updateCampaignTemplate | PATCH /campaigns/templates/{id} | Update an campaign template
KnetikCloud.CampaignsChallengesApi | createChallenge | POST /challenges | Create a challenge
KnetikCloud.CampaignsChallengesApi | createChallengeActivity | POST /challenges/{challenge_id}/activities | Create a challenge activity
KnetikCloud.CampaignsChallengesApi | createChallengeActivityTemplate | POST /challenge-activities/templates | Create a challenge activity template
KnetikCloud.CampaignsChallengesApi | createChallengeTemplate | POST /challenges/templates | Create a challenge template
KnetikCloud.CampaignsChallengesApi | deleteChallenge | DELETE /challenges/{id} | Delete a challenge
KnetikCloud.CampaignsChallengesApi | deleteChallengeActivity | DELETE /challenges/{challenge_id}/activities/{id} | Delete a challenge activity
KnetikCloud.CampaignsChallengesApi | deleteChallengeActivityTemplate | DELETE /challenge-activities/templates/{id} | Delete a challenge activity template
KnetikCloud.CampaignsChallengesApi | deleteChallengeEvent | DELETE /challenges/events/{id} | Delete a challenge event
KnetikCloud.CampaignsChallengesApi | deleteChallengeTemplate | DELETE /challenges/templates/{id} | Delete a challenge template
KnetikCloud.CampaignsChallengesApi | getChallenge | GET /challenges/{id} | Retrieve a challenge
KnetikCloud.CampaignsChallengesApi | getChallengeActivities | GET /challenges/{challenge_id}/activities | List and search challenge activities
KnetikCloud.CampaignsChallengesApi | getChallengeActivity | GET /challenges/{challenge_id}/activities/{id} | Get a single challenge activity
KnetikCloud.CampaignsChallengesApi | getChallengeActivityTemplate | GET /challenge-activities/templates/{id} | Get a single challenge activity template
KnetikCloud.CampaignsChallengesApi | getChallengeActivityTemplates | GET /challenge-activities/templates | List and search challenge activity templates
KnetikCloud.CampaignsChallengesApi | getChallengeEvent | GET /challenges/events/{id} | Retrieve a single challenge event details
KnetikCloud.CampaignsChallengesApi | getChallengeEvents | GET /challenges/events | Retrieve a list of challenge events
KnetikCloud.CampaignsChallengesApi | getChallengeTemplate | GET /challenges/templates/{id} | Get a single challenge template
KnetikCloud.CampaignsChallengesApi | getChallengeTemplates | GET /challenges/templates | List and search challenge templates
KnetikCloud.CampaignsChallengesApi | getChallenges | GET /challenges | Retrieve a list of challenges
KnetikCloud.CampaignsChallengesApi | updateChallenge | PUT /challenges/{id} | Update a challenge
KnetikCloud.CampaignsChallengesApi | updateChallengeActivity | PUT /challenges/{challenge_id}/activities/{id} | Update a challenge activity
KnetikCloud.CampaignsChallengesApi | updateChallengeActivityTemplate | PATCH /challenge-activities/templates/{id} | Update an challenge activity template
KnetikCloud.CampaignsChallengesApi | updateChallengeTemplate | PATCH /challenges/templates/{id} | Update a challenge template
KnetikCloud.CampaignsRewardsApi | createRewardSet | POST /rewards | Create a reward set
KnetikCloud.CampaignsRewardsApi | deleteRewardSet | DELETE /rewards/{id} | Delete a reward set
KnetikCloud.CampaignsRewardsApi | getRewardSet | GET /rewards/{id} | Get a single reward set
KnetikCloud.CampaignsRewardsApi | getRewardSets | GET /rewards | List and search reward sets
KnetikCloud.CampaignsRewardsApi | updateRewardSet | PUT /rewards/{id} | Update a reward set
KnetikCloud.CategoriesApi | createCategory | POST /categories | Create a new category
KnetikCloud.CategoriesApi | createCategoryTemplate | POST /categories/templates | Create a category template
KnetikCloud.CategoriesApi | deleteCategory | DELETE /categories/{id} | Delete an existing category
KnetikCloud.CategoriesApi | deleteCategoryTemplate | DELETE /categories/templates/{id} | Delete a category template
KnetikCloud.CategoriesApi | getCategories | GET /categories | List and search categories with optional filters
KnetikCloud.CategoriesApi | getCategory | GET /categories/{id} | Get a single category
KnetikCloud.CategoriesApi | getCategoryTemplate | GET /categories/templates/{id} | Get a single category template
KnetikCloud.CategoriesApi | getCategoryTemplates | GET /categories/templates | List and search category templates
KnetikCloud.CategoriesApi | getTags | GET /tags | List all trivia tags in the system
KnetikCloud.CategoriesApi | updateCategory | PUT /categories/{id} | Update an existing category
KnetikCloud.CategoriesApi | updateCategoryTemplate | PATCH /categories/templates/{id} | Update a category template
KnetikCloud.ChatApi | acknowledgeChatMessage | PUT /chat/threads/{id}/acknowledge | Acknowledge number of messages in a thread
KnetikCloud.ChatApi | addChatMessageBlacklist | POST /chat/users/{id}/blacklist/{blacklisted_user_id} | Add a user to a chat message blacklist
KnetikCloud.ChatApi | deleteChatMessage | DELETE /chat/messages/{id} | Delete a message
KnetikCloud.ChatApi | editChatMessage | PUT /chat/messages/{id} | Edit your message
KnetikCloud.ChatApi | getChatMessage | GET /chat/messages/{id} | Get a message
KnetikCloud.ChatApi | getChatMessageBlacklist | GET /chat/users/{id}/blacklist | Get a list of blocked users for chat messaging
KnetikCloud.ChatApi | getChatThreads | GET /chat/threads | List your threads
KnetikCloud.ChatApi | getDirectMessages | GET /chat/users/{id}/messages | List messages with a user
KnetikCloud.ChatApi | getThreadMessages | GET /chat/threads/{id}/messages | List messages in a thread
KnetikCloud.ChatApi | getTopicMessages | GET /chat/topics/{id}/messages | List messages in a topic
KnetikCloud.ChatApi | removeChatBlacklist | DELETE /chat/users/{id}/blacklist/{blacklisted_user_id} | Remove a user from a blacklist
KnetikCloud.ChatApi | sendChatMessage | POST /chat/messages | Send a message
KnetikCloud.ConfigsApi | createConfig | POST /configs | Create a new config
KnetikCloud.ConfigsApi | deleteConfig | DELETE /configs/{name} | Delete an existing config
KnetikCloud.ConfigsApi | getConfig | GET /configs/{name} | Get a single config
KnetikCloud.ConfigsApi | getConfigs | GET /configs | List and search configs
KnetikCloud.ConfigsApi | updateConfig | PUT /configs/{name} | Update an existing config
KnetikCloud.ContentArticlesApi | createArticle | POST /content/articles | Create a new article
KnetikCloud.ContentArticlesApi | createArticleTemplate | POST /content/articles/templates | Create an article template
KnetikCloud.ContentArticlesApi | deleteArticle | DELETE /content/articles/{id} | Delete an existing article
KnetikCloud.ContentArticlesApi | deleteArticleTemplate | DELETE /content/articles/templates/{id} | Delete an article template
KnetikCloud.ContentArticlesApi | getArticle | GET /content/articles/{id} | Get a single article
KnetikCloud.ContentArticlesApi | getArticleTemplate | GET /content/articles/templates/{id} | Get a single article template
KnetikCloud.ContentArticlesApi | getArticleTemplates | GET /content/articles/templates | List and search article templates
KnetikCloud.ContentArticlesApi | getArticles | GET /content/articles | List and search articles
KnetikCloud.ContentArticlesApi | updateArticle | PUT /content/articles/{id} | Update an existing article
KnetikCloud.ContentArticlesApi | updateArticleTemplate | PATCH /content/articles/templates/{id} | Update an article template
KnetikCloud.ContentCommentsApi | addComment | POST /comments | Add a new comment
KnetikCloud.ContentCommentsApi | deleteComment | DELETE /comments/{id} | Delete a comment
KnetikCloud.ContentCommentsApi | getComment | GET /comments/{id} | Return a comment
KnetikCloud.ContentCommentsApi | getComments | GET /comments | Returns a page of comments
KnetikCloud.ContentCommentsApi | updateComment | PUT /comments/{id}/content | Update a comment
KnetikCloud.CurrenciesApi | createCurrency | POST /currencies | Create a currency
KnetikCloud.CurrenciesApi | deleteCurrency | DELETE /currencies/{code} | Delete a currency
KnetikCloud.CurrenciesApi | getCurrencies | GET /currencies | List and search currencies
KnetikCloud.CurrenciesApi | getCurrency | GET /currencies/{code} | Get a single currency
KnetikCloud.CurrenciesApi | updateCurrency | PUT /currencies/{code} | Update a currency
KnetikCloud.DevicesApi | addDeviceUser | POST /devices/{id}/users | Add device users
KnetikCloud.DevicesApi | createDevice | POST /devices | Create a device
KnetikCloud.DevicesApi | createDeviceTemplate | POST /devices/templates | Create a device template
KnetikCloud.DevicesApi | deleteDevice | DELETE /devices/{id} | Delete a device
KnetikCloud.DevicesApi | deleteDeviceTemplate | DELETE /devices/templates/{id} | Delete an device template
KnetikCloud.DevicesApi | deleteDeviceUser | DELETE /devices/{id}/users/{user_id} | Delete a device user
KnetikCloud.DevicesApi | deleteDeviceUsers | DELETE /devices/{id}/users | Delete all device users
KnetikCloud.DevicesApi | getDevice | GET /devices/{id} | Get a single device
KnetikCloud.DevicesApi | getDeviceTemplate | GET /devices/templates/{id} | Get a single device template
KnetikCloud.DevicesApi | getDeviceTemplates | GET /devices/templates | List and search device templates
KnetikCloud.DevicesApi | getDevices | GET /devices | List and search devices
KnetikCloud.DevicesApi | updateDevice | PUT /devices/{id} | Update a device
KnetikCloud.DevicesApi | updateDeviceTemplate | PATCH /devices/templates/{id} | Update an device template
KnetikCloud.DispositionsApi | addDisposition | POST /dispositions | Add a new disposition
KnetikCloud.DispositionsApi | deleteDisposition | DELETE /dispositions/{id} | Delete a disposition
KnetikCloud.DispositionsApi | getDisposition | GET /dispositions/{id} | Returns a disposition
KnetikCloud.DispositionsApi | getDispositionCounts | GET /dispositions/count | Returns a list of disposition counts
KnetikCloud.DispositionsApi | getDispositions | GET /dispositions | Returns a page of dispositions
KnetikCloud.FulfillmentApi | createFulfillmentType | POST /store/fulfillment/types | Create a fulfillment type
KnetikCloud.FulfillmentApi | deleteFulfillmentType | DELETE /store/fulfillment/types/{id} | Delete a fulfillment type
KnetikCloud.FulfillmentApi | getFulfillmentType | GET /store/fulfillment/types/{id} | Get a single fulfillment type
KnetikCloud.FulfillmentApi | getFulfillmentTypes | GET /store/fulfillment/types | List and search fulfillment types
KnetikCloud.FulfillmentApi | updateFulfillmentType | PUT /store/fulfillment/types/{id} | Update a fulfillment type
KnetikCloud.GamificationAchievementsApi | createAchievement | POST /achievements | Create a new achievement definition
KnetikCloud.GamificationAchievementsApi | createAchievementTemplate | POST /achievements/templates | Create an achievement template
KnetikCloud.GamificationAchievementsApi | deleteAchievement | DELETE /achievements/{name} | Delete an achievement definition
KnetikCloud.GamificationAchievementsApi | deleteAchievementTemplate | DELETE /achievements/templates/{id} | Delete an achievement template
KnetikCloud.GamificationAchievementsApi | getAchievement | GET /achievements/{name} | Get a single achievement definition
KnetikCloud.GamificationAchievementsApi | getAchievementTemplate | GET /achievements/templates/{id} | Get a single achievement template
KnetikCloud.GamificationAchievementsApi | getAchievementTemplates | GET /achievements/templates | List and search achievement templates
KnetikCloud.GamificationAchievementsApi | getAchievementTriggers | GET /achievements/triggers | Get the list of triggers that can be used to trigger an achievement progress update
KnetikCloud.GamificationAchievementsApi | getAchievements | GET /achievements | Get all achievement definitions in the system
KnetikCloud.GamificationAchievementsApi | getDerivedAchievements | GET /achievements/derived/{name} | Get a list of derived achievements
KnetikCloud.GamificationAchievementsApi | getUserAchievementProgress | GET /users/{user_id}/achievements/{achievement_name} | Retrieve progress on a given achievement for a given user
KnetikCloud.GamificationAchievementsApi | getUserAchievementsProgress | GET /users/{user_id}/achievements | Retrieve progress on achievements for a given user
KnetikCloud.GamificationAchievementsApi | getUsersAchievementProgress | GET /users/achievements/{achievement_name} | Retrieve progress on a given achievement for all users
KnetikCloud.GamificationAchievementsApi | getUsersAchievementsProgress | GET /users/achievements | Retrieve progress on achievements for all users
KnetikCloud.GamificationAchievementsApi | incrementAchievementProgress | POST /users/{user_id}/achievements/{achievement_name}/progress | Increment an achievement progress record for a user
KnetikCloud.GamificationAchievementsApi | setAchievementProgress | PUT /users/{user_id}/achievements/{achievement_name}/progress | Set an achievement progress record for a user
KnetikCloud.GamificationAchievementsApi | updateAchievement | PUT /achievements/{name} | Update an achievement definition
KnetikCloud.GamificationAchievementsApi | updateAchievementTemplate | PATCH /achievements/templates/{id} | Update an achievement template
KnetikCloud.GamificationLeaderboardsApi | getLeaderboard | GET /leaderboards/{context_type}/{context_id} | Retrieves leaderboard details and paginated entries
KnetikCloud.GamificationLeaderboardsApi | getLeaderboardRank | GET /leaderboards/{context_type}/{context_id}/users/{id}/rank | Retrieves a specific user entry with rank
KnetikCloud.GamificationLeaderboardsApi | getLeaderboardStrategies | GET /leaderboards/strategies | Get a list of available leaderboard strategy names
KnetikCloud.GamificationLevelingApi | createLevel | POST /leveling | Create a level schema
KnetikCloud.GamificationLevelingApi | deleteLevel | DELETE /leveling/{name} | Delete a level
KnetikCloud.GamificationLevelingApi | getLevel | GET /leveling/{name} | Retrieve a level
KnetikCloud.GamificationLevelingApi | getLevelTriggers | GET /leveling/triggers | Get the list of triggers that can be used to trigger a leveling progress update
KnetikCloud.GamificationLevelingApi | getLevels | GET /leveling | List and search levels
KnetikCloud.GamificationLevelingApi | getUserLevel | GET /users/{user_id}/leveling/{name} | Get a user's progress for a given level schema
KnetikCloud.GamificationLevelingApi | getUserLevels | GET /users/{user_id}/leveling | Get a user's progress for all level schemas
KnetikCloud.GamificationLevelingApi | incrementProgress | POST /users/{user_id}/leveling/{name}/progress | Update or create a leveling progress record for a user
KnetikCloud.GamificationLevelingApi | setProgress | PUT /users/{user_id}/leveling/{name}/progress | Set leveling progress for a user
KnetikCloud.GamificationLevelingApi | updateLevel | PUT /leveling/{name} | Update a level
KnetikCloud.GamificationMetricsApi | addMetric | POST /metrics | Add a metric
KnetikCloud.GamificationTriviaApi | addQuestionAnswers | POST /trivia/questions/{question_id}/answers | Add an answer to a question
KnetikCloud.GamificationTriviaApi | addQuestionTag | POST /trivia/questions/{id}/tags | Add a tag to a question
KnetikCloud.GamificationTriviaApi | addTagToQuestionsBatch | POST /trivia/questions/tags | Add a tag to a batch of questions
KnetikCloud.GamificationTriviaApi | createImportJob | POST /trivia/import | Create an import job
KnetikCloud.GamificationTriviaApi | createQuestion | POST /trivia/questions | Create a question
KnetikCloud.GamificationTriviaApi | createQuestionTemplate | POST /trivia/questions/templates | Create a question template
KnetikCloud.GamificationTriviaApi | deleteImportJob | DELETE /trivia/import/{id} | Delete an import job
KnetikCloud.GamificationTriviaApi | deleteQuestion | DELETE /trivia/questions/{id} | Delete a question
KnetikCloud.GamificationTriviaApi | deleteQuestionAnswers | DELETE /trivia/questions/{question_id}/answers/{id} | Remove an answer from a question
KnetikCloud.GamificationTriviaApi | deleteQuestionTemplate | DELETE /trivia/questions/templates/{id} | Delete a question template
KnetikCloud.GamificationTriviaApi | getImportJob | GET /trivia/import/{id} | Get an import job
KnetikCloud.GamificationTriviaApi | getImportJobs | GET /trivia/import | Get a list of import job
KnetikCloud.GamificationTriviaApi | getQuestion | GET /trivia/questions/{id} | Get a single question
KnetikCloud.GamificationTriviaApi | getQuestionAnswer | GET /trivia/questions/{question_id}/answers/{id} | Get an answer for a question
KnetikCloud.GamificationTriviaApi | getQuestionAnswers | GET /trivia/questions/{question_id}/answers | List the answers available for a question
KnetikCloud.GamificationTriviaApi | getQuestionDeltas | GET /trivia/questions/delta | List question deltas in ascending order of updated date
KnetikCloud.GamificationTriviaApi | getQuestionTags | GET /trivia/questions/{id}/tags | List the tags for a question
KnetikCloud.GamificationTriviaApi | getQuestionTemplate | GET /trivia/questions/templates/{id} | Get a single question template
KnetikCloud.GamificationTriviaApi | getQuestionTemplates | GET /trivia/questions/templates | List and search question templates
KnetikCloud.GamificationTriviaApi | getQuestions | GET /trivia/questions | List and search questions
KnetikCloud.GamificationTriviaApi | getQuestionsCount | GET /trivia/questions/count | Count questions based on filters
KnetikCloud.GamificationTriviaApi | processImportJob | POST /trivia/import/{id}/process | Start processing an import job
KnetikCloud.GamificationTriviaApi | removeQuestionTag | DELETE /trivia/questions/{id}/tags/{tag} | Remove a tag from a question
KnetikCloud.GamificationTriviaApi | removeTagToQuestionsBatch | DELETE /trivia/questions/tags/{tag} | Remove a tag from a batch of questions
KnetikCloud.GamificationTriviaApi | searchQuestionTags | GET /trivia/tags | List and search tags by the beginning of the string
KnetikCloud.GamificationTriviaApi | updateImportJob | PUT /trivia/import/{id} | Update an import job
KnetikCloud.GamificationTriviaApi | updateQuestion | PUT /trivia/questions/{id} | Update a question
KnetikCloud.GamificationTriviaApi | updateQuestionAnswer | PUT /trivia/questions/{question_id}/answers/{id} | Update an answer for a question
KnetikCloud.GamificationTriviaApi | updateQuestionTemplate | PATCH /trivia/questions/templates/{id} | Update a question template
KnetikCloud.GamificationTriviaApi | updateQuestionsInBulk | PUT /trivia/questions | Bulk update questions
KnetikCloud.InvoicesApi | createInvoice | POST /invoices | Create an invoice
KnetikCloud.InvoicesApi | createInvoiceTemplate | POST /invoices/templates | Create a invoice template
KnetikCloud.InvoicesApi | deleteInvoiceTemplate | DELETE /invoices/templates/{id} | Delete a invoice template
KnetikCloud.InvoicesApi | getFulFillmentStatuses | GET /invoices/fulfillment-statuses | Lists available fulfillment statuses
KnetikCloud.InvoicesApi | getInvoice | GET /invoices/{id} | Retrieve an invoice
KnetikCloud.InvoicesApi | getInvoiceLogs | GET /invoices/{id}/logs | List invoice logs
KnetikCloud.InvoicesApi | getInvoiceTemplate | GET /invoices/templates/{id} | Get a single invoice template
KnetikCloud.InvoicesApi | getInvoiceTemplates | GET /invoices/templates | List and search invoice templates
KnetikCloud.InvoicesApi | getInvoices | GET /invoices | Retrieve invoices
KnetikCloud.InvoicesApi | getPaymentStatuses | GET /invoices/payment-statuses | Lists available payment statuses
KnetikCloud.InvoicesApi | payInvoice | POST /invoices/{id}/payments | Pay an invoice using a saved payment method
KnetikCloud.InvoicesApi | setAdditionalProperties | PUT /invoices/{id}/properties | Set the additional properties of an invoice
KnetikCloud.InvoicesApi | setBundledInvoiceItemFulfillmentStatus | PUT /invoices/{id}/items/{bundleSku}/bundled-skus/{sku}/fulfillment-status | Set the fulfillment status of a bundled invoice item
KnetikCloud.InvoicesApi | setExternalRef | PUT /invoices/{id}/external-ref | Set the external reference of an invoice
KnetikCloud.InvoicesApi | setInvoiceItemFulfillmentStatus | PUT /invoices/{id}/items/{sku}/fulfillment-status | Set the fulfillment status of an invoice item
KnetikCloud.InvoicesApi | setOrderNotes | PUT /invoices/{id}/order-notes | Set the order notes of an invoice
KnetikCloud.InvoicesApi | setPaymentStatus | PUT /invoices/{id}/payment-status | Set the payment status of an invoice
KnetikCloud.InvoicesApi | updateBillingInfo | PUT /invoices/{id}/billing-address | Set or update billing info
KnetikCloud.InvoicesApi | updateInvoiceTemplate | PATCH /invoices/templates/{id} | Update a invoice template
KnetikCloud.LevelingApi | createLevelingTemplate | POST /leveling/templates | Create a leveling template
KnetikCloud.LevelingApi | deleteLevelingTemplate | DELETE /leveling/templates/{id} | Delete a leveling template
KnetikCloud.LevelingApi | getLevelingTemplate | GET /leveling/templates/{id} | Get a single leveling template
KnetikCloud.LevelingApi | getLevelingTemplates | GET /leveling/templates | List and search leveling templates
KnetikCloud.LevelingApi | updateLevelingTemplate | PATCH /leveling/templates/{id} | Update a leveling template
KnetikCloud.LocationsApi | getCountries | GET /location/countries | Get a list of countries
KnetikCloud.LocationsApi | getCountryByGeoLocation | GET /location/geolocation/country | Get the iso3 code of your country
KnetikCloud.LocationsApi | getCountryStates | GET /location/countries/{country_code_iso3}/states | Get a list of a country's states
KnetikCloud.LocationsApi | getCurrencyByGeoLocation | GET /location/geolocation/currency | Get the currency information of your country
KnetikCloud.LogincontrollerApi | login | GET /login | login
KnetikCloud.LogsApi | getBREEventLog | GET /bre/logs/event-log/{id} | Get an existing BRE event log entry by id
KnetikCloud.LogsApi | getBREEventLogs | GET /bre/logs/event-log | Returns a list of BRE event log entries
KnetikCloud.LogsApi | getBREForwardLog | GET /bre/logs/forward-log/{id} | Get an existing forward log entry by id
KnetikCloud.LogsApi | getBREForwardLogs | GET /bre/logs/forward-log | Returns a list of forward log entries
KnetikCloud.LogsApi | getUserLogs | GET /audit/logs/{id} | Returns a user log entry by id
KnetikCloud.LogsApi | getUserLogs1 | GET /audit/logs | Returns a page of user logs entries
KnetikCloud.MediaArtistsApi | addArtist | POST /media/artists | Adds a new artist in the system
KnetikCloud.MediaArtistsApi | createArtistTemplate | POST /media/artists/templates | Create an artist template
KnetikCloud.MediaArtistsApi | deleteArtist | DELETE /media/artists/{id} | Removes an artist from the system IF no resources are attached to it
KnetikCloud.MediaArtistsApi | deleteArtistTemplate | DELETE /media/artists/templates/{id} | Delete an artist template
KnetikCloud.MediaArtistsApi | getArtist | GET /media/artists/{id} | Loads a specific artist details
KnetikCloud.MediaArtistsApi | getArtistTemplate | GET /media/artists/templates/{id} | Get a single artist template
KnetikCloud.MediaArtistsApi | getArtistTemplates | GET /media/artists/templates | List and search artist templates
KnetikCloud.MediaArtistsApi | getArtists | GET /media/artists | Search for artists
KnetikCloud.MediaArtistsApi | updateArtist | PUT /media/artists/{id} | Modifies an artist details
KnetikCloud.MediaArtistsApi | updateArtistTemplate | PATCH /media/artists/templates/{id} | Update an artist template
KnetikCloud.MediaModerationApi | addFlag | POST /moderation/flags | Add a flag
KnetikCloud.MediaModerationApi | deleteFlag | DELETE /moderation/flags | Delete a flag
KnetikCloud.MediaModerationApi | getFlags | GET /moderation/flags | Returns a page of flags
KnetikCloud.MediaModerationApi | getModerationReport | GET /moderation/reports/{id} | Get a flag report
KnetikCloud.MediaModerationApi | getModerationReports | GET /moderation/reports | Returns a page of flag reports
KnetikCloud.MediaModerationApi | updateModerationReport | PUT /moderation/reports/{id} | Update a flag report
KnetikCloud.MediaPollsApi | answerPoll | POST /media/polls/{id}/response | Add your vote to a poll
KnetikCloud.MediaPollsApi | createPoll | POST /media/polls | Create a new poll
KnetikCloud.MediaPollsApi | createPollTemplate | POST /media/polls/templates | Create a poll template
KnetikCloud.MediaPollsApi | deletePoll | DELETE /media/polls/{id} | Delete an existing poll
KnetikCloud.MediaPollsApi | deletePollTemplate | DELETE /media/polls/templates/{id} | Delete a poll template
KnetikCloud.MediaPollsApi | getPoll | GET /media/polls/{id} | Get a single poll
KnetikCloud.MediaPollsApi | getPollAnswer | GET /media/polls/{id}/response | Get poll answer
KnetikCloud.MediaPollsApi | getPollTemplate | GET /media/polls/templates/{id} | Get a single poll template
KnetikCloud.MediaPollsApi | getPollTemplates | GET /media/polls/templates | List and search poll templates
KnetikCloud.MediaPollsApi | getPolls | GET /media/polls | List and search polls
KnetikCloud.MediaPollsApi | updatePoll | PUT /media/polls/{id} | Update an existing poll
KnetikCloud.MediaPollsApi | updatePollTemplate | PATCH /media/polls/templates/{id} | Update a poll template
KnetikCloud.MediaVideosApi | addUserToVideoWhitelist | POST /media/videos/{id}/whitelist | Adds a user to a video's whitelist
KnetikCloud.MediaVideosApi | addVideo | POST /media/videos | Adds a new video in the system
KnetikCloud.MediaVideosApi | addVideoComment | POST /media/videos/{video_id}/comments | Add a new video comment
KnetikCloud.MediaVideosApi | addVideoContributor | POST /media/videos/{video_id}/contributors | Adds a contributor to a video
KnetikCloud.MediaVideosApi | addVideoFlag | POST /media/videos/{video_id}/moderation | Add a new flag
KnetikCloud.MediaVideosApi | addVideoRelationships | POST /media/videos/{video_id}/related | Adds one or more existing videos as related to this one
KnetikCloud.MediaVideosApi | createVideoDisposition | POST /media/videos/{video_id}/dispositions | Create a video disposition
KnetikCloud.MediaVideosApi | createVideoTemplate | POST /media/videos/templates | Create a video template
KnetikCloud.MediaVideosApi | deleteVideo | DELETE /media/videos/{id} | Deletes a video from the system if no resources are attached to it
KnetikCloud.MediaVideosApi | deleteVideoComment | DELETE /media/videos/{video_id}/comments/{id} | Delete a video comment
KnetikCloud.MediaVideosApi | deleteVideoDisposition | DELETE /media/videos/{video_id}/dispositions/{disposition_id} | Delete a video disposition
KnetikCloud.MediaVideosApi | deleteVideoFlag | DELETE /media/videos/{video_id}/moderation | Delete a flag
KnetikCloud.MediaVideosApi | deleteVideoRelationship | DELETE /media/videos/{video_id}/related/{id} | Delete a video's relationship
KnetikCloud.MediaVideosApi | deleteVideoTemplate | DELETE /media/videos/templates/{id} | Delete a video template
KnetikCloud.MediaVideosApi | getUserVideos | GET /users/{user_id}/videos | Get user videos
KnetikCloud.MediaVideosApi | getVideo | GET /media/videos/{id} | Loads a specific video details
KnetikCloud.MediaVideosApi | getVideoComments | GET /media/videos/{video_id}/comments | Returns a page of comments for a video
KnetikCloud.MediaVideosApi | getVideoDispositions | GET /media/videos/{video_id}/dispositions | Returns a page of dispositions for a video
KnetikCloud.MediaVideosApi | getVideoRelationships | GET /media/videos/{video_id}/related | Returns a page of video relationships
KnetikCloud.MediaVideosApi | getVideoTemplate | GET /media/videos/templates/{id} | Get a single video template
KnetikCloud.MediaVideosApi | getVideoTemplates | GET /media/videos/templates | List and search video templates
KnetikCloud.MediaVideosApi | getVideos | GET /media/videos | Search videos using the documented filters
KnetikCloud.MediaVideosApi | removeUserFromVideoWhitelist | DELETE /media/videos/{video_id}/whitelist/{id} | Removes a user from a video's whitelist
KnetikCloud.MediaVideosApi | removeVideoContributor | DELETE /media/videos/{video_id}/contributors/{id} | Removes a contributor from a video
KnetikCloud.MediaVideosApi | updateVideo | PUT /media/videos/{id} | Modifies a video's details
KnetikCloud.MediaVideosApi | updateVideoComment | PUT /media/videos/{video_id}/comments/{id}/content | Update a video comment
KnetikCloud.MediaVideosApi | updateVideoRelationship | PUT /media/videos/{video_id}/related/{id}/relationship_details | Update a video's relationship details
KnetikCloud.MediaVideosApi | updateVideoTemplate | PATCH /media/videos/templates/{id} | Update a video template
KnetikCloud.MediaVideosApi | viewVideo | POST /media/videos/{id}/views | Increment a video's view count
KnetikCloud.MessagingApi | compileMessageTemplates | POST /messaging/templates/compilations | Compile a message template
KnetikCloud.MessagingApi | createMessageTemplate | POST /messaging/templates | Create a message template
KnetikCloud.MessagingApi | deleteMessageTemplate | DELETE /messaging/templates/{id} | Delete an existing message template
KnetikCloud.MessagingApi | getMessageTemplate | GET /messaging/templates/{id} | Get a single message template
KnetikCloud.MessagingApi | getMessageTemplates | GET /messaging/templates | List and search message templates
KnetikCloud.MessagingApi | sendMessage | POST /messaging/message | Send a message
KnetikCloud.MessagingApi | sendRawEmail | POST /messaging/raw-email | Send a raw email to one or more users
KnetikCloud.MessagingApi | sendRawPush | POST /messaging/raw-push | Send a raw push notification
KnetikCloud.MessagingApi | sendRawSMS | POST /messaging/raw-sms | Send a raw SMS
KnetikCloud.MessagingApi | sendTemplatedEmail | POST /messaging/templated-email | Send a templated email to one or more users
KnetikCloud.MessagingApi | sendTemplatedPush | POST /messaging/templated-push | Send a templated push notification
KnetikCloud.MessagingApi | sendTemplatedSMS | POST /messaging/templated-sms | Send a new templated SMS
KnetikCloud.MessagingApi | sendWebsocket | POST /messaging/websocket-message | Send a websocket message
KnetikCloud.MessagingApi | updateMessageTemplate | PUT /messaging/templates/{id} | Update an existing message template
KnetikCloud.MessagingTopicsApi | disableTopicSubscriber | PUT /messaging/topics/{id}/subscribers/{user_id}/disabled | Enable or disable messages for a user
KnetikCloud.MessagingTopicsApi | getTopicSubscriber | GET /messaging/topics/{id}/subscribers/{user_id} | Get a subscriber to a topic
KnetikCloud.MessagingTopicsApi | getUserTopics | GET /users/{id}/topics | Get all messaging topics for a given user
KnetikCloud.MonitoringApi | createAlert | POST /monitoring/alerts | Create a new alert
KnetikCloud.MonitoringApi | createMetric | POST /monitoring/metrics | Create a new metric
KnetikCloud.MonitoringApi | deleteAlert | DELETE /monitoring/alerts/{id} | Delete an existing alert
KnetikCloud.MonitoringApi | deleteDatapoint | DELETE /monitoring/metrics/{id}/datapoints | Delete a metric datapoint
KnetikCloud.MonitoringApi | deleteIncident | DELETE /monitoring/incidents/{id} | End an existing incident
KnetikCloud.MonitoringApi | deleteMetric | DELETE /monitoring/metrics/{id} | Delete an existing metric
KnetikCloud.MonitoringApi | getAlert | GET /monitoring/alerts/{id} | Get a single alert
KnetikCloud.MonitoringApi | getAlerts | GET /monitoring/alerts | List and search alerts
KnetikCloud.MonitoringApi | getIncident | GET /monitoring/incidents/{id} | Get a single incident
KnetikCloud.MonitoringApi | getIncidentEvents | GET /monitoring/incidents/{id}/events | Get the events of an incident
KnetikCloud.MonitoringApi | getIncidents | GET /monitoring/incidents | List and search incidents
KnetikCloud.MonitoringApi | [getMetric](docs/MonitoringApi.md#getMetric