npm.io
3.1.4 • Published 6 years ago

@knetik/knetikcloud-sdk

Licence
Unlicense
Version
3.1.4
Deps
1
Size
7.6 MB
Vulns
1
Weekly
0

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

For Node.js

npm

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

Then install it via:

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:

npm install

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

npm link

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

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

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

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

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:

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:
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.
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:

{"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:

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 GET /monitoring/metrics/{id} Get a single metric
KnetikCloud.MonitoringApi getMetrics GET /monitoring/metrics List and search metrics
KnetikCloud.MonitoringApi postBatch POST /monitoring/metrics/datapoints Post a metric datapoint batch
KnetikCloud.MonitoringApi postDatapoint POST /monitoring/metrics/{id}/datapoints Post a metric datapoint
KnetikCloud.MonitoringApi receiveEvent POST /monitoring/incidents Report an incident event
KnetikCloud.MonitoringApi updateAlert PUT /monitoring/alerts/{id} Update an existing alert
KnetikCloud.MonitoringApi updateMetric PUT /monitoring/metrics/{id} Update an existing metric
KnetikCloud.NotificationsApi createNotificationType POST /notifications/types Create a notification type
KnetikCloud.NotificationsApi deleteNotificationType DELETE /notifications/types/{id} Delete a notification type
KnetikCloud.NotificationsApi getNotificationType GET /notifications/types/{id} Get a single notification type
KnetikCloud.NotificationsApi getNotificationTypes GET /notifications/types List and search notification types
KnetikCloud.NotificationsApi getUserNotificationInfo GET /users/{user_id}/notifications/types/{type_id} View a user's notification settings for a type
KnetikCloud.NotificationsApi getUserNotificationInfoList GET /users/{user_id}/notifications/types View a user's notification settings
KnetikCloud.NotificationsApi getUserNotifications GET /users/{id}/notifications Get notifications
KnetikCloud.NotificationsApi sendNotification POST /notifications Send a notification
KnetikCloud.NotificationsApi setUserNotificationStatus PUT /users/{user_id}/notifications/{notification_id}/status Set notification status
KnetikCloud.NotificationsApi silenceDirectNotifications PUT /users/{user_id}/notifications/types/{type_id}/silenced Enable or disable direct notifications for a user
KnetikCloud.NotificationsApi updateNotificationType PUT /notifications/types/{id} Update a notificationType
KnetikCloud.ObjectsApi createObjectItem POST /objects/{template_id} Create an object
KnetikCloud.ObjectsApi createObjectTemplate POST /objects/templates Create an object template
KnetikCloud.ObjectsApi deleteObjectItem DELETE /objects/{template_id}/{object_id} Delete an object
KnetikCloud.ObjectsApi deleteObjectTemplate DELETE /objects/templates/{id} Delete an entitlement template
KnetikCloud.ObjectsApi getObjectItem GET /objects/{template_id}/{object_id} Get a single object
KnetikCloud.ObjectsApi getObjectItems GET /objects/{template_id} List and search objects
KnetikCloud.ObjectsApi getObjectTemplate GET /objects/templates/{id} Get a single entitlement template
KnetikCloud.ObjectsApi getObjectTemplates GET /objects/templates List and search entitlement templates
KnetikCloud.ObjectsApi updateObjectItem PUT /objects/{template_id}/{object_id} Update an object
KnetikCloud.ObjectsApi updateObjectTemplate PATCH /objects/templates/{id} Update an entitlement template
KnetikCloud.PaymentsApi createPaymentMethod POST /users/{user_id}/payment-methods Create a new payment method for a user
KnetikCloud.PaymentsApi deletePaymentMethod DELETE /users/{user_id}/payment-methods/{id} Delete an existing payment method for a user
KnetikCloud.PaymentsApi getPaymentMethod GET /users/{user_id}/payment-methods/{id} Get a single payment method for a user
KnetikCloud.PaymentsApi getPaymentMethodType GET /payment/types/{id} Get a single payment method type
KnetikCloud.PaymentsApi getPaymentMethodTypes GET /payment/types Get all payment method types
KnetikCloud.PaymentsApi getPaymentMethods GET /users/{user_id}/payment-methods Get all payment methods for a user
KnetikCloud.PaymentsApi paymentAuthorization POST /payment/authorizations Authorize payment of an invoice for later capture
KnetikCloud.PaymentsApi paymentCapture POST /payment/authorizations/{id}/capture Capture an existing invoice payment authorization
KnetikCloud.PaymentsApi updatePaymentMethod PUT /users/{user_id}/payment-methods/{id} Update an existing payment method for a user
KnetikCloud.PaymentsAppleApi verifyAppleReceipt POST /payment/provider/apple/receipt Pay invoice with Apple receipt
KnetikCloud.PaymentsFattMerchantApi createOrUpdateFattMerchantPaymentMethod PUT /payment/provider/fattmerchant/payment-methods Create or update a FattMerchant payment method for a user
KnetikCloud.PaymentsOptimalApi silentPostOptimal POST /payment/provider/optimal/silent Initiate silent post with Optimal
KnetikCloud.PaymentsPayPalClassicApi createPayPalBillingAgreementUrl POST /payment/provider/paypal/classic/agreements/start Create a PayPal Classic billing agreement for the user
KnetikCloud.PaymentsPayPalClassicApi createPayPalExpressCheckout POST /payment/provider/paypal/classic/checkout/start Create a payment token for PayPal express checkout
KnetikCloud.PaymentsPayPalClassicApi finalizePayPalBillingAgreement POST /payment/provider/paypal/classic/agreements/finish Finalizes a billing agreement after the user has accepted through PayPal
KnetikCloud.PaymentsPayPalClassicApi finalizePayPalCheckout POST /payment/provider/paypal/classic/checkout/finish Finalizes a payment after the user has completed checkout with PayPal
KnetikCloud.PaymentsStripeApi createStripePaymentMethod POST /payment/provider/stripe/payment-methods Create a Stripe payment method for a user
KnetikCloud.PaymentsStripeApi payStripeInvoice POST /payment/provider/stripe/payments Pay with a single use token
KnetikCloud.PaymentsTransactionsApi getTransaction GET /transactions/{id} Get the details for a single transaction
KnetikCloud.PaymentsTransactionsApi getTransactions GET /transactions List and search transactions
KnetikCloud.PaymentsTransactionsApi refundTransaction POST /transactions/{id}/refunds Refund a payment transaction, in full or in part
KnetikCloud.PaymentsWalletsApi getUserWallet GET /users/{user_id}/wallets/{currency_code} Returns the user's wallet for the given currency code
KnetikCloud.PaymentsWalletsApi getUserWalletTransactions GET /users/{user_id}/wallets/{currency_code}/transactions Retrieve a user's wallet transactions
KnetikCloud.PaymentsWalletsApi getUserWallets GET /users/{user_id}/wallets List all of a user's wallets
KnetikCloud.PaymentsWalletsApi getWalletBalances GET /wallets/totals Retrieves a summation of wallet balances by currency code
KnetikCloud.PaymentsWalletsApi getWalletTransactions GET /wallets/transactions Retrieve wallet transactions across the system
KnetikCloud.PaymentsWalletsApi getWallets GET /wallets Retrieve a list of wallets across the system
KnetikCloud.PaymentsWalletsApi updateWalletBalance PUT /users/{user_id}/wallets/{currency_code}/balance Updates the balance for a user's wallet
KnetikCloud.PaymentsXsollaApi createXsollaTokenUrl POST /payment/provider/xsolla/payment Create a payment token that should be used to forward the user to Xsolla so they can complete payment
KnetikCloud.ReportingChallengesApi getChallengeEventLeaderboard GET /reporting/events/leaderboard Retrieve a challenge event leaderboard details
KnetikCloud.ReportingChallengesApi getChallengeEventParticipants GET /reporting/events/participants Retrieve a challenge event participant details
KnetikCloud.ReportingOrdersApi getInvoiceReports GET /reporting/orders/count/{currency_code} Retrieve invoice counts aggregated by time ranges
KnetikCloud.ReportingRevenueApi getItemRevenue GET /reporting/revenue/item-sales/{currency_code} Get item revenue info
KnetikCloud.ReportingRevenueApi getRefundRevenue GET /reporting/revenue/refunds/{currency_code} Get refund revenue info
KnetikCloud.ReportingRevenueApi getRevenueByCountry GET /reporting/revenue/countries/{currency_code} Get revenue info by country
KnetikCloud.ReportingRevenueApi getRevenueByItem GET /reporting/revenue/products/{currency_code} Get revenue info by item
KnetikCloud.ReportingRevenueApi getSubscriptionRevenue GET /reporting/revenue/subscription-sales/{currency_code} Get subscription revenue info
KnetikCloud.ReportingSubscriptionsApi getSubscriptionReports GET /reporting/subscription Get a list of available subscription reports in most recent first order
KnetikCloud.ReportingUsageApi getUsageByDay GET /reporting/usage/day Returns aggregated endpoint usage information by day
KnetikCloud.ReportingUsageApi getUsageByHour GET /reporting/usage/hour Returns aggregated endpoint usage information by hour
KnetikCloud.ReportingUsageApi getUsageByMinute GET /reporting/usage/minute Returns aggregated endpoint usage information by minute
KnetikCloud.ReportingUsageApi getUsageByMonth GET /reporting/usage/month Returns aggregated endpoint usage information by month
KnetikCloud.ReportingUsageApi getUsageByYear GET /reporting/usage/year Returns aggregated endpoint usage information by year
KnetikCloud.ReportingUsageApi getUsageEndpoints GET /reporting/usage/endpoints Returns list of endpoints called (method and url)
KnetikCloud.ReportingUsersApi getUserRegistrations GET /reporting/users/registrations Get user registration info
KnetikCloud.RuleEngineActionsApi getBREActions GET /bre/actions Get a list of available actions
KnetikCloud.RuleEngineEventsApi sendBREEvent POST /bre/events Fire a new event, based on an existing trigger
KnetikCloud.RuleEngineExpressionsApi getBREExpression GET /bre/expressions/{type} Lookup a specific expression
KnetikCloud.RuleEngineExpressionsApi getBREExpressions GET /bre/expressions Get a list of supported expressions to use in conditions or actions.
KnetikCloud.RuleEngineExpressionsApi getExpressionAsText POST /bre/expressions Returns the textual representation of an expression
KnetikCloud.RuleEngineGlobalsApi createBREGlobal POST /bre/globals/definitions Create a global definition
KnetikCloud.RuleEngineGlobalsApi deleteBREGlobal DELETE /bre/globals/definitions/{id} Delete a global
KnetikCloud.RuleEngineGlobalsApi getBREGlobal GET /bre/globals/definitions/{id} Get a single global definition
KnetikCloud.RuleEngineGlobalsApi getBREGlobals GET /bre/globals/definitions List global definitions
KnetikCloud.RuleEngineGlobalsApi updateBREGlobal PUT /bre/globals/definitions/{id} Update a global definition
KnetikCloud.RuleEngineRulesApi createBRERule POST /bre/rules Create a rule
KnetikCloud.RuleEngineRulesApi deleteBRERule DELETE /bre/rules/{id} Delete a rule
KnetikCloud.RuleEngineRulesApi getBREExpressionAsString POST /bre/rules/expression-as-string Returns a string representation of the provided expression
KnetikCloud.RuleEngineRulesApi getBRERule GET /bre/rules/{id} Get a single rule
KnetikCloud.RuleEngineRulesApi getBRERules GET /bre/rules List rules
KnetikCloud.RuleEngineRulesApi setBRERule PUT /bre/rules/{id}/enabled Enable or disable a rule
KnetikCloud.RuleEngineRulesApi updateBRERule PUT /bre/rules/{id} Update a rule
KnetikCloud.RuleEngineTriggersApi createBRETrigger POST /bre/triggers Create a trigger
KnetikCloud.RuleEngineTriggersApi deleteBRETrigger DELETE /bre/triggers/{event_name} Delete a trigger
KnetikCloud.RuleEngineTriggersApi getBRETrigger GET /bre/triggers/{event_name} Get a single trigger
KnetikCloud.RuleEngineTriggersApi getBRETriggers GET /bre/triggers List triggers
KnetikCloud.RuleEngineTriggersApi updateBRETrigger PUT /bre/triggers/{event_name} Update a trigger
KnetikCloud.RuleEngineVariablesApi getBREVariableTypes GET /bre/variable-types Get a list of variable types available
KnetikCloud.RuleEngineVariablesApi getBREVariableValues GET /bre/variable-types/{name}/values List valid values for a type
KnetikCloud.SearchApi indexDocument POST /search/documents Adds a document to be indexed. For system use only.
KnetikCloud.SearchApi reindexAll POST /search/reindex Triggers a full re-indexing of all documents of the specified type. For system use only.
KnetikCloud.SearchApi removeDocument DELETE /search/documents Remove a document from the index. For system use only.
KnetikCloud.SearchApi searchCountGET GET /search/count/{type} Count matches with no template
KnetikCloud.SearchApi searchCountPOST POST /search/count/{type} Count matches with no template
KnetikCloud.SearchApi searchDocumentGET GET /search/documents/{type}/{id} Get document with no template
KnetikCloud.SearchApi searchExplainGET GET /search/explain/{type}/{id} Explain matches with no template
KnetikCloud.SearchApi searchExplainPOST POST /search/explain/{type}/{id} Explain matches with no template
KnetikCloud.SearchApi searchIndex POST /search/index/{type} Search an index with no template
KnetikCloud.SearchApi searchIndexGET GET /search/index/{type} Search an index with no template
KnetikCloud.SearchApi searchIndicesGET GET /search/indices Get indices
KnetikCloud.SearchApi searchMappingsGET GET /search/mappings/{type} Get mapping with no template
KnetikCloud.SearchApi searchPublicIndex POST /search/public/{type} Search public index with no template
KnetikCloud.SearchApi searchValidateGET GET /search/validate/{type} Validate matches with no template
KnetikCloud.SearchApi searchValidatePOST POST /search/validate/{type} Validate matches with no template
KnetikCloud.SocialFacebookApi linkAccounts POST /social/facebook/users Link facebook account
KnetikCloud.SocialGoogleApi linkAccounts1 POST /social/google/users Link google account
KnetikCloud.StoreApi createItemTemplate POST /store/items/templates Create an item template
KnetikCloud.StoreApi createStoreItem POST /store/items Create a store item
KnetikCloud.StoreApi deleteItemTemplate DELETE /store/items/templates/{id} Delete an item template
KnetikCloud.StoreApi deleteStoreItem DELETE /store/items/{id} Delete a store item
KnetikCloud.StoreApi getBehaviors GET /store/items/behaviors List available item behaviors
KnetikCloud.StoreApi getItemTemplate GET /store/items/templates/{id} Get a single item template
KnetikCloud.StoreApi getItemTemplates GET /store/items/templates List and search item templates
KnetikCloud.StoreApi getStoreItem GET /store/items/{id} Get a single store item
KnetikCloud.StoreApi getStoreItems GET /store/items List and search store items
KnetikCloud.StoreApi quickBuy POST /store/quick-buy One-step purchase and pay for a single SKU item from a user's wallet
KnetikCloud.StoreApi quickNew POST /store/quick-new One-step invoice creation
KnetikCloud.StoreApi quickPaid POST /store/quick-paid One-step purchase when already paid
KnetikCloud.StoreApi quickProcessing POST /store/quick-processing One-step invoice creation when already processing
KnetikCloud.StoreApi updateItemTemplate PATCH /store/items/templates/{id} Update an item template
KnetikCloud.StoreApi updateStoreItem PUT /store/items/{id} Update a store item
KnetikCloud.StoreBundlesApi createBundleItem POST /store/bundles Create a bundle item
KnetikCloud.StoreBundlesApi createBundleTemplate POST /store/bundles/templates Create a bundle template
KnetikCloud.StoreBundlesApi deleteBundleItem DELETE /store/bundles/{id} Delete a bundle item
KnetikCloud.StoreBundlesApi deleteBundleTemplate DELETE /store/bundles/templates/{id} Delete a bundle template
KnetikCloud.StoreBundlesApi getBundleItem GET /store/bundles/{id} Get a single bundle item
KnetikCloud.StoreBundlesApi getBundleTemplate GET /store/bundles/templates/{id} Get a single bundle template
KnetikCloud.StoreBundlesApi getBundleTemplates GET /store/bundles/templates List and search bundle templates
KnetikCloud.StoreBundlesApi updateBundleItem PUT /store/bundles/{id} Update a bundle item
KnetikCloud.StoreBundlesApi updateBundleTemplate PATCH /store/bundles/templates/{id} Update a bundle template
KnetikCloud.StoreCouponsApi createCouponItem POST /store/coupons Create a coupon item
KnetikCloud.StoreCouponsApi createCouponTemplate POST /store/coupons/templates Create a coupon template
KnetikCloud.StoreCouponsApi deleteCouponItem DELETE /store/coupons/{id} Delete a coupon item
KnetikCloud.StoreCouponsApi deleteCouponTemplate DELETE /store/coupons/templates/{id} Delete a coupon template
KnetikCloud.StoreCouponsApi getCouponItem GET /store/coupons/{id} Get a single coupon item
KnetikCloud.StoreCouponsApi getCouponItemBySku GET /store/coupons/skus/{sku} Get a coupon by sku
KnetikCloud.StoreCouponsApi getCouponTemplate GET /store/coupons/templates/{id} Get a single coupon template
KnetikCloud.StoreCouponsApi getCouponTemplates GET /store/coupons/templates List and search coupon templates
KnetikCloud.StoreCouponsApi updateCouponItem PUT /store/coupons/{id} Update a coupon item
KnetikCloud.StoreCouponsApi updateCouponTemplate PATCH /store/coupons/templates/{id} Update a coupon template
KnetikCloud.StoreSalesApi createCatalogSale POST /store/sales Create a sale
KnetikCloud.StoreSalesApi deleteCatalogSale DELETE /store/sales/{id} Delete a sale
KnetikCloud.StoreSalesApi getCatalogSale GET /store/sales/{id} Get a single sale
KnetikCloud.StoreSalesApi getCatalogSales GET /store/sales List and search sales
KnetikCloud.StoreSalesApi updateCatalogSale PUT /store/sales/{id} Update a sale
KnetikCloud.StoreShippingApi createShippingItem POST /store/shipping Create a shipping item
KnetikCloud.StoreShippingApi createShippingTemplate POST /store/shipping/templates Create a shipping template
KnetikCloud.StoreShippingApi deleteShippingItem DELETE /store/shipping/{id} Delete a shipping item
KnetikCloud.StoreShippingApi deleteShippingTemplate DELETE /store/shipping/templates/{id} Delete a shipping template
KnetikCloud.StoreShippingApi getShippingItem GET /store/shipping/{id} Get a single shipping item
KnetikCloud.StoreShippingApi getShippingTemplate GET /store/shipping/templates/{id} Get a single shipping template
KnetikCloud.StoreShippingApi getShippingTemplates GET /store/shipping/templates List and search shipping templates
KnetikCloud.StoreShippingApi updateShippingItem PUT /store/shipping/{id} Update a shipping item
KnetikCloud.StoreShippingApi updateShippingTemplate PATCH /store/shipping/templates/{id} Update a shipping template
KnetikCloud.StoreShoppingCartsApi addCustomDiscount POST /carts/{id}/custom-discounts Adds a custom discount to the cart
KnetikCloud.StoreShoppingCartsApi addDiscountToCart POST /carts/{id}/discounts Adds a discount coupon to the cart
KnetikCloud.StoreShoppingCartsApi addItemToCart POST /carts/{id}/items Add an item to the cart
KnetikCloud.StoreShoppingCartsApi createCart POST /carts Create a cart
KnetikCloud.StoreShoppingCartsApi getCart GET /carts/{id} Returns the cart with the given GUID
KnetikCloud.StoreShoppingCartsApi getCarts GET /carts Get a list of carts
KnetikCloud.StoreShoppingCartsApi getShippable GET /carts/{id}/shippable Returns whether a cart requires shipping
KnetikCloud.StoreShoppingCartsApi getShippingCountries GET /carts/{id}/countries Get the list of available shipping countries per vendor
KnetikCloud.StoreShoppingCartsApi removeDiscountFromCart DELETE /carts/{id}/discounts/{code} Removes a discount coupon from the cart
KnetikCloud.StoreShoppingCartsApi setCartCurrency PUT /carts/{id}/currency Sets the currency to use for the cart
KnetikCloud.StoreShoppingCartsApi setCartOwner PUT /carts/{id}/owner Sets the owner of a cart if none is set already
KnetikCloud.StoreShoppingCartsApi updateItemInCart PUT /carts/{id}/items Changes the quantity of an item already in the cart
KnetikCloud.StoreShoppingCartsApi updateShippingAddress PUT /carts/{id}/shipping-address Modifies or sets the order shipping address
KnetikCloud.StoreSubscriptionsApi createSubscription POST /subscriptions Creates a subscription item and associated plans
KnetikCloud.StoreSubscriptionsApi createSubscriptionTemplate POST /subscriptions/templates Create a subscription template
KnetikCloud.StoreSubscriptionsApi deleteSubscription DELETE /subscriptions/{id}/plans/{plan_id} Delete a subscription plan
KnetikCloud.StoreSubscriptionsApi deleteSubscriptionTemplate DELETE /subscriptions/templates/{id} Delete a subscription template
KnetikCloud.StoreSubscriptionsApi getSubscription GET /subscriptions/{id} Retrieve a single subscription item and associated plans
KnetikCloud.StoreSubscriptionsApi getSubscriptionTemplate GET /subscriptions/templates/{id} Get a single subscription template
KnetikCloud.StoreSubscriptionsApi getSubscriptionTemplates GET /subscriptions/templates List and search subscription templates
KnetikCloud.StoreSubscriptionsApi getSubscriptions GET /subscriptions List available subscription items and associated plans
KnetikCloud.StoreSubscriptionsApi processSubscriptions POST /subscriptions/process Processes subscriptions and charge dues
KnetikCloud.StoreSubscriptionsApi updateSubscription PUT /subscriptions/{id} Updates a subscription item and associated plans
KnetikCloud.StoreSubscriptionsApi updateSubscriptionTemplate PATCH /subscriptions/templates/{id} Update a subscription template
KnetikCloud.StoreVendorsApi createVendor POST /vendors Create a vendor
KnetikCloud.StoreVendorsApi createVendorTemplate POST /vendors/templates Create a vendor template
KnetikCloud.StoreVendorsApi deleteVendor DELETE /vendors/{id} Delete a vendor
KnetikCloud.StoreVendorsApi deleteVendorTemplate DELETE /vendors/templates/{id} Delete a vendor template
KnetikCloud.StoreVendorsApi getVendor GET /vendors/{id} Get a single vendor
KnetikCloud.StoreVendorsApi getVendorTemplate GET /vendors/templates/{id} Get a single vendor template
KnetikCloud.StoreVendorsApi getVendorTemplates GET /vendors/templates List and search vendor templates
KnetikCloud.StoreVendorsApi getVendors GET /vendors List and search vendors
KnetikCloud.StoreVendorsApi updateVendor PUT /vendors/{id} Update a vendor
KnetikCloud.StoreVendorsApi updateVendorTemplate PATCH /vendors/templates/{id} Update a vendor template
KnetikCloud.TaxesApi createCountryTax POST /tax/countries Create a country tax
KnetikCloud.TaxesApi createStateTax POST /tax/countries/{country_code_iso3}/states Create a state tax
KnetikCloud.TaxesApi deleteCountryTax DELETE /tax/countries/{country_code_iso3} Delete an existing tax
KnetikCloud.TaxesApi deleteStateTax DELETE /tax/countries/{country_code_iso3}/states/{state_code} Delete an existing state tax
KnetikCloud.TaxesApi getCountryTax GET /tax/countries/{country_code_iso3} Get a single tax
KnetikCloud.TaxesApi getCountryTaxes GET /tax/countries List and search taxes
KnetikCloud.TaxesApi getStateTax GET /tax/countries/{country_code_iso3}/states/{state_code} Get a single state tax
KnetikCloud.TaxesApi getStateTaxesForCountries GET /tax/states List and search taxes across all countries
KnetikCloud.TaxesApi getStateTaxesForCountry GET /tax/countries/{country_code_iso3}/states List and search taxes within a country
KnetikCloud.TaxesApi updateCountryTax PUT /tax/countries/{country_code_iso3} Create or update a tax
KnetikCloud.TaxesApi updateStateTax PUT /tax/countries/{country_code_iso3}/states/{state_code} Create or update a state tax
KnetikCloud.TemplatesApi createTemplate POST /templates/{type_hint} Create a template
KnetikCloud.TemplatesApi deleteTemplate DELETE /templates/{type_hint}/{id} Delete a template
KnetikCloud.TemplatesApi getTemplate GET /templates/{type_hint}/{id} Get a template
KnetikCloud.TemplatesApi getTemplates GET /templates/{type_hint} List and search templates
KnetikCloud.TemplatesApi patchTemplate PATCH /templates/{type_hint}/{id} Patch a template
KnetikCloud.TemplatesApi validate POST /templates/{type_hint}/validate Validate a templated resource
KnetikCloud.TemplatesPropertiesApi getTemplatePropertyType GET /templates/properties/{type} Get details for a template property type
KnetikCloud.TemplatesPropertiesApi getTemplatePropertyTypes GET /templates/properties List template property types
KnetikCloud.UsersApi addUserTag POST /users/{user_id}/tags Add a tag to a user
KnetikCloud.UsersApi createUserTemplate POST /users/templates Create a user template
KnetikCloud.UsersApi deleteUserTemplate DELETE /users/templates/{id} Delete a user template
KnetikCloud.UsersApi getDirectMessages1 GET /users/{recipient_id}/messages Get a list of direct messages with this user
KnetikCloud.UsersApi getUser GET /users/{id} Get a single user
KnetikCloud.UsersApi getUserTags GET /users/{user_id}/tags List tags for a user
KnetikCloud.UsersApi getUserTemplate GET /users/templates/{id} Get a single user template
KnetikCloud.UsersApi getUserTemplates GET /users/templates List and search user templates
KnetikCloud.UsersApi getUsers GET /users List and search users
KnetikCloud.UsersApi passwordReset PUT /users/{id}/password-reset Choose a new password after a reset
KnetikCloud.UsersApi postUserMessage POST /users/{recipient_id}/messages Send a user message
KnetikCloud.UsersApi registerUser POST /users Register a new user
KnetikCloud.UsersApi registerUserCuentas POST /users/cuentas Register a new cuentas user
KnetikCloud.UsersApi removeUserTag DELETE /users/{user_id}/tags/{tag} Remove a tag from a user
KnetikCloud.UsersApi setPassword PUT /users/{id}/password Set a user's password
KnetikCloud.UsersApi startPasswordReset POST /users/{id}/password-reset Reset a user's password
KnetikCloud.UsersApi submitPasswordReset POST /users/password-reset Reset a user's password without user id
KnetikCloud.UsersApi updateUser PUT /users/{id} Update a user
KnetikCloud.UsersApi updateUserTemplate PATCH /users/templates/{id} Update a user template
KnetikCloud.UsersAddressesApi createAddress POST /users/{user_id}/addresses Create a new address
KnetikCloud.UsersAddressesApi deleteAddress DELETE /users/{user_id}/addresses/{id} Delete an address
KnetikCloud.UsersAddressesApi getAddress GET /users/{user_id}/addresses/{id} Get a single address
KnetikCloud.UsersAddressesApi getAddresses GET /users/{user_id}/addresses List and search addresses
KnetikCloud.UsersAddressesApi updateAddress PUT /users/{user_id}/addresses/{id} Update an address
KnetikCloud.UsersFriendshipsApi addFriend POST /users/{user_id}/friends/{id} Add a friend
KnetikCloud.UsersFriendshipsApi getFriends GET /users/{user_id}/friends Get friends list
KnetikCloud.UsersFriendshipsApi getInviteToken GET /users/{user_id}/invite-token Returns the invite token
KnetikCloud.UsersFriendshipsApi getInvites GET /users/{user_id}/invites Get pending invites
KnetikCloud.UsersFriendshipsApi redeemFriendshipToken POST /users/{user_id}/friends/tokens Redeem friendship token
KnetikCloud.UsersFriendshipsApi removeOrDeclineFriend DELETE /users/{user_id}/friends/{id} Remove or decline a friend
KnetikCloud.UsersGroupsApi addMemberToGroup POST /users/groups/{unique_name}/members Adds a new member to the group
KnetikCloud.UsersGroupsApi addMembersToGroup POST /users/groups/{unique_name}/members/batch-add Adds multiple members to the group
KnetikCloud.UsersGroupsApi createGroup POST /users/groups Create a group
KnetikCloud.UsersGroupsApi createGroupMemberTemplate POST /users/groups/members/templates Create a group member template
KnetikCloud.UsersGroupsApi createGroupTemplate POST /users/groups/templates Create a group template
KnetikCloud.UsersGroupsApi deleteGroup DELETE /users/groups/{unique_name} Removes a group from the system
KnetikCloud.UsersGroupsApi deleteGroupMemberTemplate DELETE /users/groups/members/templates/{id} Delete a group member template
KnetikCloud.UsersGroupsApi deleteGroupTemplate DELETE /users/groups/templates/{id} Delete a group template
KnetikCloud.UsersGroupsApi disableGroupNotification PUT /users/groups/{unique_name}/members/{user_id}/messages/disabled Enable or disable notification of group messages
KnetikCloud.UsersGroupsApi getGroup GET /users/groups/{unique_name} Loads a specific group's details
KnetikCloud.UsersGroupsApi getGroupAncestors GET /users/groups/{unique_name}/ancestors Get group ancestors
KnetikCloud.UsersGroupsApi getGroupMember GET /users/groups/{unique_name}/members/{user_id} Get a user from a group
KnetikCloud.UsersGroupsApi getGroupMemberTemplate GET /users/groups/members/templates/{id} Get a single group member template
KnetikCloud.UsersGroupsApi getGroupMemberTemplates GET /users/groups/members/templates List and search group member templates
KnetikCloud.UsersGroupsApi getGroupMembers GET /users/groups/{unique_name}/members Lists members of the group
KnetikCloud.UsersGroupsApi getGroupMessages GET /users/groups/{unique_name}/messages Get a list of group messages
KnetikCloud.UsersGroupsApi getGroupTemplate GET /users/groups/templates/{id} Get a single group template
KnetikCloud.UsersGroupsApi getGroupTemplates GET /users/groups/templates List and search group templates
KnetikCloud.UsersGroupsApi getGroupsForUser GET /users/{user_id}/groups List groups a user is in
KnetikCloud.UsersGroupsApi inviteToGroup POST /users/groups/{unique_name}/invite Invite to group
KnetikCloud.UsersGroupsApi listGroups GET /users/groups List and search groups
KnetikCloud.UsersGroupsApi postGroupMessage POST /users/groups/{unique_name}/messages Send a group message
KnetikCloud.UsersGroupsApi removeGroupMember DELETE /users/groups/{unique_name}/members/{user_id} Removes a user from a group
KnetikCloud.UsersGroupsApi updateGroup PUT /users/groups/{unique_name} Update a group
KnetikCloud.UsersGroupsApi updateGroupMemberOrder PUT /users/groups/{unique_name}/members/{user_id}/order Change a user's order
KnetikCloud.UsersGroupsApi updateGroupMemberProperties PUT /users/groups/{unique_name}/members/{user_id}/properties Change a user's membership properties
KnetikCloud.UsersGroupsApi updateGroupMemberStatus PUT /users/groups/{unique_name}/members/{user_id}/status Change a user's status
KnetikCloud.UsersGroupsApi updateGroupMemberTemplate PATCH /users/groups/members/templates/{id} Update a group member template
KnetikCloud.UsersGroupsApi updateGroupTemplate PATCH /users/groups/templates/{id} Update a group template
KnetikCloud.UsersInventoryApi addItemToUserInventory POST /users/{id}/inventory Adds an item to the user inventory
KnetikCloud.UsersInventoryApi checkUserEntitlementItem GET /users/{user_id}/entitlements/{item_id}/check Check for access to an item without consuming
KnetikCloud.UsersInventoryApi createEntitlementItem POST /entitlements Create an entitlement item
KnetikCloud.UsersInventoryApi createEntitlementTemplate POST /entitlements/templates Create an entitlement template
KnetikCloud.UsersInventoryApi deleteEntitlementItem DELETE /entitlements/{entitlement_id} Delete an entitlement item
KnetikCloud.UsersInventoryApi deleteEntitlementTemplate DELETE /entitlements/templates/{id} Delete an entitlement template
KnetikCloud.UsersInventoryApi getEntitlementItem GET /entitlements/{entitlement_id} Get a single entitlement item
KnetikCloud.UsersInventoryApi getEntitlementItems GET /entitlements List and search entitlement items
KnetikCloud.UsersInventoryApi getEntitlementTemplate GET /entitlements/templates/{id} Get a single entitlement template
KnetikCloud.UsersInventoryApi getEntitlementTemplates GET /entitlements/templates List and search entitlement templates
KnetikCloud.UsersInventoryApi getInventoryList GET /inventories List the user inventory entries for all users
KnetikCloud.UsersInventoryApi getUserInventories GET /users/{id}/inventory List the user inventory entries for a given user
KnetikCloud.UsersInventoryApi getUserInventory GET /users/{user_id}/inventory/{id} Get an inventory entry
KnetikCloud.UsersInventoryApi getUserInventoryLog GET /users/{user_id}/inventory/{id}/log List the log entries for this inventory entry
KnetikCloud.UsersInventoryApi grantUserEntitlement POST /users/{user_id}/entitlements Grant an entitlement
KnetikCloud.UsersInventoryApi updateEntitlementItem PUT /entitlements/{entitlement_id} Update an entitlement item
KnetikCloud.UsersInventoryApi updateEntitlementTemplate PATCH /entitlements/templates/{id} Update an entitlement template
KnetikCloud.UsersInventoryApi updateUserInventoryBehaviorData PUT /users/{user_id}/inventory/{id}/behavior-data Set the behavior data for an inventory entry
KnetikCloud.UsersInventoryApi updateUserInventoryExpires PUT /users/{user_id}/inventory/{id}/expires Set the expiration date
KnetikCloud.UsersInventoryApi updateUserInventoryStatus PUT /users/{user_id}/inventory/{id}/status Set the status for an inventory entry
KnetikCloud.UsersInventoryApi useUserEntitlementItem POST /users/{user_id}/entitlements/{item_id}/use Use an item
KnetikCloud.UsersRelationshipsApi createUserRelationship POST /users/relationships Create a user relationship
KnetikCloud.UsersRelationshipsApi deleteUserRelationship DELETE /users/relationships/{id} Delete a user relationship
KnetikCloud.UsersRelationshipsApi getRelationship GET /users/relationships/{id} Get a user relationship
KnetikCloud.UsersRelationshipsApi getUserRelationships GET /users/relationships Get a list of user relationships
KnetikCloud.UsersRelationshipsApi updateUserRelationship PUT /users/relationships/{id} Update a user relationship
KnetikCloud.UsersSubscriptionsApi getUserSubscriptionDetails GET /users/{user_id}/subscriptions/{inventory_id} Get details about a user's subscription
KnetikCloud.UsersSubscriptionsApi getUsersSubscriptionDetails GET /users/{user_id}/subscriptions Get details about a user's subscriptions
KnetikCloud.UsersSubscriptionsApi reactivateUserSubscription POST /users/{user_id}/subscriptions/{inventory_id}/reactivate Reactivate a subscription and charge fee
KnetikCloud.UsersSubscriptionsApi setSubscriptionBillDate PUT /users/{user_id}/subscriptions/{inventory_id}/bill-date Set a new date to bill a subscription on
KnetikCloud.UsersSubscriptionsApi setSubscriptionPaymentMethod PUT /users/{user_id}/subscriptions/{inventory_id}/payment-method Set the payment method to use for a subscription
KnetikCloud.UsersSubscriptionsApi setSubscriptionStatus PUT /users/{user_id}/subscriptions/{inventory_id}/status Set the status of a subscription
KnetikCloud.UsersSubscriptionsApi setUserSubscriptionPlan PUT /users/{user_id}/subscriptions/{inventory_id}/plan Set a new subscription plan for a user
KnetikCloud.UsersSubscriptionsApi setUserSubscriptionPrice PUT /users/{user_id}/subscriptions/{inventory_id}/price-override Set a new subscription price for a user
KnetikCloud.UtilBatchApi getBatch GET /batch/{token} Get batch result with token
KnetikCloud.UtilBatchApi sendBatch POST /batch Request to run API call given the method, content type, path url, and body of request
KnetikCloud.UtilHealthApi getHealth GET /health Get health info
KnetikCloud.UtilMaintenanceApi deleteMaintenance DELETE /maintenance Delete maintenance info
KnetikCloud.UtilMaintenanceApi getMaintenance GET /maintenance Get current maintenance info
KnetikCloud.UtilMaintenanceApi setMaintenance POST /maintenance Set current maintenance info
KnetikCloud.UtilSecurityApi getUserLocationLog GET /security/country-log Returns the authentication log for a user
KnetikCloud.UtilSecurityApi getUserTokenDetails GET /me Returns the authentication token details. Use /users endpoint for detailed user's info
KnetikCloud.UtilVersionApi getVersion GET /version Get current version info
KnetikCloud.VerificationApi createRequestTemplate POST /verification/templates Create a request template
KnetikCloud.VerificationApi createVerificationRequest POST /verification/requests Create a new request
KnetikCloud.VerificationApi deleteRequestTemplate DELETE /verification/templates/{id} Delete a request template
KnetikCloud.VerificationApi deleteVerificationRequest DELETE /verification/requests/{code} Delete an existing request
KnetikCloud.VerificationApi getRequestTemplate GET /verification/templates/{id} Get a single request template
KnetikCloud.VerificationApi getRequestTemplates GET /verification/templates List and search request templates
KnetikCloud.VerificationApi getVerificationRequest GET /verification/requests/{code} Get a single verification request
KnetikCloud.VerificationApi getVerificationRequests GET /verification/requests List requests
KnetikCloud.VerificationApi updateRequestTemplate PATCH /verification/templates/{id} Update a request template
KnetikCloud.VerificationApi updateVerificationRequest PUT /verification/requests/{code} Update an existing request
KnetikCloud.VerificationApi verifyRequest POST /verification/requests/{code}/responses Verify a request

Documentation for Models

Documentation for Authorization

oauth2_client_credentials_grant
  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
    • read write: read write
oauth2_implicit_grant
  • Type: OAuth
  • Flow: implicit
  • Authorization URL: /oauth/authorize
  • Scopes:
    • read write: read write
oauth2_password_grant
  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes:
    • read write: read write