Skip to content

knetikmedia/knetikcloud-csharp-net35-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits

.swagger-codegen

.swagger-codegen

 
 

docs

docs

 
 

src

src

 
 

.gitignore

.gitignore

 
 

.swagger-codegen-ignore

.swagger-codegen-ignore

 
 

.travis.yml

.travis.yml

 
 

README.md

README.md

 
 

build.bat

build.bat

 
 

build.sh

build.sh

 
 

com.knetikcloud.sln

com.knetikcloud.sln

 
 

git_push.sh

git_push.sh

 
 

mono_nunit_test.sh

mono_nunit_test.sh

 
 

Repository files navigation

com.knetikcloud - the C# library for the Knetik Platform API Documentation latest

This is the spec for the Knetik API. Use this in conjunction with the documentation found at https://knetikcloud.com.

This C# SDK is automatically generated by the Swagger Codegen project:

  • API version: latest
  • SDK version: 1.0.0
  • Build package: io.swagger.codegen.languages.CSharpClientCodegen For more information, please visit http://www.knetik.com

Frameworks supported

  • .NET 4.0 or later
  • Windows Phone 7.1 (Mango)

Dependencies

The DLLs included in the package may not be the latest version. We recommend using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using com.knetikcloud.Api;
using com.knetikcloud.Client;
using com.knetikcloud.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out com.knetikcloud.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

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.

