# RobotEvents API Wrapper
This is a wrapper for the RobotEvents API:
https://www.robotevents.com/api/v2
Currently it's in the Alpha phase supporting
\- getting Team(s), including the events, matches, rankings, skills, and awards.
\- getting Event(s), including the teams, matches, rankings, skills, and awards.
There are still limited parameters compared to the actual RobotEvents API, as programs / seasons aren't in the API with get() commands yet.
## Installation
To start using this package, install it using ``npm`` and a ``terminal``. Enter this command into the terminal:
```
npm install robotevents-api
```
## Usage
In your ``app.js`` or ``index.js`` file, start by writing:
```javascript
const robotevents = require('robotevents-api');
main();
async function main() {
// start your code here
};
```
This is required because all functions ran using this package are ``async``, meaning they run in the background. Whenever you call a method, you will have to use the keyword ``await`` before it.
To set your RobotEvents token, use the ```robotevents.setToken()``` command.
```javascript
const robotevents = require('robotevents-api');
main();
async function main() {
robotevents.setToken('your-token-here');
};
```
## Documentation
To fetch a ``Team``, use the method ``robotevents.teams.get(number, program)``. Replace ``number`` with the team number (ex. 11101B) and replace ``program`` with the program (ex. V5RC or VIQRC).
```javascript
const team = await robotevents.teams.get('11101B', robotevents.Programs.V5RC);
const events = await team.events({ /* put optional parameters here */ });
const matches = await team.matches({ /* put optional parameters here */ });
const rankings = await team.rankings({ /* put optional parameters here */ });
const skills = await team.skills({ /* put optional parameters here */ });
const awards = await team.awards({ /* put optional parameters here */ });
```
To fetch an ``Event``, use the method ``robotevents.events.get(sku)``. Replace ``sku`` with the event sku (ex. RE-V5RC-24-5557).
```javascript
const event = await robotevents.events.get('RE-V5RC-24-5557');
const teams = await event.teams({ /* put optional parameters here */ });
const skills = await event.skills({ /* put optional parameters here */ });
const awards = await event.awards({ /* put optional parameters here */ });
const matches = await event.matches({ /* put optional parameters here */ });
const rankings = await event.rankings({ /* put optional parameters here */ });
```