import type { Award } from '../models/Award'; import type { District_List } from '../models/District_List'; import type { Event } from '../models/Event'; import type { Event_Simple } from '../models/Event_Simple'; import type { Match } from '../models/Match'; import type { Match_Simple } from '../models/Match_Simple'; import type { Media } from '../models/Media'; import type { Team } from '../models/Team'; import type { Team_Event_Status } from '../models/Team_Event_Status'; import type { Team_Robot } from '../models/Team_Robot'; import type { Team_Simple } from '../models/Team_Simple'; export declare class TeamService { /** * Gets a list of `Team` objects, paginated in groups of 500. * @param pageNum Page number of results to return, zero-indexed * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Team Successful response * @throws ApiError */ static getTeams(pageNum: number, ifNoneMatch?: string): Promise>; /** * Gets a list of short form `Team_Simple` objects, paginated in groups of 500. * @param pageNum Page number of results to return, zero-indexed * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Team_Simple Successful response * @throws ApiError */ static getTeamsSimple(pageNum: number, ifNoneMatch?: string): Promise>; /** * Gets a list of Team keys, paginated in groups of 500. (Note, each page will not have 500 teams, but will include the teams within that range of 500.) * @param pageNum Page number of results to return, zero-indexed * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns string Successful response * @throws ApiError */ static getTeamsKeys(pageNum: number, ifNoneMatch?: string): Promise>; /** * Gets a list of `Team` objects that competed in the given year, paginated in groups of 500. * @param year Competition Year (or Season). Must be 4 digits. * @param pageNum Page number of results to return, zero-indexed * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Team Successful response * @throws ApiError */ static getTeamsByYear(year: number, pageNum: number, ifNoneMatch?: string): Promise>; /** * Gets a list of short form `Team_Simple` objects that competed in the given year, paginated in groups of 500. * @param year Competition Year (or Season). Must be 4 digits. * @param pageNum Page number of results to return, zero-indexed * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Team_Simple Successful response * @throws ApiError */ static getTeamsByYearSimple(year: number, pageNum: number, ifNoneMatch?: string): Promise>; /** * Gets a list Team Keys that competed in the given year, paginated in groups of 500. * @param year Competition Year (or Season). Must be 4 digits. * @param pageNum Page number of results to return, zero-indexed * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns string Successful response * @throws ApiError */ static getTeamsByYearKeys(year: number, pageNum: number, ifNoneMatch?: string): Promise>; /** * Gets a `Team` object for the team referenced by the given key. * @param teamKey TBA Team Key, eg `frc254` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Team Successful response * @throws ApiError */ static getTeam(teamKey: string, ifNoneMatch?: string): Promise; /** * Gets a `Team_Simple` object for the team referenced by the given key. * @param teamKey TBA Team Key, eg `frc254` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Team_Simple Successful response * @throws ApiError */ static getTeamSimple(teamKey: string, ifNoneMatch?: string): Promise; /** * Gets a list of years in which the team participated in at least one competition. * @param teamKey TBA Team Key, eg `frc254` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns number Successful response * @throws ApiError */ static getTeamYearsParticipated(teamKey: string, ifNoneMatch?: string): Promise>; /** * Gets an array of districts representing each year the team was in a district. Will return an empty array if the team was never in a district. * @param teamKey TBA Team Key, eg `frc254` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns District_List Successful response * @throws ApiError */ static getTeamDistricts(teamKey: string, ifNoneMatch?: string): Promise>; /** * Gets a list of year and robot name pairs for each year that a robot name was provided. Will return an empty array if the team has never named a robot. * @param teamKey TBA Team Key, eg `frc254` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Team_Robot Successful response * @throws ApiError */ static getTeamRobots(teamKey: string, ifNoneMatch?: string): Promise>; /** * Gets a list of all events this team has competed at. * @param teamKey TBA Team Key, eg `frc254` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Event Successful response * @throws ApiError */ static getTeamEvents(teamKey: string, ifNoneMatch?: string): Promise>; /** * Gets a short-form list of all events this team has competed at. * @param teamKey TBA Team Key, eg `frc254` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Event_Simple Successful response * @throws ApiError */ static getTeamEventsSimple(teamKey: string, ifNoneMatch?: string): Promise>; /** * Gets a list of the event keys for all events this team has competed at. * @param teamKey TBA Team Key, eg `frc254` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns string Successful response * @throws ApiError */ static getTeamEventsKeys(teamKey: string, ifNoneMatch?: string): Promise>; /** * Gets a list of events this team has competed at in the given year. * @param teamKey TBA Team Key, eg `frc254` * @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 getTeamEventsByYear(teamKey: string, year: number, ifNoneMatch?: string): Promise>; /** * Gets a short-form list of events this team has competed at in the given year. * @param teamKey TBA Team Key, eg `frc254` * @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 getTeamEventsByYearSimple(teamKey: string, year: number, ifNoneMatch?: string): Promise>; /** * Gets a list of the event keys for events this team has competed at in the given year. * @param teamKey TBA Team Key, eg `frc254` * @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 getTeamEventsByYearKeys(teamKey: string, year: number, ifNoneMatch?: string): Promise>; /** * Gets a list of matches for the given team and event. * @param teamKey TBA Team Key, eg `frc254` * @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 getTeamEventMatches(teamKey: string, eventKey: string, ifNoneMatch?: string): Promise>; /** * Gets a short-form list of matches for the given team and event. * @param teamKey TBA Team Key, eg `frc254` * @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 getTeamEventMatchesSimple(teamKey: string, eventKey: string, ifNoneMatch?: string): Promise>; /** * Gets a list of match keys for matches for the given team and event. * @param teamKey TBA Team Key, eg `frc254` * @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 getTeamEventMatchesKeys(teamKey: string, eventKey: string, ifNoneMatch?: string): Promise>; /** * Gets a list of awards the given team won at the given event. * @param teamKey TBA Team Key, eg `frc254` * @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 getTeamEventAwards(teamKey: string, eventKey: string, ifNoneMatch?: string): Promise>; /** * Gets the competition rank and status of the team at the given event. * @param teamKey TBA Team Key, eg `frc254` * @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 getTeamEventStatus(teamKey: string, eventKey: string, ifNoneMatch?: string): Promise; /** * Gets a list of awards the given team has won. * @param teamKey TBA Team Key, eg `frc254` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Award Successful response * @throws ApiError */ static getTeamAwards(teamKey: string, ifNoneMatch?: string): Promise>; /** * Gets a list of awards the given team has won in a given year. * @param teamKey TBA Team Key, eg `frc254` * @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 Award Successful response * @throws ApiError */ static getTeamAwardsByYear(teamKey: string, year: number, ifNoneMatch?: string): Promise>; /** * Gets a list of matches for the given team and year. * @param teamKey TBA Team Key, eg `frc254` * @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 Match Successful response * @throws ApiError */ static getTeamMatchesByYear(teamKey: string, year: number, ifNoneMatch?: string): Promise>; /** * Gets a short-form list of matches for the given team and year. * @param teamKey TBA Team Key, eg `frc254` * @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 Match_Simple Successful response * @throws ApiError */ static getTeamMatchesByYearSimple(teamKey: string, year: number, ifNoneMatch?: string): Promise>; /** * Gets a list of match keys for matches for the given team and year. * @param teamKey TBA Team Key, eg `frc254` * @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 getTeamMatchesByYearKeys(teamKey: string, year: number, ifNoneMatch?: string): Promise>; /** * Gets a list of Media (videos / pictures) for the given team and year. * @param teamKey TBA Team Key, eg `frc254` * @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 Media Successful response * @throws ApiError */ static getTeamMediaByYear(teamKey: string, year: number, ifNoneMatch?: string): Promise>; /** * Gets a list of Media (videos / pictures) for the given team and tag. * @param teamKey TBA Team Key, eg `frc254` * @param mediaTag Media Tag which describes the Media. * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Media Successful response * @throws ApiError */ static getTeamMediaByTag(teamKey: string, mediaTag: string, ifNoneMatch?: string): Promise>; /** * Gets a list of Media (videos / pictures) for the given team, tag and year. * @param teamKey TBA Team Key, eg `frc254` * @param mediaTag Media Tag which describes the Media. * @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 Media Successful response * @throws ApiError */ static getTeamMediaByTagYear(teamKey: string, mediaTag: string, year: number, ifNoneMatch?: string): Promise>; /** * Gets a list of Media (social media) for the given team. * @param teamKey TBA Team Key, eg `frc254` * @param ifNoneMatch Value of the `ETag` header in the most recently cached response by the client. * @returns Media Successful response * @throws ApiError */ static getTeamSocialMedia(teamKey: string, ifNoneMatch?: string): Promise>; }