clash-bot-rest-client

ClashBotRestClient - JavaScript client for clash-bot-rest-client Clash Bot Webapp Service to support League of Legends Clash tournament scheduling with Discord. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.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 clash-bot-rest-client --save

Finally, you need to build the module:

npm run build

Local development

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

npm install

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

npm link

To use the link you just defined in your project, switch to the directory you want to use your clash-bot-rest-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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 ClashBotRestClient = require('clash-bot-rest-client');


var api = new ClashBotRestClient.SREApi()
api.getApplicationHealth().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/api/v2

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ClashBotRestClient.SREApi | getApplicationHealth | GET /health | ClashBotRestClient.TeamApi | createNewTeam | POST /team | ClashBotRestClient.TeamApi | getTeam | GET /team | ClashBotRestClient.TeamApi | removePlayerFromTeam | DELETE /team | ClashBotRestClient.TeamApi | updateTeam | PATCH /team | ClashBotRestClient.TentativeApi | getTentativeDetails | GET /tentative | ClashBotRestClient.TentativeApi | placePlayerOnTentative | POST /tentative | ClashBotRestClient.TentativeApi | removePlayerFromTentative | DELETE /tentative | ClashBotRestClient.TournamentApi | getTournaments | GET /tournaments | ClashBotRestClient.UserApi | addToListOfPreferredChampions | PATCH /user/{id}/champions | ClashBotRestClient.UserApi | createNewListOfPreferredChampions | POST /user/{id}/champions | ClashBotRestClient.UserApi | createUser | POST /user | ClashBotRestClient.UserApi | getUser | GET /user | ClashBotRestClient.UserApi | removeFromListOfPreferredChampions | DELETE /user/{id}/champions | ClashBotRestClient.UserApi | retrieveListOfUserPreferredChampions | GET /user/{id}/champions | ClashBotRestClient.UserApi | retrieveUserSubscriptions | GET /user/{id}/subscriptions | ClashBotRestClient.UserApi | subscribeUser | POST /user/{id}/subscriptions | ClashBotRestClient.UserApi | unsubscribeUser | DELETE /user/{id}/subscriptions | ClashBotRestClient.UserApi | updateUser | PATCH /user |

Documentation for Models

• ClashBotRestClient.AddToListOfPreferredChampionsRequest
• ClashBotRestClient.CreateNewListOfPreferredChampionsRequest
• ClashBotRestClient.CreateNewTeamRequest
• ClashBotRestClient.CreateNewTeamRequestPlayerDetails
• ClashBotRestClient.CreateUserRequest
• ClashBotRestClient.Error
• ClashBotRestClient.GetApplicationHealth200Response
• ClashBotRestClient.PlacePlayerOnTentativeRequest
• ClashBotRestClient.Player
• ClashBotRestClient.Role
• ClashBotRestClient.Subscription
• ClashBotRestClient.Team
• ClashBotRestClient.TeamPlayerDetails
• ClashBotRestClient.Tentative
• ClashBotRestClient.Tournament
• ClashBotRestClient.UpdateTeamRequest

Documentation for Authorization

All endpoints do not require authorization.