import { Team } from "./teams"; import { Skills } from "./skills"; import { Rankings } from "./rankings"; import { Match } from "./matches"; /** * Fetches event by SKU. * @param sku Event SKU * * @example * const event = await robotevents.events.get('RE-V5RC-24-5557'); * */ export declare function get(sku: string): Promise; /** * Fetches event by RobotEvents id. * @param id RobotEvents ID * * @example * const event = await robotevents.events.get(55557); * */ export declare function get(id: number): Promise; /** * Contains methods mirrored from RobotEvents API for /events. */ export declare class Event { id: number; sku: string; name: string; start: string; end: string; season: { id: number; name: string; code: null; }; program: { id: number; name: string; code: string; }; location: { venue: string; address_1: string; address_2: string; city: string; region: string; postcode: string; country: string; coordinates: { lat: number; lon: number; }; }; divisions: never[]; level: string; ongoing: boolean; awards_finalized: boolean; event_type: string; constructor(eventData?: Object); /** * Fetches teams of an event. * * @param options Object of perameters, mirrored from RobotEvents API - /events/{id}/teams * * @example * const event = await robotevents.events.get('RE-V5RC-24-5557'); * const teams = await event.teams({ * number: '11101B', * registered: true, * grade: "High School", * country: 'US' * }); * */ teams(options?: { number?: string; registered?: boolean; grade?: string; country?: string; }): Promise; /** * Fetches skills of an event. * * @param options Object of perameters, mirrored from RobotEvents API - /events/{id}/skills * * @example * const event = await robotevents.events.get('RE-V5RC-24-5557'); * const skills = await event.skills({ * teamId: 86313, * type: 'driver' * }); * */ skills(options?: { teamId?: number; type?: string; }): Promise; /** * Fetches awards of an event. * * @param options Object of perameters, mirrored from RobotEvents API - /events/{id}/awards * * @example * const event = await robotevents.events.get('RE-V5RC-24-5557'); * const awards = await event.awards({ * teamId: 86313, * winner: '11101B' * }); * */ awards(options?: { teamId?: number; winner?: string; }): Promise; /** * Fetches matches of an event (by division). * * @param options Object of perameters, mirrored from RobotEvents API - /events/{id}/divisions/{div}/matches * * @example * const event = await robotevents.events.get('RE-V5RC-24-5557'); * const matches = await event.matches({ * divId: 1, * teamId: 86313, * round: 'qualifications', * instance: 1, * matchnum: 16 * }); * */ matches(options?: { divId?: number; teamId?: number; round?: string; instance?: number; matchnum?: number; }): Promise; /** * Fetches rankings of an event (by division). * * @param options Object of perameters, mirrored from RobotEvents API - /events/{id}/divisions/{div}/rankings * * @example * const event = await robotevents.events.get('RE-V5RC-24-5557'); * const rankings = await event.rankings({ * divId: 1, * teamId: 86313, * rank: 7 * }); * */ rankings(options?: { divId?: number; teamId?: number; rank?: number; }): Promise; }