using System;
using System.Diagnostics;
using com.knetikcloud.Api;
using com.knetikcloud.Client;
using com.knetikcloud.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {

            var apiInstance = new Access_TokenApi();
            var grantType = grantType_example;  // string | Grant type (default to client_credentials)
            var clientId = clientId_example;  // string | The id of the client (default to knetik)
            var clientSecret = clientSecret_example;  // string | The secret key of the client.  Used only with a grant_type of client_credentials (optional) 
            var username = username_example;  // string | The username of the client. Used only with a grant_type of password (optional) 
            var password = password_example;  // string | The password of the client. Used only with a grant_type of password (optional) 
            var token = token_example;  // string | The 3rd party authentication token. Used only with a grant_type of facebook, google, etc (social plugins) (optional) 
            var refreshToken = refreshToken_example;  // string | The refresh token obtained during prior authentication. Used only with a grant_type of refresh_token (optional) 

            try
            {
                // Get access token
                OAuth2Resource result = apiInstance.GetOAuthToken(grantType, clientId, clientSecret, username, password, token, refreshToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Access_TokenApi.GetOAuthToken: " + e.Message );
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://jsapi-integration.us-east-1.elasticbeanstalk.com

Class Method HTTP request Description
Access_TokenApi 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 a activity template
ActivitiesApi DeleteActivity DELETE /activities/{id} Delete an activity
ActivitiesApi DeleteActivityTemplate DELETE /activities/templates/{id} Delete a 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 PUT /activities/templates/{id} Update an activity template
Amazon_Web_Services_S3Api GetDownloadURL GET /amazon/s3/downloadurl Get a temporary signed S3 URL for download
Amazon_Web_Services_S3Api GetSignedS3URL GET /amazon/s3/signedposturl Get a signed S3 URL for upload
Auth_ClientsApi CreateClient POST /auth/clients Create a new client
Auth_ClientsApi DeleteClient DELETE /auth/clients/{client_key} Delete a client
Auth_ClientsApi GetClient GET /auth/clients/{client_key} Get a single client
Auth_ClientsApi GetClientGrantTypes GET /auth/clients/grant-types List available client grant types
Auth_ClientsApi GetClients GET /auth/clients List and search clients
Auth_ClientsApi SetClientGrantTypes PUT /auth/clients/{client_key}/grant-types Set grant types for a client
Auth_ClientsApi SetClientRedirectUris PUT /auth/clients/{client_key}/redirect-uris Set redirect uris for a client
Auth_ClientsApi UpdateClient PUT /auth/clients/{client_key} Update a client
Auth_PermissionsApi CreatePermission POST /auth/permissions Create a new permission
Auth_PermissionsApi DeletePermission DELETE /auth/permissions/{permission} Delete a permission
Auth_PermissionsApi GetPermission GET /auth/permissions/{permission} Get a single permission
Auth_PermissionsApi GetPermissions GET /auth/permissions List and search permissions
Auth_PermissionsApi UpdatePermission PUT /auth/permissions/{permission} Update a permission
Auth_RolesApi CreateRole POST /auth/roles Create a new role
Auth_RolesApi DeleteRole DELETE /auth/roles/{role} Delete a role
Auth_RolesApi GetClientRoles GET /auth/clients/{client_key}/roles Get roles for a client
Auth_RolesApi GetRole GET /auth/roles/{role} Get a single role
Auth_RolesApi GetRoles GET /auth/roles List and search roles
Auth_RolesApi GetUserRoles GET /auth/users/{user_id}/roles Get roles for a user
Auth_RolesApi SetClientRoles PUT /auth/clients/{client_key}/roles Set roles for a client
Auth_RolesApi SetPermissionsForRole PUT /auth/roles/{role}/permissions Set permissions for a role
Auth_RolesApi SetUserRoles PUT /auth/users/{user_id}/roles Set roles for a user
Auth_RolesApi UpdateRole PUT /auth/roles/{role} Update a role
Auth_TokensApi DeleteTokens DELETE /auth/tokens Delete tokens by username, client id, or both
Auth_TokensApi GetToken GET /auth/tokens/{username}/{client_id} Get a single token by username and client id
Auth_TokensApi GetTokens GET /auth/tokens List usernames and client ids
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 PUT /campaigns/templates/{id} Update an campaign template
Campaigns_ChallengesApi CreateChallenge POST /challenges Create a challenge
Campaigns_ChallengesApi CreateChallengeActivity POST /challenges/{challenge_id}/activities Create a challenge activity
Campaigns_ChallengesApi CreateChallengeActivityTemplate POST /challenge-activities/templates Create a challenge activity template
Campaigns_ChallengesApi CreateChallengeTemplate POST /challenges/templates Create a challenge template
Campaigns_ChallengesApi DeleteChallenge DELETE /challenges/{id} Delete a challenge
Campaigns_ChallengesApi DeleteChallengeActivity DELETE /challenges/{challenge_id}/activities/{id} Delete a challenge activity
Campaigns_ChallengesApi DeleteChallengeActivityTemplate DELETE /challenge-activities/templates/{id} Delete a challenge activity template
Campaigns_ChallengesApi DeleteChallengeEvent DELETE /challenges/events/{id} Delete a challenge event
Campaigns_ChallengesApi DeleteChallengeTemplate DELETE /challenges/templates/{id} Delete a challenge template
Campaigns_ChallengesApi GetChallenge GET /challenges/{id} Retrieve a challenge
Campaigns_ChallengesApi GetChallengeActivities GET /challenges/{challenge_id}/activities List and search challenge activities
Campaigns_ChallengesApi GetChallengeActivity GET /challenges/{challenge_id}/activities/{id} Get a single challenge activity
Campaigns_ChallengesApi GetChallengeActivityTemplate GET /challenge-activities/templates/{id} Get a single challenge activity template
Campaigns_ChallengesApi GetChallengeActivityTemplates GET /challenge-activities/templates List and search challenge activity templates
Campaigns_ChallengesApi GetChallengeEvent GET /challenges/events/{id} Retrieve a single challenge event details
Campaigns_ChallengesApi GetChallengeEvents GET /challenges/events Retrieve a list of challenge events
Campaigns_ChallengesApi GetChallengeTemplate GET /challenges/templates/{id} Get a single challenge template
Campaigns_ChallengesApi GetChallengeTemplates GET /challenges/templates List and search challenge templates
Campaigns_ChallengesApi GetChallenges GET /challenges Retrieve a list of challenges
Campaigns_ChallengesApi UpdateChallenge PUT /challenges/{id} Update a challenge
Campaigns_ChallengesApi UpdateChallengeActivity PUT /challenges/{challenge_id}/activities/{id} Update a challenge activity
Campaigns_ChallengesApi UpdateChallengeActivityTemplate PUT /challenge-activities/templates/{id} Update an challenge activity template
Campaigns_ChallengesApi UpdateChallengeTemplate PUT /challenges/templates/{id} Update a challenge template
Campaigns_RewardsApi CreateRewardSet POST /rewards Create a reward set
Campaigns_RewardsApi DeleteRewardSet DELETE /rewards/{id} Delete a reward set
Campaigns_RewardsApi GetRewardSet GET /rewards/{id} Get a single reward set
Campaigns_RewardsApi GetRewardSets GET /rewards List and search reward sets
Campaigns_RewardsApi 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 PUT /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
Content_ArticlesApi CreateArticle POST /content/articles Create a new article
Content_ArticlesApi CreateArticleTemplate POST /content/articles/templates Create an article template
Content_ArticlesApi CreateTemplate POST /templates/{type_hint} Create a template
Content_ArticlesApi DeleteArticle DELETE /content/articles/{id} Delete an existing article
Content_ArticlesApi DeleteArticleTemplate DELETE /content/articles/templates/{id} Delete an article template
Content_ArticlesApi DeleteTemplate DELETE /templates/{type_hint}/{id} Delete a template
Content_ArticlesApi GetArticle GET /content/articles/{id} Get a single article
Content_ArticlesApi GetArticleTemplate GET /content/articles/templates/{id} Get a single article template
Content_ArticlesApi GetArticleTemplates GET /content/articles/templates List and search article templates
Content_ArticlesApi GetArticles GET /content/articles List and search articles
Content_ArticlesApi GetTemplate GET /templates/{type_hint}/{id} Get a template
Content_ArticlesApi GetTemplates GET /templates/{type_hint} List and search templates
Content_ArticlesApi UpdateArticle PUT /content/articles/{id} Update an existing article
Content_ArticlesApi UpdateArticleTemplate PUT /content/articles/templates/{id} Update an article template
Content_ArticlesApi UpdateTemplate PUT /templates/{type_hint}/{id} Update a template
Content_ArticlesApi Validate POST /templates/{type_hint}/validate Validate a templated resource
Content_CommentsApi AddComment POST /comments Add a new comment
Content_CommentsApi DeleteComment DELETE /comments/{id} Delete a comment
Content_CommentsApi GetComment GET /comments/{id} Return a comment
Content_CommentsApi GetComments GET /comments Returns a page of comments
Content_CommentsApi 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 AddDeviceUsers 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 PUT /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
Gamification_AchievementsApi CreateAchievement POST /achievements Create a new achievement definition
Gamification_AchievementsApi CreateAchievementTemplate POST /achievements/templates Create an achievement template
Gamification_AchievementsApi DeleteAchievement DELETE /achievements/{name} Delete an achievement definition
Gamification_AchievementsApi DeleteAchievementTemplate DELETE /achievements/templates/{id} Delete an achievement template
Gamification_AchievementsApi GetAchievement GET /achievements/{name} Get a single achievement definition
Gamification_AchievementsApi GetAchievementTemplate GET /achievements/templates/{id} Get a single achievement template
Gamification_AchievementsApi GetAchievementTemplates GET /achievements/templates List and search achievement templates
Gamification_AchievementsApi GetAchievementTriggers GET /achievements/triggers Get the list of triggers that can be used to trigger an achievement progress update
Gamification_AchievementsApi GetAchievements GET /achievements Get all achievement definitions in the system
Gamification_AchievementsApi GetDerivedAchievements GET /achievements/derived/{name} Get a list of derived achievements
Gamification_AchievementsApi GetUserAchievementProgress GET /users/{user_id}/achievements/{achievement_name} Retrieve progress on a given achievement for a given user
Gamification_AchievementsApi GetUserAchievementsProgress GET /users/{user_id}/achievements Retrieve progress on achievements for a given user
Gamification_AchievementsApi GetUsersAchievementProgress GET /users/achievements/{achievement_name} Retrieve progress on a given achievement for all users
Gamification_AchievementsApi GetUsersAchievementsProgress GET /users/achievements Retrieve progress on achievements for all users
Gamification_AchievementsApi IncrementAchievementProgress POST /users/{user_id}/achievements/{achievement_name}/progress Increment an achievement progress record for a user
Gamification_AchievementsApi SetAchievementProgress PUT /users/{user_id}/achievements/{achievement_name}/progress Set an achievement progress record for a user
Gamification_AchievementsApi UpdateAchievement PUT /achievements/{name} Update an achievement definition
Gamification_AchievementsApi UpdateAchievementTemplate PUT /achievements/templates/{id} Update an achievement template
Gamification_LeaderboardsApi GetLeaderboard GET /leaderboards/{context_type}/{context_id} Retrieves leaderboard details and paginated entries
Gamification_LeaderboardsApi GetLeaderboardRank GET /leaderboards/{context_type}/{context_id}/users/{id}/rank Retrieves a specific user entry with rank
Gamification_LeaderboardsApi GetLeaderboardStrategies GET /leaderboards/strategies Get a list of available leaderboard strategy names
Gamification_LevelingApi CreateLevel POST /leveling Create a level schema
Gamification_LevelingApi DeleteLevel DELETE /leveling/{name} Delete a level
Gamification_LevelingApi GetLevel GET /leveling/{name} Retrieve a level
Gamification_LevelingApi GetLevelTriggers GET /leveling/triggers Get the list of triggers that can be used to trigger a leveling progress update
Gamification_LevelingApi GetLevels GET /leveling List and search levels
Gamification_LevelingApi GetUserLevel GET /users/{user_id}/leveling/{name} Get a user's progress for a given level schema
Gamification_LevelingApi GetUserLevels GET /users/{user_id}/leveling Get a user's progress for all level schemas
Gamification_LevelingApi IncrementProgress POST /users/{user_id}/leveling/{name}/progress Update or create a leveling progress record for a user
Gamification_LevelingApi SetProgress PUT /users/{user_id}/leveling/{name}/progress Set leveling progress for a user
Gamification_LevelingApi UpdateLevel PUT /leveling/{name} Update a level
Gamification_MetricsApi AddMetric POST /metrics Add a metric
Gamification_TriviaApi AddQuestionAnswers POST /trivia/questions/{question_id}/answers Add an answer to a question
Gamification_TriviaApi AddQuestionTag POST /trivia/questions/{id}/tags Add a tag to a question
Gamification_TriviaApi AddTagToQuestionsBatch POST /trivia/questions/tags Add a tag to a batch of questions
Gamification_TriviaApi CreateImportJob POST /trivia/import Create an import job
Gamification_TriviaApi CreateQuestion POST /trivia/questions Create a question
Gamification_TriviaApi CreateQuestionTemplate POST /trivia/questions/templates Create a question template
Gamification_TriviaApi DeleteImportJob DELETE /trivia/import/{id} Delete an import job
Gamification_TriviaApi DeleteQuestion DELETE /trivia/questions/{id} Delete a question
Gamification_TriviaApi DeleteQuestionAnswers DELETE /trivia/questions/{question_id}/answers/{id} Remove an answer from a question
Gamification_TriviaApi DeleteQuestionTemplate DELETE /trivia/questions/templates/{id} Delete a question template
Gamification_TriviaApi GetImportJob GET /trivia/import/{id} Get an import job
Gamification_TriviaApi GetImportJobs GET /trivia/import Get a list of import job
Gamification_TriviaApi GetQuestion GET /trivia/questions/{id} Get a single question
Gamification_TriviaApi GetQuestionAnswer GET /trivia/questions/{question_id}/answers/{id} Get an answer for a question
Gamification_TriviaApi GetQuestionAnswers GET /trivia/questions/{question_id}/answers List the answers available for a question
Gamification_TriviaApi GetQuestionDeltas GET /trivia/questions/delta List question deltas in ascending order of updated date
Gamification_TriviaApi GetQuestionTags GET /trivia/questions/{id}/tags List the tags for a question
Gamification_TriviaApi GetQuestionTemplate GET /trivia/questions/templates/{id} Get a single question template
Gamification_TriviaApi GetQuestionTemplates GET /trivia/questions/templates List and search question templates
Gamification_TriviaApi GetQuestions GET /trivia/questions List and search questions
Gamification_TriviaApi GetQuestionsCount GET /trivia/questions/count Count questions based on filters
Gamification_TriviaApi ProcessImportJob POST /trivia/import/{id}/process Start processing an import job
Gamification_TriviaApi RemoveQuestionTag DELETE /trivia/questions/{id}/tags/{tag} Remove a tag from a question
Gamification_TriviaApi RemoveTagToQuestionsBatch DELETE /trivia/questions/tags/{tag} Remove a tag from a batch of questions
Gamification_TriviaApi SearchQuestionTags GET /trivia/tags List and search tags by the beginning of the string
Gamification_TriviaApi UpdateImportJob PUT /trivia/import/{id} Update an import job
Gamification_TriviaApi UpdateQuestion PUT /trivia/questions/{id} Update a question
Gamification_TriviaApi UpdateQuestionAnswer PUT /trivia/questions/{question_id}/answers/{id} Update an answer for a question
Gamification_TriviaApi UpdateQuestionTemplate PUT /trivia/questions/templates/{id} Update a question template
Gamification_TriviaApi UpdateQuestionsInBulk PUT /trivia/questions Bulk update questions
InvoicesApi CreateInvoice POST /invoices Create an invoice
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 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 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
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
LogsApi AddUserLog POST /audit/logs Add a user log entry
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 GetUserLog GET /audit/logs/{id} Returns a user log entry by id
LogsApi GetUserLogs GET /audit/logs Returns a page of user logs entries
Media_ArtistsApi AddArtist POST /media/artists Adds a new artist in the system
Media_ArtistsApi CreateArtistTemplate POST /media/artists/templates Create an artist template
Media_ArtistsApi DeleteArtist DELETE /media/artists/{id} Removes an artist from the system IF no resources are attached to it
Media_ArtistsApi DeleteArtistTemplate DELETE /media/artists/templates/{id} Delete an artist template
Media_ArtistsApi GetArtist GET /media/artists/{id} Loads a specific artist details
Media_ArtistsApi GetArtistTemplate GET /media/artists/templates/{id} Get a single artist template
Media_ArtistsApi GetArtistTemplates GET /media/artists/templates List and search artist templates
Media_ArtistsApi GetArtists GET /media/artists Search for artists
Media_ArtistsApi UpdateArtist PUT /media/artists/{id} Modifies an artist details
Media_ArtistsApi UpdateArtistTemplate PUT /media/artists/templates/{id} Update an artist template
Media_ModerationApi AddFlag POST /moderation/flags Add a flag
Media_ModerationApi DeleteFlag DELETE /moderation/flags Delete a flag
Media_ModerationApi GetFlags GET /moderation/flags Returns a page of flags
Media_ModerationApi GetModerationReport GET /moderation/reports/{id} Get a flag report
Media_ModerationApi GetModerationReports GET /moderation/reports Returns a page of flag reports
Media_ModerationApi UpdateModerationReport PUT /moderation/reports/{id} Update a flag report
Media_PollsApi AnswerPoll POST /media/polls/{id}/response Add your vote to a poll
Media_PollsApi CreatePoll POST /media/polls Create a new poll
Media_PollsApi CreatePollTemplate POST /media/polls/templates Create a poll template
Media_PollsApi DeletePoll DELETE /media/polls/{id} Delete an existing poll
Media_PollsApi DeletePollTemplate DELETE /media/polls/templates/{id} Delete a poll template
Media_PollsApi GetPoll GET /media/polls/{id} Get a single poll
Media_PollsApi GetPollAnswer GET /media/polls/{id}/response Get poll answer
Media_PollsApi GetPollTemplate GET /media/polls/templates/{id} Get a single poll template
Media_PollsApi GetPollTemplates GET /media/polls/templates List and search poll templates
Media_PollsApi GetPolls GET /media/polls List and search polls
Media_PollsApi UpdatePoll PUT /media/polls/{id} Update an existing poll
Media_PollsApi UpdatePollTemplate PUT /media/polls/templates/{id} Update a poll template
Media_VideosApi AddUserToVideoWhitelist POST /media/videos/{id}/whitelist Adds a user to a video's whitelist
Media_VideosApi AddVideo POST /media/videos Adds a new video in the system
Media_VideosApi AddVideoComment POST /media/videos/{video_id}/comments Add a new video comment
Media_VideosApi AddVideoContributor POST /media/videos/{video_id}/contributors Adds a contributor to a video
Media_VideosApi AddVideoFlag POST /media/videos/{video_id}/moderation Add a new flag
Media_VideosApi AddVideoRelationships POST /media/videos/{video_id}/related Adds one or more existing videos as related to this one
Media_VideosApi CreateVideoDisposition POST /media/videos/{video_id}/dispositions Create a video disposition
Media_VideosApi CreateVideoTemplate POST /media/videos/templates Create a video template
Media_VideosApi DeleteVideo DELETE /media/videos/{id} Deletes a video from the system if no resources are attached to it
Media_VideosApi DeleteVideoComment DELETE /media/videos/{video_id}/comments/{id} Delete a video comment
Media_VideosApi DeleteVideoDisposition DELETE /media/videos/{video_id}/dispositions/{disposition_id} Delete a video disposition
Media_VideosApi DeleteVideoFlag DELETE /media/videos/{video_id}/moderation Delete a flag
Media_VideosApi DeleteVideoRelationship DELETE /media/videos/{video_id}/related/{id} Delete a video's relationship
Media_VideosApi DeleteVideoTemplate DELETE /media/videos/templates/{id} Delete a video template
Media_VideosApi GetUserVideos GET /users/{user_id}/videos Get user videos
Media_VideosApi GetVideo GET /media/videos/{id} Loads a specific video details
Media_VideosApi GetVideoComments GET /media/videos/{video_id}/comments Returns a page of comments for a video
Media_VideosApi GetVideoDispositions GET /media/videos/{video_id}/dispositions Returns a page of dispositions for a video
Media_VideosApi GetVideoRelationships GET /media/videos/{video_id}/related Returns a page of video relationships
Media_VideosApi GetVideoTemplate GET /media/videos/templates/{id} Get a single video template
Media_VideosApi GetVideoTemplates GET /media/videos/templates List and search video templates
Media_VideosApi GetVideos GET /media/videos Search videos using the documented filters
Media_VideosApi RemoveUserFromVideoWhitelist DELETE /media/videos/{video_id}/whitelist/{id} Removes a user from a video's whitelist
Media_VideosApi RemoveVideoContributor DELETE /media/videos/{video_id}/contributors/{id} Removes a contributor from a video
Media_VideosApi UpdateVideo PUT /media/videos/{id} Modifies a video's details
Media_VideosApi UpdateVideoComment PUT /media/videos/{video_id}/comments/{id}/content Update a video comment
Media_VideosApi UpdateVideoRelationship PUT /media/videos/{video_id}/related/{id}/relationship_details Update a video's relationship details
Media_VideosApi UpdateVideoTemplate PUT /media/videos/templates/{id} Update a video template
Media_VideosApi ViewVideo POST /media/videos/{id}/views Increment a video's view count
MessagingApi CompileMessageTemplate 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
Messaging_TopicsApi DisableTopicSubscriber PUT /messaging/topics/{id}/subscribers/{user_id}/disabled Enable or disable messages for a user
Messaging_TopicsApi GetTopicSubscriber GET /messaging/topics/{id}/subscribers/{user_id} Get a subscriber to a topic
Messaging_TopicsApi GetUserTopics GET /users/{id}/topics Get all messaging topics for a given user
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 PUT /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
Payments_AppleApi VerifyAppleReceipt POST /payment/provider/apple/receipt Pay invoice with Apple receipt
Payments_FattMerchantApi CreateOrUpdateFattMerchantPaymentMethod PUT /payment/provider/fattmerchant/payment-methods Create or update a FattMerchant payment method for a user
Payments_OptimalApi SilentPostOptimal POST /payment/provider/optimal/silent Initiate silent post with Optimal
Payments_PayPalClassicApi CreatePayPalBillingAgreementUrl POST /payment/provider/paypal/classic/agreements/start Create a PayPal Classic billing agreement for the user
Payments_PayPalClassicApi CreatePayPalExpressCheckout POST /payment/provider/paypal/classic/checkout/start Create a payment token for PayPal express checkout
Payments_PayPalClassicApi FinalizePayPalBillingAgreement POST /payment/provider/paypal/classic/agreements/finish Finalizes a billing agreement after the user has accepted through PayPal
Payments_PayPalClassicApi FinalizePayPalCheckout POST /payment/provider/paypal/classic/checkout/finish Finalizes a payment after the user has completed checkout with PayPal
Payments_StripeApi CreateStripePaymentMethod POST /payment/provider/stripe/payment-methods Create a Stripe payment method for a user
Payments_StripeApi PayStripeInvoice POST /payment/provider/stripe/payments Pay with a single use token
Payments_TransactionsApi GetTransaction GET /transactions/{id} Get the details for a single transaction
Payments_TransactionsApi GetTransactions GET /transactions List and search transactions
Payments_TransactionsApi RefundTransaction POST /transactions/{id}/refunds Refund a payment transaction, in full or in part
Payments_WalletsApi GetUserWallet GET /users/{user_id}/wallets/{currency_code} Returns the user's wallet for the given currency code
Payments_WalletsApi GetUserWalletTransactions GET /users/{user_id}/wallets/{currency_code}/transactions Retrieve a user's wallet transactions
Payments_WalletsApi GetUserWallets GET /users/{user_id}/wallets List all of a user's wallets
Payments_WalletsApi GetWalletBalances GET /wallets/totals Retrieves a summation of wallet balances by currency code
Payments_WalletsApi GetWalletTransactions GET /wallets/transactions Retrieve wallet transactions across the system
Payments_WalletsApi GetWallets GET /wallets Retrieve a list of wallets across the system
Payments_WalletsApi UpdateWalletBalance PUT /users/{user_id}/wallets/{currency_code}/balance Updates the balance for a user's wallet
Payments_XsollaApi 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
Reporting_ChallengesApi GetChallengeEventLeaderboard GET /reporting/events/leaderboard Retrieve a challenge event leaderboard details
Reporting_ChallengesApi GetChallengeEventParticipants GET /reporting/events/participants Retrieve a challenge event participant details
Reporting_OrdersApi GetInvoiceReports GET /reporting/orders/count/{currency_code} Retrieve invoice counts aggregated by time ranges
Reporting_RevenueApi GetItemRevenue GET /reporting/revenue/item-sales/{currency_code} Get item revenue info
Reporting_RevenueApi GetRefundRevenue GET /reporting/revenue/refunds/{currency_code} Get refund revenue info
Reporting_RevenueApi GetRevenueByCountry GET /reporting/revenue/countries/{currency_code} Get revenue info by country
Reporting_RevenueApi GetRevenueByItem GET /reporting/revenue/products/{currency_code} Get revenue info by item
Reporting_RevenueApi GetSubscriptionRevenue GET /reporting/revenue/subscription-sales/{currency_code} Get subscription revenue info
Reporting_SubscriptionsApi GetSubscriptionReports GET /reporting/subscription Get a list of available subscription reports in most recent first order
Reporting_UsageApi GetUsageByDay GET /reporting/usage/day Returns aggregated endpoint usage information by day
Reporting_UsageApi GetUsageByHour GET /reporting/usage/hour Returns aggregated endpoint usage information by hour
Reporting_UsageApi GetUsageByMinute GET /reporting/usage/minute Returns aggregated endpoint usage information by minute
Reporting_UsageApi GetUsageByMonth GET /reporting/usage/month Returns aggregated endpoint usage information by month
Reporting_UsageApi GetUsageByYear GET /reporting/usage/year Returns aggregated endpoint usage information by year
Reporting_UsageApi GetUsageEndpoints GET /reporting/usage/endpoints Returns list of endpoints called (method and url)
Reporting_UsersApi GetUserRegistrations GET /reporting/users/registrations Get user registration info
Rule_Engine_ActionsApi GetBREActions GET /bre/actions Get a list of available actions
Rule_Engine_EventsApi SendBREEvent POST /bre/events Fire a new event, based on an existing trigger
Rule_Engine_ExpressionsApi GetBREExpression GET /bre/expressions/{type} Lookup a specific expression
Rule_Engine_ExpressionsApi GetBREExpressions GET /bre/expressions Get a list of supported expressions to use in conditions or actions.
Rule_Engine_ExpressionsApi GetExpressionAsText POST /bre/expressions Returns the textual representation of an expression
Rule_Engine_GlobalsApi CreateBREGlobal POST /bre/globals/definitions Create a global definition
Rule_Engine_GlobalsApi DeleteBREGlobal DELETE /bre/globals/definitions/{id} Delete a global
Rule_Engine_GlobalsApi GetBREGlobal GET /bre/globals/definitions/{id} Get a single global definition
Rule_Engine_GlobalsApi GetBREGlobals GET /bre/globals/definitions List global definitions
Rule_Engine_GlobalsApi UpdateBREGlobal PUT /bre/globals/definitions/{id} Update a global definition
Rule_Engine_RulesApi CreateBRERule POST /bre/rules Create a rule
Rule_Engine_RulesApi DeleteBRERule DELETE /bre/rules/{id} Delete a rule
Rule_Engine_RulesApi GetBREExpressionAsString POST /bre/rules/expression-as-string Returns a string representation of the provided expression
Rule_Engine_RulesApi GetBRERule GET /bre/rules/{id} Get a single rule
Rule_Engine_RulesApi GetBRERules GET /bre/rules List rules
Rule_Engine_RulesApi SetBRERule PUT /bre/rules/{id}/enabled Enable or disable a rule
Rule_Engine_RulesApi UpdateBRERule PUT /bre/rules/{id} Update a rule
Rule_Engine_TriggersApi CreateBRETrigger POST /bre/triggers Create a trigger
Rule_Engine_TriggersApi DeleteBRETrigger DELETE /bre/triggers/{event_name} Delete a trigger
Rule_Engine_TriggersApi GetBRETrigger GET /bre/triggers/{event_name} Get a single trigger
Rule_Engine_TriggersApi GetBRETriggers GET /bre/triggers List triggers
Rule_Engine_TriggersApi UpdateBRETrigger PUT /bre/triggers/{event_name} Update a trigger
Rule_Engine_VariablesApi GetBREVariableTypes GET /bre/variable-types Get a list of variable types available
Rule_Engine_VariablesApi GetBREVariableValues GET /bre/variable-types/{name}/values List valid values for a type
SearchApi SearchCountGET GET /search/count/{type} Count matches with no template
SearchApi SearchCountPOST POST /search/count/{type} Count matches with no template
SearchApi SearchCountWithTemplateGET GET /search/count/{type}/{template} Count matches with a template
SearchApi SearchCountWithTemplatePOST POST /search/count/{type}/{template} Count matches with a template
SearchApi SearchDocumentGET GET /search/documents/{type}/{id} Get document with no template
SearchApi SearchDocumentWithTemplateGET GET /search/documents/{type}/{template}/{id} Get document with a 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 SearchExplainWithTemplateGET GET /search/explain/{type}/{template}/{id} Explain matches with a template
SearchApi SearchExplainWithTemplatePOST POST /search/explain/{type}/{template}/{id} Explain matches with a 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 SearchIndexWithTemplateGET GET /search/index/{type}/{template} Search an index with a template
SearchApi SearchIndexWithTemplatePOST POST /search/index/{type}/{template} Search an index with a template
SearchApi SearchIndicesGET GET /search/indices Get indices
SearchApi SearchMappingsGET GET /search/mappings/{type} Get mapping with no template
SearchApi SearchMappingsWithTemplateGET GET /search/mappings/{type}/{template} Get mapping with a template
SearchApi SearchValidateGET GET /search/validate/{type} Validate matches with no template
SearchApi SearchValidatePOST POST /search/validate/{type} Validate matches with no template
SearchApi SearchValidateWithTemplateGET GET /search/validate/{type}/{template} Validate matches with a template
SearchApi SearchValidateWithTemplatePOST POST /search/validate/{type}/{template} Validate matches with a template
Social_FacebookApi LinkAccounts POST /social/facebook/users Link facebook account
Social_GoogleApi 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 UpdateItemTemplate PUT /store/items/templates/{id} Update an item template
StoreApi UpdateStoreItem PUT /store/items/{id} Update a store item
Store_BundlesApi CreateBundleItem POST /store/bundles Create a bundle item
Store_BundlesApi CreateBundleTemplate POST /store/bundles/templates Create a bundle template
Store_BundlesApi DeleteBundleItem DELETE /store/bundles/{id} Delete a bundle item
Store_BundlesApi DeleteBundleTemplate DELETE /store/bundles/templates/{id} Delete a bundle template
Store_BundlesApi GetBundleItem GET /store/bundles/{id} Get a single bundle item
Store_BundlesApi GetBundleTemplate GET /store/bundles/templates/{id} Get a single bundle template
Store_BundlesApi GetBundleTemplates GET /store/bundles/templates List and search bundle templates
Store_BundlesApi UpdateBundleItem PUT /store/bundles/{id} Update a bundle item
Store_BundlesApi UpdateBundleTemplate PUT /store/bundles/templates/{id} Update a bundle template
Store_CouponsApi CreateCouponItem POST /store/coupons Create a coupon item
Store_CouponsApi CreateCouponTemplate POST /store/coupons/templates Create a coupon template
Store_CouponsApi DeleteCouponItem DELETE /store/coupons/{id} Delete a coupon item
Store_CouponsApi DeleteCouponTemplate DELETE /store/coupons/templates/{id} Delete a coupon template
Store_CouponsApi GetCouponItem GET /store/coupons/{id} Get a single coupon item
Store_CouponsApi GetCouponItemBySku GET /store/coupons/skus/{sku} Get a coupon by sku
Store_CouponsApi GetCouponTemplate GET /store/coupons/templates/{id} Get a single coupon template
Store_CouponsApi GetCouponTemplates GET /store/coupons/templates List and search coupon templates
Store_CouponsApi UpdateCouponItem PUT /store/coupons/{id} Update a coupon item
Store_CouponsApi UpdateCouponTemplate PUT /store/coupons/templates/{id} Update a coupon template
Store_SalesApi CreateCatalogSale POST /store/sales Create a sale
Store_SalesApi DeleteCatalogSale DELETE /store/sales/{id} Delete a sale
Store_SalesApi GetCatalogSale GET /store/sales/{id} Get a single sale
Store_SalesApi GetCatalogSales GET /store/sales List and search sales
Store_SalesApi UpdateCatalogSale PUT /store/sales/{id} Update a sale
Store_ShippingApi CreateShippingItem POST /store/shipping Create a shipping item
Store_ShippingApi CreateShippingTemplate POST /store/shipping/templates Create a shipping template
Store_ShippingApi DeleteShippingItem DELETE /store/shipping/{id} Delete a shipping item
Store_ShippingApi DeleteShippingTemplate DELETE /store/shipping/templates/{id} Delete a shipping template
Store_ShippingApi GetShippingItem GET /store/shipping/{id} Get a single shipping item
Store_ShippingApi GetShippingTemplate GET /store/shipping/templates/{id} Get a single shipping template
Store_ShippingApi GetShippingTemplates GET /store/shipping/templates List and search shipping templates
Store_ShippingApi UpdateShippingItem PUT /store/shipping/{id} Update a shipping item
Store_ShippingApi UpdateShippingTemplate PUT /store/shipping/templates/{id} Update a shipping template
Store_Shopping_CartsApi AddCustomDiscount POST /carts/{id}/custom-discounts Adds a custom discount to the cart
Store_Shopping_CartsApi AddDiscountToCart POST /carts/{id}/discounts Adds a discount coupon to the cart
Store_Shopping_CartsApi AddItemToCart POST /carts/{id}/items Add an item to the cart
Store_Shopping_CartsApi CreateCart POST /carts Create a cart
Store_Shopping_CartsApi GetCart GET /carts/{id} Returns the cart with the given GUID
Store_Shopping_CartsApi GetCarts GET /carts Get a list of carts
Store_Shopping_CartsApi GetShippable GET /carts/{id}/shippable Returns whether a cart requires shipping
Store_Shopping_CartsApi GetShippingCountries GET /carts/{id}/countries Get the list of available shipping countries per vendor
Store_Shopping_CartsApi RemoveDiscountFromCart DELETE /carts/{id}/discounts/{code} Removes a discount coupon from the cart
Store_Shopping_CartsApi SetCartCurrency PUT /carts/{id}/currency Sets the currency to use for the cart
Store_Shopping_CartsApi SetCartOwner PUT /carts/{id}/owner Sets the owner of a cart if none is set already
Store_Shopping_CartsApi UpdateItemInCart PUT /carts/{id}/items Changes the quantity of an item already in the cart
Store_Shopping_CartsApi UpdateShippingAddress PUT /carts/{id}/shipping-address Modifies or sets the order shipping address
Store_SubscriptionsApi CreateSubscription POST /subscriptions Creates a subscription item and associated plans
Store_SubscriptionsApi CreateSubscriptionTemplate POST /subscriptions/templates Create a subscription template
Store_SubscriptionsApi DeleteSubscription DELETE /subscriptions/{id}/plans/{plan_id} Delete a subscription plan
Store_SubscriptionsApi DeleteSubscriptionTemplate DELETE /subscriptions/templates/{id} Delete a subscription template
Store_SubscriptionsApi GetSubscription GET /subscriptions/{id} Retrieve a single subscription item and associated plans
Store_SubscriptionsApi GetSubscriptionTemplate GET /subscriptions/templates/{id} Get a single subscription template
Store_SubscriptionsApi GetSubscriptionTemplates GET /subscriptions/templates List and search subscription templates
Store_SubscriptionsApi GetSubscriptions GET /subscriptions List available subscription items and associated plans
Store_SubscriptionsApi ProcessSubscriptions POST /subscriptions/process Processes subscriptions and charge dues
Store_SubscriptionsApi UpdateSubscription PUT /subscriptions/{id} Updates a subscription item and associated plans
Store_SubscriptionsApi UpdateSubscriptionTemplate PUT /subscriptions/templates/{id} Update a subscription template
Store_VendorsApi CreateVendor POST /vendors Create a vendor
Store_VendorsApi CreateVendorTemplate POST /vendors/templates Create a vendor template
Store_VendorsApi DeleteVendor DELETE /vendors/{id} Delete a vendor
Store_VendorsApi DeleteVendorTemplate DELETE /vendors/templates/{id} Delete a vendor template
Store_VendorsApi GetVendor GET /vendors/{id} Get a single vendor
Store_VendorsApi GetVendorTemplate GET /vendors/templates/{id} Get a single vendor template
Store_VendorsApi GetVendorTemplates GET /vendors/templates List and search vendor templates
Store_VendorsApi GetVendors GET /vendors List and search vendors
Store_VendorsApi UpdateVendor PUT /vendors/{id} Update a vendor
Store_VendorsApi UpdateVendorTemplate PUT /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
Templates_PropertiesApi GetTemplatePropertyType GET /templates/properties/{type} Get details for a template property type
Templates_PropertiesApi 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 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 PUT /users/templates/{id} Update a user template
Users_AddressesApi CreateAddress POST /users/{user_id}/addresses Create a new address
Users_AddressesApi DeleteAddress DELETE /users/{user_id}/addresses/{id} Delete an address
Users_AddressesApi GetAddress GET /users/{user_id}/addresses/{id} Get a single address
Users_AddressesApi GetAddresses GET /users/{user_id}/addresses List and search addresses
Users_AddressesApi UpdateAddress PUT /users/{user_id}/addresses/{id} Update an address
Users_FriendshipsApi AddFriend POST /users/{user_id}/friends/{id} Add a friend
Users_FriendshipsApi GetFriends GET /users/{user_id}/friends Get friends list
Users_FriendshipsApi GetInviteToken GET /users/{user_id}/invite-token Returns the invite token
Users_FriendshipsApi GetInvites GET /users/{user_id}/invites Get pending invites
Users_FriendshipsApi RedeemFriendshipToken POST /users/{user_id}/friends/tokens Redeem friendship token
Users_FriendshipsApi RemoveOrDeclineFriend DELETE /users/{user_id}/friends/{id} Remove or decline a friend
Users_GroupsApi AddMemberToGroup POST /users/groups/{unique_name}/members Adds a new member to the group
Users_GroupsApi AddMembersToGroup POST /users/groups/{unique_name}/members/batch-add Adds multiple members to the group
Users_GroupsApi CreateGroup POST /users/groups Create a group
Users_GroupsApi CreateGroupMemberTemplate POST /users/groups/members/templates Create an group member template
Users_GroupsApi CreateGroupTemplate POST /users/groups/templates Create a group template
Users_GroupsApi DeleteGroup DELETE /users/groups/{unique_name} Removes a group from the system
Users_GroupsApi DeleteGroupMemberTemplate DELETE /users/groups/members/templates/{id} Delete an group member template
Users_GroupsApi DeleteGroupTemplate DELETE /users/groups/templates/{id} Delete a group template
Users_GroupsApi DisableGroupNotification PUT /users/groups/{unique_name}/members/{user_id}/messages/disabled Enable or disable notification of group messages
Users_GroupsApi GetGroup GET /users/groups/{unique_name} Loads a specific group's details
Users_GroupsApi GetGroupAncestors GET /users/groups/{unique_name}/ancestors Get group ancestors
Users_GroupsApi GetGroupMember GET /users/groups/{unique_name}/members/{user_id} Get a user from a group
Users_GroupsApi GetGroupMemberTemplate GET /users/groups/members/templates/{id} Get a single group member template
Users_GroupsApi GetGroupMemberTemplates GET /users/groups/members/templates List and search group member templates
Users_GroupsApi GetGroupMembers GET /users/groups/{unique_name}/members Lists members of the group
Users_GroupsApi GetGroupMessages GET /users/groups/{unique_name}/messages Get a list of group messages
Users_GroupsApi GetGroupTemplate GET /users/groups/templates/{id} Get a single group template
Users_GroupsApi GetGroupTemplates GET /users/groups/templates List and search group templates
Users_GroupsApi GetGroupsForUser GET /users/{user_id}/groups List groups a user is in
Users_GroupsApi ListGroups GET /users/groups List and search groups
Users_GroupsApi PostGroupMessage POST /users/groups/{unique_name}/messages Send a group message
Users_GroupsApi RemoveGroupMember DELETE /users/groups/{unique_name}/members/{user_id} Removes a user from a group
Users_GroupsApi UpdateGroup PUT /users/groups/{unique_name} Update a group
Users_GroupsApi UpdateGroupMemberProperties PUT /users/groups/{unique_name}/members/{user_id}/order Change a user's order
Users_GroupsApi UpdateGroupMemberProperties1 PUT /users/groups/{unique_name}/members/{user_id}/properties Change a user's membership properties
Users_GroupsApi UpdateGroupMemberStatus PUT /users/groups/{unique_name}/members/{user_id}/status Change a user's status
Users_GroupsApi UpdateGroupMemberTemplate PUT /users/groups/members/templates/{id} Update an group member template
Users_GroupsApi UpdateGroupTemplate PUT /users/groups/templates/{id} Update a group template
Users_InventoryApi AddItemToUserInventory POST /users/{id}/inventory Adds an item to the user inventory
Users_InventoryApi CheckUserEntitlementItem GET /users/{user_id}/entitlements/{item_id}/check Check for access to an item without consuming
Users_InventoryApi CreateEntitlementItem POST /entitlements Create an entitlement item
Users_InventoryApi CreateEntitlementTemplate POST /entitlements/templates Create an entitlement template
Users_InventoryApi DeleteEntitlementItem DELETE /entitlements/{entitlement_id} Delete an entitlement item
Users_InventoryApi DeleteEntitlementTemplate DELETE /entitlements/templates/{id} Delete an entitlement template
Users_InventoryApi GetEntitlementItem GET /entitlements/{entitlement_id} Get a single entitlement item
Users_InventoryApi GetEntitlementItems GET /entitlements List and search entitlement items
Users_InventoryApi GetEntitlementTemplate GET /entitlements/templates/{id} Get a single entitlement template
Users_InventoryApi GetEntitlementTemplates GET /entitlements/templates List and search entitlement templates
Users_InventoryApi GetUserInventories GET /users/{id}/inventory List the user inventory entries for a given user
Users_InventoryApi GetUserInventory GET /users/{user_id}/inventory/{id} Get an inventory entry
Users_InventoryApi GetUserInventoryLog GET /users/{user_id}/inventory/{id}/log List the log entries for this inventory entry
Users_InventoryApi GetUsersInventory GET /inventories List the user inventory entries for all users
Users_InventoryApi GrantUserEntitlement POST /users/{user_id}/entitlements Grant an entitlement
Users_InventoryApi UpdateEntitlementItem PUT /entitlements/{entitlement_id} Update an entitlement item
Users_InventoryApi UpdateEntitlementTemplate PUT /entitlements/templates/{id} Update an entitlement template
Users_InventoryApi UpdateUserInventoryBehaviorData PUT /users/{user_id}/inventory/{id}/behavior-data Set the behavior data for an inventory entry
Users_InventoryApi UpdateUserInventoryExpires PUT /users/{user_id}/inventory/{id}/expires Set the expiration date
Users_InventoryApi UpdateUserInventoryStatus PUT /users/{user_id}/inventory/{id}/status Set the status for an inventory entry
Users_InventoryApi UseUserEntitlementItem POST /users/{user_id}/entitlements/{item_id}/use Use an item
Users_RelationshipsApi CreateUserRelationship POST /users/relationships Create a user relationship
Users_RelationshipsApi DeleteUserRelationship DELETE /users/relationships/{id} Delete a user relationship
Users_RelationshipsApi GetUserRelationship GET /users/relationships/{id} Get a user relationship
Users_RelationshipsApi GetUserRelationships GET /users/relationships Get a list of user relationships
Users_RelationshipsApi UpdateUserRelationship PUT /users/relationships/{id} Update a user relationship
Users_SubscriptionsApi GetUserSubscriptionDetails GET /users/{user_id}/subscriptions/{inventory_id} Get details about a user's subscription
Users_SubscriptionsApi GetUsersSubscriptionDetails GET /users/{user_id}/subscriptions Get details about a user's subscriptions
Users_SubscriptionsApi ReactivateUserSubscription POST /users/{user_id}/subscriptions/{inventory_id}/reactivate Reactivate a subscription and charge fee
Users_SubscriptionsApi SetSubscriptionBillDate PUT /users/{user_id}/subscriptions/{inventory_id}/bill-date Set a new date to bill a subscription on
Users_SubscriptionsApi SetSubscriptionPaymentMethod PUT /users/{user_id}/subscriptions/{inventory_id}/payment-method Set the payment method to use for a subscription
Users_SubscriptionsApi SetSubscriptionStatus PUT /users/{user_id}/subscriptions/{inventory_id}/status Set the status of a subscription
Users_SubscriptionsApi SetUserSubscriptionPlan PUT /users/{user_id}/subscriptions/{inventory_id}/plan Set a new subscription plan for a user
Users_SubscriptionsApi SetUserSubscriptionPrice PUT /users/{user_id}/subscriptions/{inventory_id}/price-override Set a new subscription price for a user
Util_BatchApi GetBatch GET /batch/{token} Get batch result with token
Util_BatchApi SendBatch POST /batch Request to run API call given the method, content type, path url, and body of request
Util_HealthApi GetHealth GET /health Get health info
Util_MaintenanceApi DeleteMaintenance DELETE /maintenance Delete maintenance info
Util_MaintenanceApi GetMaintenance GET /maintenance Get current maintenance info
Util_MaintenanceApi SetMaintenance POST /maintenance Set current maintenance info
Util_MaintenanceApi UpdateMaintenance PUT /maintenance Update current maintenance info
Util_SecurityApi GetUserLocationLog GET /security/country-log Returns the authentication log for a user
Util_SecurityApi GetUserTokenDetails GET /me Returns the authentication token details. Use /users endpoint for detailed user's info
Util_VersionApi GetVersion GET /version Get current version info

Documentation for Models

Documentation for Authorization

oauth2_client_credentials_grant

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
    • read write: read write

oauth2_password_grant

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes:
    • read write: read write

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

7 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages