tbarequest/dist/types/endpoints/districts.d.ts

A wrapper to fetch data from The Blue Alliance API

export declare const districtEndpoints: {
    "/districts/{year}": {
        schema: import("arktype/internal/methods/array.ts").ArrayType<{
            abbreviation: string;
            display_name: string;
            key: string;
            year: number;
        }[], {}>;
        arguments: import("arktype/internal/methods/array.ts").ArrayType<[number], {}>;
    };
    "/district/{district_abbreviation}/history": {
        schema: import("arktype/internal/methods/array.ts").ArrayType<{
            abbreviation: string;
            display_name: string;
            key: string;
            year: number;
        }[], {}>;
        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
    };
    "/district/{district_key}/events": {
        schema: import("arktype/internal/methods/array.ts").ArrayType<{
            key: string;
            name: string;
            event_code: string;
            event_type: number;
            district: {
                abbreviation: string;
                display_name: string;
                key: string;
                year: number;
            } | null;
            city: string | null;
            state_prov: string | null;
            country: string | null;
            start_date: string;
            end_date: string;
            year: number;
            short_name: string | null;
            event_type_string: string;
            week: number | null;
            address: string | null;
            postal_code: string | null;
            gmaps_place_id: string | null;
            gmaps_url: string | null;
            lat: number | null;
            lng: number | null;
            location_name: string | null;
            timezone: string | null;
            website: string | null;
            first_event_id: string | null;
            first_event_code: string | null;
            webcasts: {
                type: "youtube" | "twitch" | "ustream" | "iframe" | "html5" | "rtmp" | "livestream" | "direct_link" | "mms" | "justin" | "stemtv" | "dacast";
                channel: string;
                date?: string | null | undefined;
                file?: string | null | undefined;
            }[];
            division_keys: string[];
            parent_event_key: string | null;
            playoff_type: number | null;
            playoff_type_string: string | null;
        }[], {}>;
        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
    };
    "/district/{district_key}/awards": {
        schema: import("arktype/internal/methods/array.ts").ArrayType<{
            name: string;
            award_type: number;
            event_key: string;
            recipient_list: {
                team_key: string | null;
                awardee: string | null;
            }[];
            year: number;
        }[], {}>;
        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
    };
    "/district/{district_key}/events/simple": {
        schema: import("arktype/internal/methods/array.ts").ArrayType<{
            key: string;
            name: string;
            event_code: string;
            event_type: number;
            district: {
                abbreviation: string;
                display_name: string;
                key: string;
                year: number;
            } | null;
            city: string | null;
            state_prov: string | null;
            country: string | null;
            start_date: string;
            end_date: string;
            year: number;
        }[], {}>;
        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
    };
    "/district/{district_key}/events/keys": {
        schema: import("arktype/internal/methods/array.ts").ArrayType<string[], {}>;
        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
    };
    "/district/{district_key}/teams": {
        schema: import("arktype/internal/methods/array.ts").ArrayType<{
            key: string;
            team_number: number;
            nickname: string;
            name: string;
            city: string | null;
            state_prov: string | null;
            country: string | null;
            postal_code: string | null;
            rookie_year: number | null;
            website?: string | null | undefined;
        }[], {}>;
        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
    };
    "/district/{district_key}/teams/simple": {
        schema: import("arktype/internal/methods/array.ts").ArrayType<{
            key: string;
            team_number: number;
            nickname: string;
            name: string;
            city: string | null;
            state_prov: string | null;
            country: string | null;
        }[], {}>;
        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
    };
    "/district/{district_key}/teams/keys": {
        schema: import("arktype/internal/methods/array.ts").ArrayType<string[], {}>;
        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
    };
    "/district/{district_key}/rankings": {
        schema: import("arktype").BaseType<{
            team_key: string;
            rank: number;
            point_total: number;
            rookie_bonus?: number | undefined;
            event_point?: {
                district_cmp: boolean;
                total: number;
                alliance_points: number;
                elim_points: number;
                award_points: number;
                event_key: string;
                qual_points: number;
            }[] | undefined;
        }[] | null, {}>;
        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
    };
    "/district/{district_key}/advancement": {
        schema: import("arktype").BaseType<{
            [x: string]: {
                dcmp: boolean;
                cmp: boolean;
            };
        } | null, {}>;
        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
    };
};