1.0.1 • Published 2 years ago

questbot-js-client v1.0.1

Weekly downloads
-
License
Unlicense
Repository
-
Last release
2 years ago

questbot-js-client

QuestbotJsClient - JavaScript client for questbot-js-client The Quest Bot API This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.1
  • Package version: 0.1
  • Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

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

Then install it via:

npm install questbot-js-client --save

git

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

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

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

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

Getting Started

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

var QuestbotJsClient = require('questbot-js-client');
var defaultClient = QuestbotJsClient.ApiClient.instance;

// Configure API key authorization: X-API-KEY
var X-API-KEY = defaultClient.authentications['X-API-KEY'];
X-API-KEY.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-API-KEY.apiKeyPrefix['X-API-KEY'] = "Token"

var api = new QuestbotJsClient.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.appControllerGetHello(callback);

Documentation for API Endpoints

All URIs are relative to /

ClassMethodHTTP requestDescription
QuestbotJsClient.DefaultApiappControllerGetHelloGET /
QuestbotJsClient.GuildApiguildsControllerCreatePOST /guilds
QuestbotJsClient.GuildApiguildsControllerFindAllGET /guilds
QuestbotJsClient.GuildApiguildsControllerFindOneGET /guilds/{guildId}
QuestbotJsClient.GuildApiguildsControllerFindOneDetailsGET /guilds/{guildId}/details
QuestbotJsClient.GuildApiguildsControllerRemoveDELETE /guilds/{guildId}
QuestbotJsClient.GuildApiguildsControllerUpdatePATCH /guilds/{guildId}
QuestbotJsClient.GuildshopApiguildshopControllerCreateGuildShopRolePOST /guilds/{guildId}/shop/role
QuestbotJsClient.GuildshopApiguildshopControllerGetActiveShopItemsGET /guilds/{guildId}/shop
QuestbotJsClient.GuildshopApiguildshopControllerGetGuildShopItemGET /guilds/{guildId}/shop/{guildShopItemId}
QuestbotJsClient.GuildshopApiguildshopControllerRemoveGuildShopItemDELETE /guilds/{guildId}/shop/{guildShopItemId}
QuestbotJsClient.UserofguildpurchasesApiuserofguildpurchasesControllerCreatePOST /guilds/{guildId}/users/{discordUserId}/purchase/{guildShopItemId}
QuestbotJsClient.UsersApiusersControllerCreatePOST /users
QuestbotJsClient.UsersApiusersControllerFindAllGET /users
QuestbotJsClient.UsersApiusersControllerFindOneGET /users/{discordUserId}
QuestbotJsClient.UsersApiusersControllerRemoveDELETE /users/{discordUserId}
QuestbotJsClient.UsersApiusersControllerUpdatePATCH /users/{discordUserId}
QuestbotJsClient.UsersOfGuildApiusersofguildControllerCreatePOST /guilds/{guildId}/users/{discordUserId}
QuestbotJsClient.UsersOfGuildApiusersofguildControllerFindAllGET /guilds/{guildId}/users
QuestbotJsClient.UsersOfGuildApiusersofguildControllerFindOneGET /guilds/{guildId}/users/{discordUserId}
QuestbotJsClient.UsersOfGuildApiusersofguildControllerIncrementDiscordMessagesSentPOST /guilds/{guildId}/users/{discordUserId}/increment/{incrementType}
QuestbotJsClient.UsersOfGuildApiusersofguildControllerRemoveDELETE /guilds/{guildId}/users/{discordUserId}
QuestbotJsClient.UsersOfGuildApiusersofguildControllerUpdatePATCH /guilds/{guildId}/users/{discordUserId}

Documentation for Models

Documentation for Authorization

X-API-KEY

  • Type: API key
  • API key parameter name: X-API-KEY
  • Location: HTTP header
1.0.1

2 years ago

1.0.0

2 years ago