Skip to content
/ knetikcloud-java-client Public

Java SDK for connecting to KnetikCloud. Visit knetikcloud.com or spawnpoint.com for details.

0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

knetikcloud/knetikcloud-java-client

BranchesTags

Repository files navigation

knetikcloud-java-client

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>com.knetikcloud</groupId>
    <artifactId>knetikcloud-java-client</artifactId>
    <version>3.1.4</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.knetikcloud:knetikcloud-java-client:3.1.4"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/knetikcloud-java-client-3.1.4.jar
  • target/lib/*.jar

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 Java code:

import com.knetikcloud.client.*;
import com.knetikcloud.client.auth.*;
import com.knetikcloud.model.*;
import com.knetikcloud.api.AccessTokenApi;

import java.io.File;
import java.util.*;

public class AccessTokenApiExample {

    public static void main(String[] args) {
        
        AccessTokenApi apiInstance = new AccessTokenApi();
        String grantType = "client_credentials"; // String | Grant type
        String clientId = "knetik"; // String | The id of the client
        String clientSecret = "clientSecret_example"; // String | The secret key of the client.  Used only with a grant_type of client_credentials
        String username = "username_example"; // String | The username of the client. Used only with a grant_type of password
        String password = "password_example"; // String | The password of the client. Used only with a grant_type of password
        String token = "token_example"; // String | The 3rd party authentication token. Used only with a grant_type of facebook, google, etc (social plugins)
        String refreshToken = "refreshToken_example"; // String | The refresh token obtained during prior authentication. Used only with a grant_type of refresh_token
        try {
            OAuth2Resource result = apiInstance.getOAuthToken(grantType, clientId, clientSecret, username, password, token, refreshToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessTokenApi#getOAuthToken");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AccessTokenApi getOAuthToken POST /oauth/token Get access token
ActivitiesApi addUser POST /activity-occurrences/{activity_occurrence_id}/users Add a user to an occurrence
ActivitiesApi createActivity POST /activities Create an activity
ActivitiesApi createActivityOccurrence POST /activity-occurrences Create a new activity occurrence. Ex: start a game
ActivitiesApi createActivityTemplate POST /activities/templates Create an activity template
ActivitiesApi deleteActivity DELETE /activities/{id} Delete an activity
ActivitiesApi deleteActivityTemplate DELETE /activities/templates/{id} Delete an activity template
ActivitiesApi getActivities GET /activities List activity definitions
ActivitiesApi getActivity GET /activities/{id} Get a single activity
ActivitiesApi getActivityOccurrenceDetails GET /activity-occurrences/{activity_occurrence_id} Load a single activity occurrence details
ActivitiesApi getActivityTemplate GET /activities/templates/{id} Get a single activity template
ActivitiesApi getActivityTemplates GET /activities/templates List and search activity templates
ActivitiesApi listActivityOccurrences GET /activity-occurrences List activity occurrences
ActivitiesApi removeUser DELETE /activity-occurrences/{activity_occurrence_id}/users/{user_id} Remove a user from an occurrence
ActivitiesApi setActivityOccurrenceResults POST /activity-occurrences/{activity_occurrence_id}/results Sets the status of an activity occurrence to FINISHED and logs metrics
ActivitiesApi setActivityOccurrenceSettings PUT /activity-occurrences/{activity_occurrence_id}/settings Sets the settings of an activity occurrence
ActivitiesApi setUserStatus PUT /activity-occurrences/{activity_occurrence_id}/users/{user_id}/status Set a user's status within an occurrence
ActivitiesApi updateActivity PUT /activities/{id} Update an activity
ActivitiesApi updateActivityOccurrenceStatus PUT /activity-occurrences/{activity_occurrence_id}/status Update the status of an activity occurrence
ActivitiesApi updateActivityTemplate PATCH /activities/templates/{id} Update an activity template
AmazonWebServicesS3Api getDownloadURL GET /amazon/s3/download-url Get a temporary signed S3 URL for download
AmazonWebServicesS3Api getSignedS3URL GET /amazon/s3/signed-post-url Get a signed S3 URL for upload
AuthClientsApi createClient POST /auth/clients Create a new client
AuthClientsApi deleteClient DELETE /auth/clients/{client_key} Delete a client
AuthClientsApi getClient GET /auth/clients/{client_key} Get a single client
AuthClientsApi getClientGrantTypes GET /auth/clients/grant-types List available client grant types
AuthClientsApi getClients GET /auth/clients List and search clients
AuthClientsApi setClientGrantTypes PUT /auth/clients/{client_key}/grant-types Set grant types for a client
AuthClientsApi setClientRedirectUris PUT /auth/clients/{client_key}/redirect-uris Set redirect uris for a client
AuthClientsApi updateClient PUT /auth/clients/{client_key} Update a client
AuthPermissionsApi createPermission POST /auth/permissions Create a new permission
AuthPermissionsApi deletePermission DELETE /auth/permissions/{permission} Delete a permission
AuthPermissionsApi getPermission GET /auth/permissions/{permission} Get a single permission
AuthPermissionsApi getPermissions GET /auth/permissions List and search permissions
AuthPermissionsApi updatePermission PUT /auth/permissions/{permission} Update a permission
AuthProvidersApi createProvider POST /auth/providers Create a new OAuth 2 provider
AuthProvidersApi deleteProvider DELETE /auth/providers/{provider_id} Delete an existing OAuth 2 provider
AuthProvidersApi getProvider GET /auth/providers/{provider_id} Get an existing OAuth 2 provider
AuthProvidersApi getProviders GET /auth/providers List OAuth 2 providers
AuthProvidersApi updateProvider PUT /auth/providers/{provider_id} Update an existing OAuth 2 provider
AuthRolesApi createRole POST /auth/roles Create a new role
AuthRolesApi deleteRole DELETE /auth/roles/{role} Delete a role
AuthRolesApi getClientRoles GET /auth/clients/{client_key}/roles Get roles for a client
AuthRolesApi getRole GET /auth/roles/{role} Get a single role
AuthRolesApi getRoles GET /auth/roles List and search roles
AuthRolesApi getUserRoles GET /auth/users/{user_id}/roles Get roles for a user
AuthRolesApi setClientRoles PUT /auth/clients/{client_key}/roles Set roles for a client
AuthRolesApi setPermissionsForRole PUT /auth/roles/{role}/permissions Set permissions for a role
AuthRolesApi setUserRoles PUT /auth/users/{user_id}/roles Set roles for a user
AuthRolesApi updateRole PUT /auth/roles/{role} Update a role
AuthTokensApi deleteTokens DELETE /auth/tokens Delete tokens by username, client id, or both
AuthTokensApi getToken GET /auth/tokens/{username}/{client_id} Get a single token by username and client id
AuthTokensApi getTokens GET /auth/tokens List usernames and client ids
AuthTypesApi allowedResourceActions GET /access/resources/{type}/{id}/actions Get allowed action
AuthTypesApi allowedTypeActions GET /access/types/{type}/actions Get allowed actions on a type
AuthTypesApi createResource POST /access/resources/{type} Create or update resource
AuthTypesApi createType POST /access/types Create a new type
AuthTypesApi deleteAllOfType DELETE /access/resources/{type} Delete all resources of a type
AuthTypesApi deleteResource DELETE /access/resources/{type}/{id} Delete a resource
AuthTypesApi deleteType DELETE /access/types/{type} Delete a root type
AuthTypesApi getResource GET /access/resources/{type}/{id} Get a single resource
AuthTypesApi getResources GET /access/resources/{type} List and search resources
AuthTypesApi getType GET /access/types/{type} Get a single root type
AuthTypesApi getTypes GET /access/types List and search types
AuthTypesApi updateResource PUT /access/resources/{type}/{id} Update a resource
AuthTypesApi updateType PUT /access/types/{type} Update a root type
AuthUsersApi addSid POST /access/users/{user_id}/sids Add a sid to a user
AuthUsersApi getResources1 GET /access/users/{user_id}/sids List and search user sids
AuthUsersApi getSid GET /access/users/{user_id}/sids/{sid} Get a user sid
AuthUsersApi removeSid DELETE /access/users/{user_id}/sids/{sid} Remove a sid from a user
CampaignsApi addChallengeToCampaign POST /campaigns/{id}/challenges Add a challenge to a campaign
CampaignsApi createCampaign POST /campaigns Create a campaign
CampaignsApi createCampaignTemplate POST /campaigns/templates Create a campaign template
CampaignsApi deleteCampaign DELETE /campaigns/{id} Delete a campaign
CampaignsApi deleteCampaignTemplate DELETE /campaigns/templates/{id} Delete a campaign template
CampaignsApi getCampaign GET /campaigns/{id} Returns a single campaign
CampaignsApi getCampaignChallenges GET /campaigns/{id}/challenges List the challenges associated with a campaign
CampaignsApi getCampaignTemplate GET /campaigns/templates/{id} Get a single campaign template
CampaignsApi getCampaignTemplates GET /campaigns/templates List and search campaign templates
CampaignsApi getCampaigns GET /campaigns List and search campaigns
CampaignsApi removeChallengeFromCampaign DELETE /campaigns/{campaign_id}/challenges/{id} Remove a challenge from a campaign
CampaignsApi updateCampaign PUT /campaigns/{id} Update a campaign
CampaignsApi updateCampaignTemplate PATCH /campaigns/templates/{id} Update an campaign template
CampaignsChallengesApi createChallenge POST /challenges Create a challenge
CampaignsChallengesApi createChallengeActivity POST /challenges/{challenge_id}/activities Create a challenge activity
CampaignsChallengesApi createChallengeActivityTemplate POST /challenge-activities/templates Create a challenge activity template
CampaignsChallengesApi createChallengeTemplate POST /challenges/templates Create a challenge template
CampaignsChallengesApi deleteChallenge DELETE /challenges/{id} Delete a challenge
CampaignsChallengesApi deleteChallengeActivity DELETE /challenges/{challenge_id}/activities/{id} Delete a challenge activity
CampaignsChallengesApi deleteChallengeActivityTemplate DELETE /challenge-activities/templates/{id} Delete a challenge activity template
CampaignsChallengesApi deleteChallengeEvent DELETE /challenges/events/{id} Delete a challenge event
CampaignsChallengesApi deleteChallengeTemplate DELETE /challenges/templates/{id} Delete a challenge template
CampaignsChallengesApi getChallenge GET /challenges/{id} Retrieve a challenge
CampaignsChallengesApi getChallengeActivities GET /challenges/{challenge_id}/activities List and search challenge activities
CampaignsChallengesApi getChallengeActivity GET /challenges/{challenge_id}/activities/{id} Get a single challenge activity
CampaignsChallengesApi getChallengeActivityTemplate GET /challenge-activities/templates/{id} Get a single challenge activity template
CampaignsChallengesApi getChallengeActivityTemplates GET /challenge-activities/templates List and search challenge activity templates
CampaignsChallengesApi getChallengeEvent GET /challenges/events/{id} Retrieve a single challenge event details
CampaignsChallengesApi getChallengeEvents GET /challenges/events Retrieve a list of challenge events
CampaignsChallengesApi getChallengeTemplate GET /challenges/templates/{id} Get a single challenge template
CampaignsChallengesApi getChallengeTemplates GET /challenges/templates List and search challenge templates
CampaignsChallengesApi getChallenges GET /challenges Retrieve a list of challenges
CampaignsChallengesApi updateChallenge PUT /challenges/{id} Update a challenge
CampaignsChallengesApi updateChallengeActivity PUT /challenges/{challenge_id}/activities/{id} Update a challenge activity
CampaignsChallengesApi updateChallengeActivityTemplate PATCH /challenge-activities/templates/{id} Update an challenge activity template
CampaignsChallengesApi updateChallengeTemplate PATCH /challenges/templates/{id} Update a challenge template
CampaignsRewardsApi createRewardSet POST /rewards Create a reward set
CampaignsRewardsApi deleteRewardSet DELETE /rewards/{id} Delete a reward set
CampaignsRewardsApi getRewardSet GET /rewards/{id} Get a single reward set
CampaignsRewardsApi getRewardSets GET /rewards List and search reward sets
CampaignsRewardsApi updateRewardSet PUT /rewards/{id} Update a reward set
CategoriesApi createCategory POST /categories Create a new category
CategoriesApi createCategoryTemplate POST /categories/templates Create a category template
CategoriesApi deleteCategory DELETE /categories/{id} Delete an existing category
CategoriesApi deleteCategoryTemplate DELETE /categories/templates/{id} Delete a category template
CategoriesApi getCategories GET /categories List and search categories with optional filters
CategoriesApi getCategory GET /categories/{id} Get a single category
CategoriesApi getCategoryTemplate GET /categories/templates/{id} Get a single category template
CategoriesApi getCategoryTemplates GET /categories/templates List and search category templates
CategoriesApi getTags GET /tags List all trivia tags in the system
CategoriesApi updateCategory PUT /categories/{id} Update an existing category
CategoriesApi updateCategoryTemplate PATCH /categories/templates/{id} Update a category template
ChatApi acknowledgeChatMessage PUT /chat/threads/{id}/acknowledge Acknowledge number of messages in a thread
ChatApi addChatMessageBlacklist POST /chat/users/{id}/blacklist/{blacklisted_user_id} Add a user to a chat message blacklist
ChatApi deleteChatMessage DELETE /chat/messages/{id} Delete a message
ChatApi editChatMessage PUT /chat/messages/{id} Edit your message
ChatApi getChatMessage GET /chat/messages/{id} Get a message
ChatApi getChatMessageBlacklist GET /chat/users/{id}/blacklist Get a list of blocked users for chat messaging
ChatApi getChatThreads GET /chat/threads List your threads
ChatApi getDirectMessages GET /chat/users/{id}/messages List messages with a user
ChatApi getThreadMessages GET /chat/threads/{id}/messages List messages in a thread
ChatApi getTopicMessages GET /chat/topics/{id}/messages List messages in a topic
ChatApi removeChatBlacklist DELETE /chat/users/{id}/blacklist/{blacklisted_user_id} Remove a user from a blacklist
ChatApi sendChatMessage POST /chat/messages Send a message
ConfigsApi createConfig POST /configs Create a new config
ConfigsApi deleteConfig DELETE /configs/{name} Delete an existing config
ConfigsApi getConfig GET /configs/{name} Get a single config
ConfigsApi getConfigs GET /configs List and search configs
ConfigsApi updateConfig PUT /configs/{name} Update an existing config
ContentArticlesApi createArticle POST /content/articles Create a new article
ContentArticlesApi createArticleTemplate POST /content/articles/templates Create an article template
ContentArticlesApi deleteArticle DELETE /content/articles/{id} Delete an existing article
ContentArticlesApi deleteArticleTemplate DELETE /content/articles/templates/{id} Delete an article template
ContentArticlesApi getArticle GET /content/articles/{id} Get a single article
ContentArticlesApi getArticleTemplate GET /content/articles/templates/{id} Get a single article template
ContentArticlesApi getArticleTemplates GET /content/articles/templates List and search article templates
ContentArticlesApi getArticles GET /content/articles List and search articles
ContentArticlesApi updateArticle PUT /content/articles/{id} Update an existing article
ContentArticlesApi updateArticleTemplate PATCH /content/articles/templates/{id} Update an article template
ContentCommentsApi addComment POST /comments Add a new comment
ContentCommentsApi deleteComment DELETE /comments/{id} Delete a comment
ContentCommentsApi getComment GET /comments/{id} Return a comment
ContentCommentsApi getComments GET /comments Returns a page of comments
ContentCommentsApi updateComment PUT /comments/{id}/content Update a comment
CurrenciesApi createCurrency POST /currencies Create a currency
CurrenciesApi deleteCurrency DELETE /currencies/{code} Delete a currency
CurrenciesApi getCurrencies GET /currencies List and search currencies
CurrenciesApi getCurrency GET /currencies/{code} Get a single currency
CurrenciesApi updateCurrency PUT /currencies/{code} Update a currency
DevicesApi addDeviceUser POST /devices/{id}/users Add device users
DevicesApi createDevice POST /devices Create a device
DevicesApi createDeviceTemplate POST /devices/templates Create a device template
DevicesApi deleteDevice DELETE /devices/{id} Delete a device
DevicesApi deleteDeviceTemplate DELETE /devices/templates/{id} Delete an device template
DevicesApi deleteDeviceUser DELETE /devices/{id}/users/{user_id} Delete a device user
DevicesApi deleteDeviceUsers DELETE /devices/{id}/users Delete all device users
DevicesApi getDevice GET /devices/{id} Get a single device
DevicesApi getDeviceTemplate GET /devices/templates/{id} Get a single device template
DevicesApi getDeviceTemplates GET /devices/templates List and search device templates
DevicesApi getDevices GET /devices List and search devices
DevicesApi updateDevice PUT /devices/{id} Update a device
DevicesApi updateDeviceTemplate PATCH /devices/templates/{id} Update an device template
DispositionsApi addDisposition POST /dispositions Add a new disposition
DispositionsApi deleteDisposition DELETE /dispositions/{id} Delete a disposition
DispositionsApi getDisposition GET /dispositions/{id} Returns a disposition
DispositionsApi getDispositionCounts GET /dispositions/count Returns a list of disposition counts
DispositionsApi getDispositions GET /dispositions Returns a page of dispositions
FulfillmentApi createFulfillmentType POST /store/fulfillment/types Create a fulfillment type
FulfillmentApi deleteFulfillmentType DELETE /store/fulfillment/types/{id} Delete a fulfillment type
FulfillmentApi getFulfillmentType GET /store/fulfillment/types/{id} Get a single fulfillment type
FulfillmentApi getFulfillmentTypes GET /store/fulfillment/types List and search fulfillment types
FulfillmentApi updateFulfillmentType PUT /store/fulfillment/types/{id} Update a fulfillment type
GamificationAchievementsApi createAchievement POST /achievements Create a new achievement definition
GamificationAchievementsApi createAchievementTemplate POST /achievements/templates Create an achievement template
GamificationAchievementsApi deleteAchievement DELETE /achievements/{name} Delete an achievement definition
GamificationAchievementsApi deleteAchievementTemplate DELETE /achievements/templates/{id} Delete an achievement template
GamificationAchievementsApi getAchievement GET /achievements/{name} Get a single achievement definition
GamificationAchievementsApi getAchievementTemplate GET /achievements/templates/{id} Get a single achievement template
GamificationAchievementsApi getAchievementTemplates GET /achievements/templates List and search achievement templates
GamificationAchievementsApi getAchievementTriggers GET /achievements/triggers Get the list of triggers that can be used to trigger an achievement progress update
GamificationAchievementsApi getAchievements GET /achievements Get all achievement definitions in the system
GamificationAchievementsApi getDerivedAchievements GET /achievements/derived/{name} Get a list of derived achievements
GamificationAchievementsApi getUserAchievementProgress GET /users/{user_id}/achievements/{achievement_name} Retrieve progress on a given achievement for a given user
GamificationAchievementsApi getUserAchievementsProgress GET /users/{user_id}/achievements Retrieve progress on achievements for a given user
GamificationAchievementsApi getUsersAchievementProgress GET /users/achievements/{achievement_name} Retrieve progress on a given achievement for all users
GamificationAchievementsApi getUsersAchievementsProgress GET /users/achievements Retrieve progress on achievements for all users
GamificationAchievementsApi incrementAchievementProgress POST /users/{user_id}/achievements/{achievement_name}/progress Increment an achievement progress record for a user
GamificationAchievementsApi setAchievementProgress PUT /users/{user_id}/achievements/{achievement_name}/progress Set an achievement progress record for a user
GamificationAchievementsApi updateAchievement PUT /achievements/{name} Update an achievement definition
GamificationAchievementsApi updateAchievementTemplate PATCH /achievements/templates/{id} Update an achievement template
GamificationLeaderboardsApi getLeaderboard GET /leaderboards/{context_type}/{context_id} Retrieves leaderboard details and paginated entries
GamificationLeaderboardsApi getLeaderboardRank GET /leaderboards/{context_type}/{context_id}/users/{id}/rank Retrieves a specific user entry with rank
GamificationLeaderboardsApi getLeaderboardStrategies GET /leaderboards/strategies Get a list of available leaderboard strategy names
GamificationLevelingApi createLevel POST /leveling Create a level schema
GamificationLevelingApi deleteLevel DELETE /leveling/{name} Delete a level
GamificationLevelingApi getLevel GET /leveling/{name} Retrieve a level
GamificationLevelingApi getLevelTriggers GET /leveling/triggers Get the list of triggers that can be used to trigger a leveling progress update
GamificationLevelingApi getLevels GET /leveling List and search levels
GamificationLevelingApi getUserLevel GET /users/{user_id}/leveling/{name} Get a user's progress for a given level schema
GamificationLevelingApi getUserLevels GET /users/{user_id}/leveling Get a user's progress for all level schemas
GamificationLevelingApi incrementProgress POST /users/{user_id}/leveling/{name}/progress Update or create a leveling progress record for a user
GamificationLevelingApi setProgress PUT /users/{user_id}/leveling/{name}/progress Set leveling progress for a user
GamificationLevelingApi updateLevel PUT /leveling/{name} Update a level
GamificationMetricsApi addMetric POST /metrics Add a metric
GamificationTriviaApi addQuestionAnswers POST /trivia/questions/{question_id}/answers Add an answer to a question
GamificationTriviaApi addQuestionTag POST /trivia/questions/{id}/tags Add a tag to a question
GamificationTriviaApi addTagToQuestionsBatch POST /trivia/questions/tags Add a tag to a batch of questions
GamificationTriviaApi createImportJob POST /trivia/import Create an import job
GamificationTriviaApi createQuestion POST /trivia/questions Create a question
GamificationTriviaApi createQuestionTemplate POST /trivia/questions/templates Create a question template
GamificationTriviaApi deleteImportJob DELETE /trivia/import/{id} Delete an import job
GamificationTriviaApi deleteQuestion DELETE /trivia/questions/{id} Delete a question
GamificationTriviaApi deleteQuestionAnswers DELETE /trivia/questions/{question_id}/answers/{id} Remove an answer from a question
GamificationTriviaApi deleteQuestionTemplate DELETE /trivia/questions/templates/{id} Delete a question template
GamificationTriviaApi getImportJob GET /trivia/import/{id} Get an import job
GamificationTriviaApi getImportJobs GET /trivia/import Get a list of import job
GamificationTriviaApi getQuestion GET /trivia/questions/{id} Get a single question
GamificationTriviaApi getQuestionAnswer GET /trivia/questions/{question_id}/answers/{id} Get an answer for a question
GamificationTriviaApi getQuestionAnswers GET /trivia/questions/{question_id}/answers List the answers available for a question
GamificationTriviaApi getQuestionDeltas GET /trivia/questions/delta List question deltas in ascending order of updated date
GamificationTriviaApi getQuestionTags GET /trivia/questions/{id}/tags List the tags for a question
GamificationTriviaApi getQuestionTemplate GET /trivia/questions/templates/{id} Get a single question template
GamificationTriviaApi getQuestionTemplates GET /trivia/questions/templates List and search question templates
GamificationTriviaApi getQuestions GET /trivia/questions List and search questions
GamificationTriviaApi getQuestionsCount GET /trivia/questions/count Count questions based on filters
GamificationTriviaApi processImportJob POST /trivia/import/{id}/process Start processing an import job
GamificationTriviaApi removeQuestionTag DELETE /trivia/questions/{id}/tags/{tag} Remove a tag from a question
GamificationTriviaApi removeTagToQuestionsBatch DELETE /trivia/questions/tags/{tag} Remove a tag from a batch of questions
GamificationTriviaApi searchQuestionTags GET /trivia/tags List and search tags by the beginning of the string
GamificationTriviaApi updateImportJob PUT /trivia/import/{id} Update an import job
GamificationTriviaApi updateQuestion PUT /trivia/questions/{id} Update a question
GamificationTriviaApi updateQuestionAnswer PUT /trivia/questions/{question_id}/answers/{id} Update an answer for a question
GamificationTriviaApi updateQuestionTemplate PATCH /trivia/questions/templates/{id} Update a question template
GamificationTriviaApi updateQuestionsInBulk PUT /trivia/questions Bulk update questions
InvoicesApi createInvoice POST /invoices Create an invoice
InvoicesApi createInvoiceTemplate POST /invoices/templates Create a invoice template
InvoicesApi deleteInvoiceTemplate DELETE /invoices/templates/{id} Delete a invoice template
InvoicesApi getFulFillmentStatuses GET /invoices/fulfillment-statuses Lists available fulfillment statuses
InvoicesApi getInvoice GET /invoices/{id} Retrieve an invoice
InvoicesApi getInvoiceLogs GET /invoices/{id}/logs List invoice logs
InvoicesApi getInvoiceTemplate GET /invoices/templates/{id} Get a single invoice template
InvoicesApi getInvoiceTemplates GET /invoices/templates List and search invoice templates
InvoicesApi getInvoices GET /invoices Retrieve invoices
InvoicesApi getPaymentStatuses GET /invoices/payment-statuses Lists available payment statuses
InvoicesApi payInvoice POST /invoices/{id}/payments Pay an invoice using a saved payment method
InvoicesApi setAdditionalProperties PUT /invoices/{id}/properties Set the additional properties of an invoice
InvoicesApi setBundledInvoiceItemFulfillmentStatus PUT /invoices/{id}/items/{bundleSku}/bundled-skus/{sku}/fulfillment-status Set the fulfillment status of a bundled invoice item
InvoicesApi setExternalRef PUT /invoices/{id}/external-ref Set the external reference of an invoice
InvoicesApi setInvoiceItemFulfillmentStatus PUT /invoices/{id}/items/{sku}/fulfillment-status Set the fulfillment status of an invoice item
InvoicesApi setOrderNotes PUT /invoices/{id}/order-notes Set the order notes of an invoice
InvoicesApi setPaymentStatus PUT /invoices/{id}/payment-status Set the payment status of an invoice
InvoicesApi updateBillingInfo PUT /invoices/{id}/billing-address Set or update billing info
InvoicesApi updateInvoiceTemplate PATCH /invoices/templates/{id} Update a invoice template
LevelingApi createLevelingTemplate POST /leveling/templates Create a leveling template
LevelingApi deleteLevelingTemplate DELETE /leveling/templates/{id} Delete a leveling template
LevelingApi getLevelingTemplate GET /leveling/templates/{id} Get a single leveling template
LevelingApi getLevelingTemplates GET /leveling/templates List and search leveling templates
LevelingApi updateLevelingTemplate PATCH /leveling/templates/{id} Update a leveling template
LocationsApi getCountries GET /location/countries Get a list of countries
LocationsApi getCountryByGeoLocation GET /location/geolocation/country Get the iso3 code of your country
LocationsApi getCountryStates GET /location/countries/{country_code_iso3}/states Get a list of a country's states
LocationsApi getCurrencyByGeoLocation GET /location/geolocation/currency Get the currency information of your country
LoginControllerApi login GET /login login
LogsApi getBREEventLog GET /bre/logs/event-log/{id} Get an existing BRE event log entry by id
LogsApi getBREEventLogs GET /bre/logs/event-log Returns a list of BRE event log entries
LogsApi getBREForwardLog GET /bre/logs/forward-log/{id} Get an existing forward log entry by id
LogsApi getBREForwardLogs GET /bre/logs/forward-log Returns a list of forward log entries
LogsApi getUserLogs GET /audit/logs/{id} Returns a user log entry by id
LogsApi getUserLogs1 GET /audit/logs Returns a page of user logs entries
MediaArtistsApi addArtist POST /media/artists Adds a new artist in the system
MediaArtistsApi createArtistTemplate POST /media/artists/templates Create an artist template
MediaArtistsApi deleteArtist DELETE /media/artists/{id} Removes an artist from the system IF no resources are attached to it
MediaArtistsApi deleteArtistTemplate DELETE /media/artists/templates/{id} Delete an artist template
MediaArtistsApi getArtist GET /media/artists/{id} Loads a specific artist details
MediaArtistsApi getArtistTemplate GET /media/artists/templates/{id} Get a single artist template
MediaArtistsApi getArtistTemplates GET /media/artists/templates List and search artist templates
MediaArtistsApi getArtists GET /media/artists Search for artists
MediaArtistsApi updateArtist PUT /media/artists/{id} Modifies an artist details
MediaArtistsApi updateArtistTemplate PATCH /media/artists/templates/{id} Update an artist template
MediaModerationApi addFlag POST /moderation/flags Add a flag
MediaModerationApi deleteFlag DELETE /moderation/flags Delete a flag
MediaModerationApi getFlags GET /moderation/flags Returns a page of flags
MediaModerationApi getModerationReport GET /moderation/reports/{id} Get a flag report
MediaModerationApi getModerationReports GET /moderation/reports Returns a page of flag reports
MediaModerationApi updateModerationReport PUT /moderation/reports/{id} Update a flag report
MediaPollsApi answerPoll POST /media/polls/{id}/response Add your vote to a poll
MediaPollsApi createPoll POST /media/polls Create a new poll
MediaPollsApi createPollTemplate POST /media/polls/templates Create a poll template
MediaPollsApi deletePoll DELETE /media/polls/{id} Delete an existing poll
MediaPollsApi deletePollTemplate DELETE /media/polls/templates/{id} Delete a poll template
MediaPollsApi getPoll GET /media/polls/{id} Get a single poll
MediaPollsApi getPollAnswer GET /media/polls/{id}/response Get poll answer
MediaPollsApi getPollTemplate GET /media/polls/templates/{id} Get a single poll template
MediaPollsApi getPollTemplates GET /media/polls/templates List and search poll templates
MediaPollsApi getPolls GET /media/polls List and search polls
MediaPollsApi updatePoll PUT /media/polls/{id} Update an existing poll
MediaPollsApi updatePollTemplate PATCH /media/polls/templates/{id} Update a poll template
MediaVideosApi addUserToVideoWhitelist POST /media/videos/{id}/whitelist Adds a user to a video's whitelist
MediaVideosApi addVideo POST /media/videos Adds a new video in the system
MediaVideosApi addVideoComment POST /media/videos/{video_id}/comments Add a new video comment
MediaVideosApi addVideoContributor POST /media/videos/{video_id}/contributors Adds a contributor to a video
MediaVideosApi addVideoFlag POST /media/videos/{video_id}/moderation Add a new flag
MediaVideosApi addVideoRelationships POST /media/videos/{video_id}/related Adds one or more existing videos as related to this one
MediaVideosApi createVideoDisposition POST /media/videos/{video_id}/dispositions Create a video disposition
MediaVideosApi createVideoTemplate POST /media/videos/templates Create a video template
MediaVideosApi deleteVideo DELETE /media/videos/{id} Deletes a video from the system if no resources are attached to it
MediaVideosApi deleteVideoComment DELETE /media/videos/{video_id}/comments/{id} Delete a video comment
MediaVideosApi deleteVideoDisposition DELETE /media/videos/{video_id}/dispositions/{disposition_id} Delete a video disposition
MediaVideosApi deleteVideoFlag DELETE /media/videos/{video_id}/moderation Delete a flag
MediaVideosApi deleteVideoRelationship DELETE /media/videos/{video_id}/related/{id} Delete a video's relationship
MediaVideosApi deleteVideoTemplate DELETE /media/videos/templates/{id} Delete a video template
MediaVideosApi getUserVideos GET /users/{user_id}/videos Get user videos
MediaVideosApi getVideo GET /media/videos/{id} Loads a specific video details
MediaVideosApi getVideoComments GET /media/videos/{video_id}/comments Returns a page of comments for a video
MediaVideosApi getVideoDispositions GET /media/videos/{video_id}/dispositions Returns a page of dispositions for a video
MediaVideosApi getVideoRelationships GET /media/videos/{video_id}/related Returns a page of video relationships
MediaVideosApi getVideoTemplate GET /media/videos/templates/{id} Get a single video template
MediaVideosApi getVideoTemplates GET /media/videos/templates List and search video templates
MediaVideosApi getVideos GET /media/videos Search videos using the documented filters
MediaVideosApi removeUserFromVideoWhitelist DELETE /media/videos/{video_id}/whitelist/{id} Removes a user from a video's whitelist
MediaVideosApi removeVideoContributor DELETE /media/videos/{video_id}/contributors/{id} Removes a contributor from a video
MediaVideosApi updateVideo PUT /media/videos/{id} Modifies a video's details
MediaVideosApi updateVideoComment PUT /media/videos/{video_id}/comments/{id}/content Update a video comment
MediaVideosApi updateVideoRelationship PUT /media/videos/{video_id}/related/{id}/relationship_details Update a video's relationship details
MediaVideosApi updateVideoTemplate PATCH /media/videos/templates/{id} Update a video template
MediaVideosApi viewVideo POST /media/videos/{id}/views Increment a video's view count
MessagingApi compileMessageTemplates POST /messaging/templates/compilations Compile a message template
MessagingApi createMessageTemplate POST /messaging/templates Create a message template
MessagingApi deleteMessageTemplate DELETE /messaging/templates/{id} Delete an existing message template
MessagingApi getMessageTemplate GET /messaging/templates/{id} Get a single message template
MessagingApi getMessageTemplates GET /messaging/templates List and search message templates
MessagingApi sendMessage POST /messaging/message Send a message
MessagingApi sendRawEmail POST /messaging/raw-email Send a raw email to one or more users
MessagingApi sendRawPush POST /messaging/raw-push Send a raw push notification
MessagingApi sendRawSMS POST /messaging/raw-sms Send a raw SMS
MessagingApi sendTemplatedEmail POST /messaging/templated-email Send a templated email to one or more users
MessagingApi sendTemplatedPush POST /messaging/templated-push Send a templated push notification
MessagingApi sendTemplatedSMS POST /messaging/templated-sms Send a new templated SMS
MessagingApi sendWebsocket POST /messaging/websocket-message Send a websocket message
MessagingApi updateMessageTemplate PUT /messaging/templates/{id} Update an existing message template
MessagingTopicsApi disableTopicSubscriber PUT /messaging/topics/{id}/subscribers/{user_id}/disabled Enable or disable messages for a user
MessagingTopicsApi getTopicSubscriber GET /messaging/topics/{id}/subscribers/{user_id} Get a subscriber to a topic
MessagingTopicsApi getUserTopics GET /users/{id}/topics Get all messaging topics for a given user
MonitoringApi createAlert POST /monitoring/alerts Create a new alert
MonitoringApi createMetric POST /monitoring/metrics Create a new metric
MonitoringApi deleteAlert DELETE /monitoring/alerts/{id} Delete an existing alert
MonitoringApi deleteDatapoint DELETE /monitoring/metrics/{id}/datapoints Delete a metric datapoint
MonitoringApi deleteIncident DELETE /monitoring/incidents/{id} End an existing incident
MonitoringApi deleteMetric DELETE /monitoring/metrics/{id} Delete an existing metric
MonitoringApi getAlert GET /monitoring/alerts/{id} Get a single alert
MonitoringApi getAlerts GET /monitoring/alerts List and search alerts
MonitoringApi getIncident GET /monitoring/incidents/{id} Get a single incident
MonitoringApi getIncidentEvents GET /monitoring/incidents/{id}/events Get the events of an incident
MonitoringApi getIncidents GET /monitoring/incidents List and search incidents
MonitoringApi getMetric GET /monitoring/metrics/{id} Get a single metric
MonitoringApi getMetrics GET /monitoring/metrics List and search metrics
MonitoringApi postBatch POST /monitoring/metrics/datapoints Post a metric datapoint batch
MonitoringApi postDatapoint POST /monitoring/metrics/{id}/datapoints Post a metric datapoint
MonitoringApi receiveEvent POST /monitoring/incidents Report an incident event
MonitoringApi updateAlert PUT /monitoring/alerts/{id} Update an existing alert
MonitoringApi updateMetric PUT /monitoring/metrics/{id} Update an existing metric
NotificationsApi createNotificationType POST /notifications/types Create a notification type
NotificationsApi deleteNotificationType DELETE /notifications/types/{id} Delete a notification type
NotificationsApi getNotificationType GET /notifications/types/{id} Get a single notification type
NotificationsApi getNotificationTypes GET /notifications/types List and search notification types
NotificationsApi getUserNotificationInfo GET /users/{user_id}/notifications/types/{type_id} View a user's notification settings for a type
NotificationsApi getUserNotificationInfoList GET /users/{user_id}/notifications/types View a user's notification settings
NotificationsApi getUserNotifications GET /users/{id}/notifications Get notifications
NotificationsApi sendNotification POST /notifications Send a notification
NotificationsApi setUserNotificationStatus PUT /users/{user_id}/notifications/{notification_id}/status Set notification status
NotificationsApi silenceDirectNotifications PUT /users/{user_id}/notifications/types/{type_id}/silenced Enable or disable direct notifications for a user
NotificationsApi updateNotificationType PUT /notifications/types/{id} Update a notificationType
ObjectsApi createObjectItem POST /objects/{template_id} Create an object
ObjectsApi createObjectTemplate POST /objects/templates Create an object template
ObjectsApi deleteObjectItem DELETE /objects/{template_id}/{object_id} Delete an object
ObjectsApi deleteObjectTemplate DELETE /objects/templates/{id} Delete an entitlement template
ObjectsApi getObjectItem GET /objects/{template_id}/{object_id} Get a single object
ObjectsApi getObjectItems GET /objects/{template_id} List and search objects
ObjectsApi getObjectTemplate GET /objects/templates/{id} Get a single entitlement template
ObjectsApi getObjectTemplates GET /objects/templates List and search entitlement templates
ObjectsApi updateObjectItem PUT /objects/{template_id}/{object_id} Update an object
ObjectsApi updateObjectTemplate PATCH /objects/templates/{id} Update an entitlement template
PaymentsApi createPaymentMethod POST /users/{user_id}/payment-methods Create a new payment method for a user
PaymentsApi deletePaymentMethod DELETE /users/{user_id}/payment-methods/{id} Delete an existing payment method for a user
PaymentsApi getPaymentMethod GET /users/{user_id}/payment-methods/{id} Get a single payment method for a user
PaymentsApi getPaymentMethodType GET /payment/types/{id} Get a single payment method type
PaymentsApi getPaymentMethodTypes GET /payment/types Get all payment method types
PaymentsApi getPaymentMethods GET /users/{user_id}/payment-methods Get all payment methods for a user
PaymentsApi paymentAuthorization POST /payment/authorizations Authorize payment of an invoice for later capture
PaymentsApi paymentCapture POST /payment/authorizations/{id}/capture Capture an existing invoice payment authorization
PaymentsApi updatePaymentMethod PUT /users/{user_id}/payment-methods/{id} Update an existing payment method for a user
PaymentsAppleApi verifyAppleReceipt POST /payment/provider/apple/receipt Pay invoice with Apple receipt
PaymentsFattMerchantApi createOrUpdateFattMerchantPaymentMethod PUT /payment/provider/fattmerchant/payment-methods Create or update a FattMerchant payment method for a user
PaymentsOptimalApi silentPostOptimal POST /payment/provider/optimal/silent Initiate silent post with Optimal
PaymentsPayPalClassicApi createPayPalBillingAgreementUrl POST /payment/provider/paypal/classic/agreements/start Create a PayPal Classic billing agreement for the user
PaymentsPayPalClassicApi createPayPalExpressCheckout POST /payment/provider/paypal/classic/checkout/start Create a payment token for PayPal express checkout
PaymentsPayPalClassicApi finalizePayPalBillingAgreement POST /payment/provider/paypal/classic/agreements/finish Finalizes a billing agreement after the user has accepted through PayPal
PaymentsPayPalClassicApi finalizePayPalCheckout POST /payment/provider/paypal/classic/checkout/finish Finalizes a payment after the user has completed checkout with PayPal
PaymentsStripeApi createStripePaymentMethod POST /payment/provider/stripe/payment-methods Create a Stripe payment method for a user
PaymentsStripeApi payStripeInvoice POST /payment/provider/stripe/payments Pay with a single use token
PaymentsTransactionsApi getTransaction GET /transactions/{id} Get the details for a single transaction
PaymentsTransactionsApi getTransactions GET /transactions List and search transactions
PaymentsTransactionsApi refundTransaction POST /transactions/{id}/refunds Refund a payment transaction, in full or in part
PaymentsWalletsApi getUserWallet GET /users/{user_id}/wallets/{currency_code} Returns the user's wallet for the given currency code
PaymentsWalletsApi getUserWalletTransactions GET /users/{user_id}/wallets/{currency_code}/transactions Retrieve a user's wallet transactions
PaymentsWalletsApi getUserWallets GET /users/{user_id}/wallets List all of a user's wallets
PaymentsWalletsApi getWalletBalances GET /wallets/totals Retrieves a summation of wallet balances by currency code
PaymentsWalletsApi getWalletTransactions GET /wallets/transactions Retrieve wallet transactions across the system
PaymentsWalletsApi getWallets GET /wallets Retrieve a list of wallets across the system
PaymentsWalletsApi updateWalletBalance PUT /users/{user_id}/wallets/{currency_code}/balance Updates the balance for a user's wallet
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
ReportingChallengesApi getChallengeEventLeaderboard GET /reporting/events/leaderboard Retrieve a challenge event leaderboard details
ReportingChallengesApi getChallengeEventParticipants GET /reporting/events/participants Retrieve a challenge event participant details
ReportingOrdersApi getInvoiceReports GET /reporting/orders/count/{currency_code} Retrieve invoice counts aggregated by time ranges
ReportingRevenueApi getItemRevenue GET /reporting/revenue/item-sales/{currency_code} Get item revenue info
ReportingRevenueApi getRefundRevenue GET /reporting/revenue/refunds/{currency_code} Get refund revenue info
ReportingRevenueApi getRevenueByCountry GET /reporting/revenue/countries/{currency_code} Get revenue info by country
ReportingRevenueApi getRevenueByItem GET /reporting/revenue/products/{currency_code} Get revenue info by item
ReportingRevenueApi getSubscriptionRevenue GET /reporting/revenue/subscription-sales/{currency_code} Get subscription revenue info
ReportingSubscriptionsApi getSubscriptionReports GET /reporting/subscription Get a list of available subscription reports in most recent first order
ReportingUsageApi getUsageByDay GET /reporting/usage/day Returns aggregated endpoint usage information by day
ReportingUsageApi getUsageByHour GET /reporting/usage/hour Returns aggregated endpoint usage information by hour
ReportingUsageApi getUsageByMinute GET /reporting/usage/minute Returns aggregated endpoint usage information by minute
ReportingUsageApi getUsageByMonth GET /reporting/usage/month Returns aggregated endpoint usage information by month
ReportingUsageApi getUsageByYear GET /reporting/usage/year Returns aggregated endpoint usage information by year
ReportingUsageApi getUsageEndpoints GET /reporting/usage/endpoints Returns list of endpoints called (method and url)
ReportingUsersApi getUserRegistrations GET /reporting/users/registrations Get user registration info
RuleEngineActionsApi getBREActions GET /bre/actions Get a list of available actions
RuleEngineEventsApi sendBREEvent POST /bre/events Fire a new event, based on an existing trigger
RuleEngineExpressionsApi getBREExpression GET /bre/expressions/{type} Lookup a specific expression
RuleEngineExpressionsApi getBREExpressions GET /bre/expressions Get a list of supported expressions to use in conditions or actions.
RuleEngineExpressionsApi getExpressionAsText POST /bre/expressions Returns the textual representation of an expression
RuleEngineGlobalsApi createBREGlobal POST /bre/globals/definitions Create a global definition
RuleEngineGlobalsApi deleteBREGlobal DELETE /bre/globals/definitions/{id} Delete a global
RuleEngineGlobalsApi getBREGlobal GET /bre/globals/definitions/{id} Get a single global definition
RuleEngineGlobalsApi getBREGlobals GET /bre/globals/definitions List global definitions
RuleEngineGlobalsApi updateBREGlobal PUT /bre/globals/definitions/{id} Update a global definition
RuleEngineRulesApi createBRERule POST /bre/rules Create a rule
RuleEngineRulesApi deleteBRERule DELETE /bre/rules/{id} Delete a rule
RuleEngineRulesApi getBREExpressionAsString POST /bre/rules/expression-as-string Returns a string representation of the provided expression
RuleEngineRulesApi getBRERule GET /bre/rules/{id} Get a single rule
RuleEngineRulesApi getBRERules GET /bre/rules List rules
RuleEngineRulesApi setBRERule PUT /bre/rules/{id}/enabled Enable or disable a rule
RuleEngineRulesApi updateBRERule PUT /bre/rules/{id} Update a rule
RuleEngineTriggersApi createBRETrigger POST /bre/triggers Create a trigger
RuleEngineTriggersApi deleteBRETrigger DELETE /bre/triggers/{event_name} Delete a trigger
RuleEngineTriggersApi getBRETrigger GET /bre/triggers/{event_name} Get a single trigger
RuleEngineTriggersApi getBRETriggers GET /bre/triggers List triggers
RuleEngineTriggersApi updateBRETrigger PUT /bre/triggers/{event_name} Update a trigger
RuleEngineVariablesApi getBREVariableTypes GET /bre/variable-types Get a list of variable types available
RuleEngineVariablesApi getBREVariableValues GET /bre/variable-types/{name}/values List valid values for a type
SearchApi indexDocument POST /search/documents Adds a document to be indexed. For system use only.
SearchApi reindexAll POST /search/reindex Triggers a full re-indexing of all documents of the specified type. For system use only.
SearchApi removeDocument DELETE /search/documents Remove a document from the index. For system use only.
SearchApi searchCountGET GET /search/count/{type} Count matches with no template
SearchApi searchCountPOST POST /search/count/{type} Count matches with no template
SearchApi searchDocumentGET GET /search/documents/{type}/{id} Get document with no template
SearchApi searchExplainGET GET /search/explain/{type}/{id} Explain matches with no template
SearchApi searchExplainPOST POST /search/explain/{type}/{id} Explain matches with no template
SearchApi searchIndex POST /search/index/{type} Search an index with no template
SearchApi searchIndexGET GET /search/index/{type} Search an index with no template
SearchApi searchIndicesGET GET /search/indices Get indices
SearchApi searchMappingsGET GET /search/mappings/{type} Get mapping with no template
SearchApi searchPublicIndex POST /search/public/{type} Search public index with no template
SearchApi searchValidateGET GET /search/validate/{type} Validate matches with no template
SearchApi searchValidatePOST POST /search/validate/{type} Validate matches with no template
SocialFacebookApi linkAccounts POST /social/facebook/users Link facebook account
SocialGoogleApi linkAccounts1 POST /social/google/users Link google account
StoreApi createItemTemplate POST /store/items/templates Create an item template
StoreApi createStoreItem POST /store/items Create a store item
StoreApi deleteItemTemplate DELETE /store/items/templates/{id} Delete an item template
StoreApi deleteStoreItem DELETE /store/items/{id} Delete a store item
StoreApi getBehaviors GET /store/items/behaviors List available item behaviors
StoreApi getItemTemplate GET /store/items/templates/{id} Get a single item template
StoreApi getItemTemplates GET /store/items/templates List and search item templates
StoreApi getStoreItem GET /store/items/{id} Get a single store item
StoreApi getStoreItems GET /store/items List and search store items
StoreApi quickBuy POST /store/quick-buy One-step purchase and pay for a single SKU item from a user's wallet
StoreApi quickNew POST /store/quick-new One-step invoice creation
StoreApi quickPaid POST /store/quick-paid One-step purchase when already paid
StoreApi quickProcessing POST /store/quick-processing One-step invoice creation when already processing
StoreApi updateItemTemplate PATCH /store/items/templates/{id} Update an item template
StoreApi updateStoreItem PUT /store/items/{id} Update a store item
StoreBundlesApi createBundleItem POST /store/bundles Create a bundle item
StoreBundlesApi createBundleTemplate POST /store/bundles/templates Create a bundle template
StoreBundlesApi deleteBundleItem DELETE /store/bundles/{id} Delete a bundle item
StoreBundlesApi deleteBundleTemplate DELETE /store/bundles/templates/{id} Delete a bundle template
StoreBundlesApi getBundleItem GET /store/bundles/{id} Get a single bundle item
StoreBundlesApi getBundleTemplate GET /store/bundles/templates/{id} Get a single bundle template
StoreBundlesApi getBundleTemplates GET /store/bundles/templates List and search bundle templates
StoreBundlesApi updateBundleItem PUT /store/bundles/{id} Update a bundle item
StoreBundlesApi updateBundleTemplate PATCH /store/bundles/templates/{id} Update a bundle template
StoreCouponsApi createCouponItem POST /store/coupons Create a coupon item
StoreCouponsApi createCouponTemplate POST /store/coupons/templates Create a coupon template
StoreCouponsApi deleteCouponItem DELETE /store/coupons/{id} Delete a coupon item
StoreCouponsApi deleteCouponTemplate DELETE /store/coupons/templates/{id} Delete a coupon template
StoreCouponsApi getCouponItem GET /store/coupons/{id} Get a single coupon item
StoreCouponsApi getCouponItemBySku GET /store/coupons/skus/{sku} Get a coupon by sku
StoreCouponsApi getCouponTemplate GET /store/coupons/templates/{id} Get a single coupon template
StoreCouponsApi getCouponTemplates GET /store/coupons/templates List and search coupon templates
StoreCouponsApi updateCouponItem PUT /store/coupons/{id} Update a coupon item
StoreCouponsApi updateCouponTemplate PATCH /store/coupons/templates/{id} Update a coupon template
StoreSalesApi createCatalogSale POST /store/sales Create a sale
StoreSalesApi deleteCatalogSale DELETE /store/sales/{id} Delete a sale
StoreSalesApi getCatalogSale GET /store/sales/{id} Get a single sale
StoreSalesApi getCatalogSales GET /store/sales List and search sales
StoreSalesApi updateCatalogSale PUT /store/sales/{id} Update a sale
StoreShippingApi createShippingItem POST /store/shipping Create a shipping item
StoreShippingApi createShippingTemplate POST /store/shipping/templates Create a shipping template
StoreShippingApi deleteShippingItem DELETE /store/shipping/{id} Delete a shipping item
StoreShippingApi deleteShippingTemplate DELETE /store/shipping/templates/{id} Delete a shipping template
StoreShippingApi getShippingItem GET /store/shipping/{id} Get a single shipping item
StoreShippingApi getShippingTemplate GET /store/shipping/templates/{id} Get a single shipping template
StoreShippingApi getShippingTemplates GET /store/shipping/templates List and search shipping templates
StoreShippingApi updateShippingItem PUT /store/shipping/{id} Update a shipping item
StoreShippingApi updateShippingTemplate PATCH /store/shipping/templates/{id} Update a shipping template
StoreShoppingCartsApi addCustomDiscount POST /carts/{id}/custom-discounts Adds a custom discount to the cart
StoreShoppingCartsApi addDiscountToCart POST /carts/{id}/discounts Adds a discount coupon to the cart
StoreShoppingCartsApi addItemToCart POST /carts/{id}/items Add an item to the cart
StoreShoppingCartsApi createCart POST /carts Create a cart
StoreShoppingCartsApi getCart GET /carts/{id} Returns the cart with the given GUID
StoreShoppingCartsApi getCarts GET /carts Get a list of carts
StoreShoppingCartsApi getShippable GET /carts/{id}/shippable Returns whether a cart requires shipping
StoreShoppingCartsApi getShippingCountries GET /carts/{id}/countries Get the list of available shipping countries per vendor
StoreShoppingCartsApi removeDiscountFromCart DELETE /carts/{id}/discounts/{code} Removes a discount coupon from the cart
StoreShoppingCartsApi setCartCurrency PUT /carts/{id}/currency Sets the currency to use for the cart
StoreShoppingCartsApi setCartOwner PUT /carts/{id}/owner Sets the owner of a cart if none is set already
StoreShoppingCartsApi updateItemInCart PUT /carts/{id}/items Changes the quantity of an item already in the cart
StoreShoppingCartsApi updateShippingAddress PUT /carts/{id}/shipping-address Modifies or sets the order shipping address
StoreSubscriptionsApi createSubscription POST /subscriptions Creates a subscription item and associated plans
StoreSubscriptionsApi createSubscriptionTemplate POST /subscriptions/templates Create a subscription template
StoreSubscriptionsApi deleteSubscription DELETE /subscriptions/{id}/plans/{plan_id} Delete a subscription plan
StoreSubscriptionsApi deleteSubscriptionTemplate DELETE /subscriptions/templates/{id} Delete a subscription template
StoreSubscriptionsApi getSubscription GET /subscriptions/{id} Retrieve a single subscription item and associated plans
StoreSubscriptionsApi getSubscriptionTemplate GET /subscriptions/templates/{id} Get a single subscription template
StoreSubscriptionsApi getSubscriptionTemplates GET /subscriptions/templates List and search subscription templates
StoreSubscriptionsApi getSubscriptions GET /subscriptions List available subscription items and associated plans
StoreSubscriptionsApi processSubscriptions POST /subscriptions/process Processes subscriptions and charge dues
StoreSubscriptionsApi updateSubscription PUT /subscriptions/{id} Updates a subscription item and associated plans
StoreSubscriptionsApi updateSubscriptionTemplate PATCH /subscriptions/templates/{id} Update a subscription template
StoreVendorsApi createVendor POST /vendors Create a vendor
StoreVendorsApi createVendorTemplate POST /vendors/templates Create a vendor template
StoreVendorsApi deleteVendor DELETE /vendors/{id} Delete a vendor
StoreVendorsApi deleteVendorTemplate DELETE /vendors/templates/{id} Delete a vendor template
StoreVendorsApi getVendor GET /vendors/{id} Get a single vendor
StoreVendorsApi getVendorTemplate GET /vendors/templates/{id} Get a single vendor template
StoreVendorsApi getVendorTemplates GET /vendors/templates List and search vendor templates
StoreVendorsApi getVendors GET /vendors List and search vendors
StoreVendorsApi updateVendor PUT /vendors/{id} Update a vendor
StoreVendorsApi updateVendorTemplate PATCH /vendors/templates/{id} Update a vendor template
TaxesApi createCountryTax POST /tax/countries Create a country tax
TaxesApi createStateTax POST /tax/countries/{country_code_iso3}/states Create a state tax
TaxesApi deleteCountryTax DELETE /tax/countries/{country_code_iso3} Delete an existing tax
TaxesApi deleteStateTax DELETE /tax/countries/{country_code_iso3}/states/{state_code} Delete an existing state tax
TaxesApi getCountryTax GET /tax/countries/{country_code_iso3} Get a single tax
TaxesApi getCountryTaxes GET /tax/countries List and search taxes
TaxesApi getStateTax GET /tax/countries/{country_code_iso3}/states/{state_code} Get a single state tax
TaxesApi getStateTaxesForCountries GET /tax/states List and search taxes across all countries
TaxesApi getStateTaxesForCountry GET /tax/countries/{country_code_iso3}/states List and search taxes within a country
TaxesApi updateCountryTax PUT /tax/countries/{country_code_iso3} Create or update a tax
TaxesApi updateStateTax PUT /tax/countries/{country_code_iso3}/states/{state_code} Create or update a state tax
TemplatesApi createTemplate POST /templates/{type_hint} Create a template
TemplatesApi deleteTemplate DELETE /templates/{type_hint}/{id} Delete a template
TemplatesApi getTemplate GET /templates/{type_hint}/{id} Get a template
TemplatesApi getTemplates GET /templates/{type_hint} List and search templates
TemplatesApi patchTemplate PATCH /templates/{type_hint}/{id} Patch a template
TemplatesApi validate POST /templates/{type_hint}/validate Validate a templated resource
TemplatesPropertiesApi getTemplatePropertyType GET /templates/properties/{type} Get details for a template property type
TemplatesPropertiesApi getTemplatePropertyTypes GET /templates/properties List template property types
UsersApi addUserTag POST /users/{user_id}/tags Add a tag to a user
UsersApi createUserTemplate POST /users/templates Create a user template
UsersApi deleteUserTemplate DELETE /users/templates/{id} Delete a user template
UsersApi getDirectMessages1 GET /users/{recipient_id}/messages Get a list of direct messages with this user
UsersApi getUser GET /users/{id} Get a single user
UsersApi getUserTags GET /users/{user_id}/tags List tags for a user
UsersApi getUserTemplate GET /users/templates/{id} Get a single user template
UsersApi getUserTemplates GET /users/templates List and search user templates
UsersApi getUsers GET /users List and search users
UsersApi passwordReset PUT /users/{id}/password-reset Choose a new password after a reset
UsersApi postUserMessage POST /users/{recipient_id}/messages Send a user message
UsersApi registerUser POST /users Register a new user
UsersApi registerUserCuentas POST /users/cuentas Register a new cuentas user
UsersApi removeUserTag DELETE /users/{user_id}/tags/{tag} Remove a tag from a user
UsersApi setPassword PUT /users/{id}/password Set a user's password
UsersApi startPasswordReset POST /users/{id}/password-reset Reset a user's password
UsersApi submitPasswordReset POST /users/password-reset Reset a user's password without user id
UsersApi updateUser PUT /users/{id} Update a user
UsersApi updateUserTemplate PATCH /users/templates/{id} Update a user template
UsersAddressesApi createAddress POST /users/{user_id}/addresses Create a new address
UsersAddressesApi deleteAddress DELETE /users/{user_id}/addresses/{id} Delete an address
UsersAddressesApi getAddress GET /users/{user_id}/addresses/{id} Get a single address
UsersAddressesApi getAddresses GET /users/{user_id}/addresses List and search addresses
UsersAddressesApi updateAddress PUT /users/{user_id}/addresses/{id} Update an address
UsersFriendshipsApi addFriend POST /users/{user_id}/friends/{id} Add a friend
UsersFriendshipsApi getFriends GET /users/{user_id}/friends Get friends list
UsersFriendshipsApi getInviteToken GET /users/{user_id}/invite-token Returns the invite token
UsersFriendshipsApi getInvites GET /users/{user_id}/invites Get pending invites
UsersFriendshipsApi redeemFriendshipToken POST /users/{user_id}/friends/tokens Redeem friendship token
UsersFriendshipsApi removeOrDeclineFriend DELETE /users/{user_id}/friends/{id} Remove or decline a friend
UsersGroupsApi addMemberToGroup POST /users/groups/{unique_name}/members Adds a new member to the group
UsersGroupsApi addMembersToGroup POST /users/groups/{unique_name}/members/batch-add Adds multiple members to the group
UsersGroupsApi createGroup POST /users/groups Create a group
UsersGroupsApi createGroupMemberTemplate POST /users/groups/members/templates Create a group member template
UsersGroupsApi createGroupTemplate POST /users/groups/templates Create a group template
UsersGroupsApi deleteGroup DELETE /users/groups/{unique_name} Removes a group from the system
UsersGroupsApi deleteGroupMemberTemplate DELETE /users/groups/members/templates/{id} Delete a group member template
UsersGroupsApi deleteGroupTemplate DELETE /users/groups/templates/{id} Delete a group template
UsersGroupsApi disableGroupNotification PUT /users/groups/{unique_name}/members/{user_id}/messages/disabled Enable or disable notification of group messages
UsersGroupsApi getGroup GET /users/groups/{unique_name} Loads a specific group's details
UsersGroupsApi getGroupAncestors GET /users/groups/{unique_name}/ancestors Get group ancestors
UsersGroupsApi getGroupMember GET /users/groups/{unique_name}/members/{user_id} Get a user from a group
UsersGroupsApi getGroupMemberTemplate GET /users/groups/members/templates/{id} Get a single group member template
UsersGroupsApi getGroupMemberTemplates GET /users/groups/members/templates List and search group member templates
UsersGroupsApi getGroupMembers GET /users/groups/{unique_name}/members Lists members of the group
UsersGroupsApi getGroupMessages GET /users/groups/{unique_name}/messages Get a list of group messages
UsersGroupsApi getGroupTemplate GET /users/groups/templates/{id} Get a single group template
UsersGroupsApi getGroupTemplates GET /users/groups/templates List and search group templates
UsersGroupsApi getGroupsForUser GET /users/{user_id}/groups List groups a user is in
UsersGroupsApi inviteToGroup POST /users/groups/{unique_name}/invite Invite to group
UsersGroupsApi listGroups GET /users/groups List and search groups
UsersGroupsApi postGroupMessage POST /users/groups/{unique_name}/messages Send a group message
UsersGroupsApi removeGroupMember DELETE /users/groups/{unique_name}/members/{user_id} Removes a user from a group
UsersGroupsApi updateGroup PUT /users/groups/{unique_name} Update a group
UsersGroupsApi updateGroupMemberOrder PUT /users/groups/{unique_name}/members/{user_id}/order Change a user's order
UsersGroupsApi updateGroupMemberProperties PUT /users/groups/{unique_name}/members/{user_id}/properties Change a user's membership properties
UsersGroupsApi updateGroupMemberStatus PUT /users/groups/{unique_name}/members/{user_id}/status Change a user's status
UsersGroupsApi updateGroupMemberTemplate PATCH /users/groups/members/templates/{id} Update a group member template
UsersGroupsApi updateGroupTemplate PATCH /users/groups/templates/{id} Update a group template
UsersInventoryApi addItemToUserInventory POST /users/{id}/inventory Adds an item to the user inventory
UsersInventoryApi checkUserEntitlementItem GET /users/{user_id}/entitlements/{item_id}/check Check for access to an item without consuming
UsersInventoryApi createEntitlementItem POST /entitlements Create an entitlement item
UsersInventoryApi createEntitlementTemplate POST /entitlements/templates Create an entitlement template
UsersInventoryApi deleteEntitlementItem DELETE /entitlements/{entitlement_id} Delete an entitlement item
UsersInventoryApi deleteEntitlementTemplate DELETE /entitlements/templates/{id} Delete an entitlement template
UsersInventoryApi getEntitlementItem GET /entitlements/{entitlement_id} Get a single entitlement item
UsersInventoryApi getEntitlementItems GET /entitlements List and search entitlement items
UsersInventoryApi getEntitlementTemplate GET /entitlements/templates/{id} Get a single entitlement template
UsersInventoryApi getEntitlementTemplates GET /entitlements/templates List and search entitlement templates
UsersInventoryApi getInventoryList GET /inventories List the user inventory entries for all users
UsersInventoryApi getUserInventories GET /users/{id}/inventory List the user inventory entries for a given user
UsersInventoryApi getUserInventory GET /users/{user_id}/inventory/{id} Get an inventory entry
UsersInventoryApi getUserInventoryLog GET /users/{user_id}/inventory/{id}/log List the log entries for this inventory entry
UsersInventoryApi grantUserEntitlement POST /users/{user_id}/entitlements Grant an entitlement
UsersInventoryApi updateEntitlementItem PUT /entitlements/{entitlement_id} Update an entitlement item
UsersInventoryApi updateEntitlementTemplate PATCH /entitlements/templates/{id} Update an entitlement template
UsersInventoryApi updateUserInventoryBehaviorData PUT /users/{user_id}/inventory/{id}/behavior-data Set the behavior data for an inventory entry
UsersInventoryApi updateUserInventoryExpires PUT /users/{user_id}/inventory/{id}/expires Set the expiration date
UsersInventoryApi updateUserInventoryStatus PUT /users/{user_id}/inventory/{id}/status Set the status for an inventory entry
UsersInventoryApi useUserEntitlementItem POST /users/{user_id}/entitlements/{item_id}/use Use an item
UsersRelationshipsApi createUserRelationship POST /users/relationships Create a user relationship
UsersRelationshipsApi deleteUserRelationship DELETE /users/relationships/{id} Delete a user relationship
UsersRelationshipsApi getRelationship GET /users/relationships/{id} Get a user relationship
UsersRelationshipsApi getUserRelationships GET /users/relationships Get a list of user relationships
UsersRelationshipsApi updateUserRelationship PUT /users/relationships/{id} Update a user relationship
UsersSubscriptionsApi getUserSubscriptionDetails GET /users/{user_id}/subscriptions/{inventory_id} Get details about a user's subscription
UsersSubscriptionsApi getUsersSubscriptionDetails GET /users/{user_id}/subscriptions Get details about a user's subscriptions
UsersSubscriptionsApi reactivateUserSubscription POST /users/{user_id}/subscriptions/{inventory_id}/reactivate Reactivate a subscription and charge fee
UsersSubscriptionsApi setSubscriptionBillDate PUT /users/{user_id}/subscriptions/{inventory_id}/bill-date Set a new date to bill a subscription on
UsersSubscriptionsApi setSubscriptionPaymentMethod PUT /users/{user_id}/subscriptions/{inventory_id}/payment-method Set the payment method to use for a subscription
UsersSubscriptionsApi setSubscriptionStatus PUT /users/{user_id}/subscriptions/{inventory_id}/status Set the status of a subscription
UsersSubscriptionsApi setUserSubscriptionPlan PUT /users/{user_id}/subscriptions/{inventory_id}/plan Set a new subscription plan for a user
UsersSubscriptionsApi setUserSubscriptionPrice PUT /users/{user_id}/subscriptions/{inventory_id}/price-override Set a new subscription price for a user
UtilBatchApi getBatch GET /batch/{token} Get batch result with token
UtilBatchApi sendBatch POST /batch Request to run API call given the method, content type, path url, and body of request
UtilHealthApi getHealth GET /health Get health info
UtilMaintenanceApi deleteMaintenance DELETE /maintenance Delete maintenance info
UtilMaintenanceApi getMaintenance GET /maintenance Get current maintenance info
UtilMaintenanceApi setMaintenance POST /maintenance Set current maintenance info
UtilSecurityApi getUserLocationLog GET /security/country-log Returns the authentication log for a user
UtilSecurityApi getUserTokenDetails GET /me Returns the authentication token details. Use /users endpoint for detailed user's info
UtilVersionApi getVersion GET /version Get current version info
VerificationApi createRequestTemplate POST /verification/templates Create a request template
VerificationApi createVerificationRequest POST /verification/requests Create a new request
VerificationApi deleteRequestTemplate DELETE /verification/templates/{id} Delete a request template
VerificationApi deleteVerificationRequest DELETE /verification/requests/{code} Delete an existing request
VerificationApi getRequestTemplate GET /verification/templates/{id} Get a single request template
VerificationApi getRequestTemplates GET /verification/templates List and search request templates
VerificationApi getVerificationRequest GET /verification/requests/{code} Get a single verification request
VerificationApi getVerificationRequests GET /verification/requests List requests
VerificationApi updateRequestTemplate PATCH /verification/templates/{id} Update a request template
VerificationApi updateVerificationRequest PUT /verification/requests/{code} Update an existing request
VerificationApi verifyRequest POST /verification/requests/{code}/responses Verify a request

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

support@knetik.com

About

Java SDK for connecting to KnetikCloud. Visit knetikcloud.com or spawnpoint.com for details.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

4 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages