import type { Award } from '../models/Award'; import type { Elimination_Alliance } from '../models/Elimination_Alliance'; import type { Event } from '../models/Event'; import type { Event_District_Points } from '../models/Event_District_Points'; import type { Event_Insights } from '../models/Event_Insights'; import type { Event_OPRs } from '../models/Event_OPRs'; import type { Event_Predictions } from '../models/Event_Predictions'; import type { Event_Ranking } from '../models/Event_Ranking'; import type { Event_Simple } from '../models/Event_Simple'; import type { Match } from '../models/Match'; import type { Match_Simple } from '../models/Match_Simple'; import type { Team } from '../models/Team'; import type { Team_Event_Status } from '../models/Team_Event_Status'; import type { Team_Simple } from '../models/Team_Simple'; export declare class EventService { /** * Gets a list of events in the given year. * @param year Competition Year (or Season). Must be 4 digits. * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Event Successful response * @throws ApiError */ static getEventsByYear(year: number, ifNoneMatch?: string): Promise>; /** * Gets a short-form list of events in the given year. * @param year Competition Year (or Season). Must be 4 digits. * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Event_Simple Successful response * @throws ApiError */ static getEventsByYearSimple(year: number, ifNoneMatch?: string): Promise>; /** * Gets a list of event keys in the given year. * @param year Competition Year (or Season). Must be 4 digits. * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns string Successful response * @throws ApiError */ static getEventsByYearKeys(year: number, ifNoneMatch?: string): Promise>; /** * Gets an Event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Event Successful response * @throws ApiError */ static getEvent(eventKey: string, ifNoneMatch?: string): Promise; /** * Gets a short-form Event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Event_Simple Successful response * @throws ApiError */ static getEventSimple(eventKey: string, ifNoneMatch?: string): Promise; /** * Gets a list of Elimination Alliances for the given Event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Elimination_Alliance Successful response * @throws ApiError */ static getEventAlliances(eventKey: string, ifNoneMatch?: string): Promise>; /** * Gets a set of Event-specific insights for the given Event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Event_Insights Successful response * @throws ApiError */ static getEventInsights(eventKey: string, ifNoneMatch?: string): Promise; /** * Gets a set of Event OPRs (including OPR, DPR, and CCWM) for the given Event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Event_OPRs Successful response * @throws ApiError */ static getEventOpRs(eventKey: string, ifNoneMatch?: string): Promise; /** * Gets information on TBA-generated predictions for the given Event. Contains year-specific information. *WARNING* This endpoint is currently under development and may change at any time. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Event_Predictions Successful response * @throws ApiError */ static getEventPredictions(eventKey: string, ifNoneMatch?: string): Promise; /** * Gets a list of team rankings for the Event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Event_Ranking Successful response * @throws ApiError */ static getEventRankings(eventKey: string, ifNoneMatch?: string): Promise; /** * Gets a list of team rankings for the Event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Event_District_Points Successful response * @throws ApiError */ static getEventDistrictPoints(eventKey: string, ifNoneMatch?: string): Promise; /** * Gets a list of `Team` objects that competed in the given event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Team Successful response * @throws ApiError */ static getEventTeams(eventKey: string, ifNoneMatch?: string): Promise>; /** * Gets a short-form list of `Team` objects that competed in the given event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Team_Simple Successful response * @throws ApiError */ static getEventTeamsSimple(eventKey: string, ifNoneMatch?: string): Promise>; /** * Gets a list of `Team` keys that competed in the given event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns string Successful response * @throws ApiError */ static getEventTeamsKeys(eventKey: string, ifNoneMatch?: string): Promise>; /** * Gets a key-value list of the event statuses for teams competing at the given event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Team_Event_Status Successful response * @throws ApiError */ static getEventTeamsStatuses(eventKey: string, ifNoneMatch?: string): Promise>; /** * Gets a list of matches for the given event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Match Successful response * @throws ApiError */ static getEventMatches(eventKey: string, ifNoneMatch?: string): Promise>; /** * Gets a short-form list of matches for the given event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Match_Simple Successful response * @throws ApiError */ static getEventMatchesSimple(eventKey: string, ifNoneMatch?: string): Promise>; /** * Gets a list of match keys for the given event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns string Successful response * @throws ApiError */ static getEventMatchesKeys(eventKey: string, ifNoneMatch?: string): Promise>; /** * Gets an array of Match Keys for the given event key that have timeseries data. Returns an empty array if no matches have timeseries data. * *WARNING:* This is *not* official data, and is subject to a significant possibility of error, or missing data. Do not rely on this data for any purpose. In fact, pretend we made it up. * *WARNING:* This endpoint and corresponding data models are under *active development* and may change at any time, including in breaking ways. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns string Successful response * @throws ApiError */ static getEventMatchTimeseries(eventKey: string, ifNoneMatch?: string): Promise>; /** * Gets a list of awards from the given event. * @param eventKey TBA Event Key, eg `2016nytr` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Award Successful response * @throws ApiError */ static getEventAwards(eventKey: string, ifNoneMatch?: string): Promise>; }