tba-api-v3client v3.3.1

tba-api-v3client

TbaApiV3client - JavaScript client for tba-api-v3client

Overview Information and statistics about FIRST Robotics Competition teams and events. # Authentication All endpoints require an Auth Key to be passed in the header X-TBA-Auth-Key. If you do not have an auth key yet, you can obtain one from your Account Page. A User-Agent header may need to be set to prevent a 403 Unauthorized error.

This SDK is automatically generated by the Swagger Codegen project:

• API version: 3.03.1
• Package version: 3.03.1
• Build package: io.swagger.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 tba-api-v3client --save

Local development

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

npm install

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

npm link

Finally, switch to the directory you want to use your tba-api-v3client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('tba-api-v3client') in javascript files from the directory you ran the last command above from.

git

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

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

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

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

Getting Started

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

var TbaApiV3client = require('tba-api-v3client');

var defaultClient = TbaApiV3client.ApiClient.instance;

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

var api = new TbaApiV3client.DistrictApi()

var districtKey = "districtKey_example"; // {String} TBA District Key, eg `2016fim`

var opts = { 
  'ifModifiedSince': "ifModifiedSince_example" // {String} Value of the `Last-Modified` header in the most recently cached response by the client.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDistrictEvents(districtKey, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://www.thebluealliance.com/api/v3

Documentation for Models

• TbaApiV3client.APIStatus
• TbaApiV3client.APIStatusAppVersion
• TbaApiV3client.Award
• TbaApiV3client.AwardRecipient
• TbaApiV3client.DistrictList
• TbaApiV3client.DistrictRanking
• TbaApiV3client.DistrictRankingEventPoints
• TbaApiV3client.EliminationAlliance
• TbaApiV3client.EliminationAllianceBackup
• TbaApiV3client.EliminationAllianceStatus
• TbaApiV3client.Event
• TbaApiV3client.EventDistrictPoints
• TbaApiV3client.EventDistrictPointsPoints
• TbaApiV3client.EventDistrictPointsTiebreakers
• TbaApiV3client.EventInsights
• TbaApiV3client.EventInsights2016
• TbaApiV3client.EventInsights2017
• TbaApiV3client.EventInsights2018
• TbaApiV3client.EventOPRs
• TbaApiV3client.EventPredictions
• TbaApiV3client.EventRanking
• TbaApiV3client.EventRankingExtraStatsInfo
• TbaApiV3client.EventRankingRankings
• TbaApiV3client.EventRankingSortOrderInfo
• TbaApiV3client.EventSimple
• TbaApiV3client.Match
• TbaApiV3client.MatchAlliance
• TbaApiV3client.MatchScoreBreakdown2015
• TbaApiV3client.MatchScoreBreakdown2015Alliance
• TbaApiV3client.MatchScoreBreakdown2016
• TbaApiV3client.MatchScoreBreakdown2016Alliance
• TbaApiV3client.MatchScoreBreakdown2017
• TbaApiV3client.MatchScoreBreakdown2017Alliance
• TbaApiV3client.MatchScoreBreakdown2018
• TbaApiV3client.MatchScoreBreakdown2018Alliance
• TbaApiV3client.MatchSimple
• TbaApiV3client.MatchSimpleAlliances
• TbaApiV3client.MatchTimeseries2018
• TbaApiV3client.MatchVideos
• TbaApiV3client.Media
• TbaApiV3client.Team
• TbaApiV3client.TeamEventStatus
• TbaApiV3client.TeamEventStatusAlliance
• TbaApiV3client.TeamEventStatusAllianceBackup
• TbaApiV3client.TeamEventStatusPlayoff
• TbaApiV3client.TeamEventStatusRank
• TbaApiV3client.TeamEventStatusRankRanking
• TbaApiV3client.TeamEventStatusRankSortOrderInfo
• TbaApiV3client.TeamRobot
• TbaApiV3client.TeamSimple
• TbaApiV3client.WLTRecord
• TbaApiV3client.Webcast

Documentation for Authorization

apiKey

• Type: API key
• API key parameter name: X-TBA-Auth-Key
• Location: HTTP header