cbbd/dist/sdk.gen.d.ts

This API is in limited Beta for Patreon subscribers. It may have bugs and is subject to changes. API keys can be acquired from the CollegeBasketballData.com website.

import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { GetVenuesData, GetTeamsData, GetTeamRosterData, GetSubstitutionsByGameData, GetSubstitutionsByPlayerIdData, GetSubstitutionsByTeamData, GetTeamSeasonStatsData, GetTeamSeasonShootingStatsData, GetPlayerSeasonStatsData, GetPlayerSeasonShootingStatsData, GetRecruitsData, GetSrsData, GetAdjustedEfficiencyData, GetRankingsData, GetPlaysData, GetPlaysByPlayerIdData, GetPlaysByTeamData, GetPlaysByDateData, GetPlaysByTournamentData, GetPlayTypesData, GetLineupsByTeamSeasonData, GetLineupStatsByGameData, GetLinesData, GetProvidersData, GetGamesData, GetBroadcastsData, GetGameTeamsData, GetGamePlayersData, GetDraftTeamsData, GetDraftPositionsData, GetDraftPicksData, GetConferencesData, GetConferenceHistoryData } from './types.gen';
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
    /**
     * You can provide a client instance returned by `createClient()` instead of
     * individual options. This might be also useful if you want to implement a
     * custom client.
     */
    client?: Client;
};
/**
 * Retrieves list of available venues
 */
export declare const getVenues: <ThrowOnError extends boolean = false>(options?: Options<GetVenuesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").VenueInfo[], unknown, ThrowOnError>;
/**
 * Retrieves historical team information
 */
export declare const getTeams: <ThrowOnError extends boolean = false>(options?: Options<GetTeamsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").TeamInfo[], unknown, ThrowOnError>;
/**
 * Retrieves team roster information
 */
export declare const getTeamRoster: <ThrowOnError extends boolean = false>(options: Options<GetTeamRosterData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").TeamRoster[], unknown, ThrowOnError>;
/**
 * Returns all player substitutions for a given game
 */
export declare const getSubstitutionsByGame: <ThrowOnError extends boolean = false>(options: Options<GetSubstitutionsByGameData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PlayerSubsititution[], unknown, ThrowOnError>;
/**
 * Retrieve all player substitutions for a given player and season
 */
export declare const getSubstitutionsByPlayerId: <ThrowOnError extends boolean = false>(options: Options<GetSubstitutionsByPlayerIdData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PlayerSubsititution[], unknown, ThrowOnError>;
/**
 * Retrieve all player substitutions for a given team and season
 */
export declare const getSubstitutionsByTeam: <ThrowOnError extends boolean = false>(options: Options<GetSubstitutionsByTeamData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PlayerSubsititution[], unknown, ThrowOnError>;
/**
 * Returns team season statistics by year or team
 */
export declare const getTeamSeasonStats: <ThrowOnError extends boolean = false>(options?: Options<GetTeamSeasonStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").TeamSeasonStats[], unknown, ThrowOnError>;
/**
 * Retrieves team season shooting statistics
 */
export declare const getTeamSeasonShootingStats: <ThrowOnError extends boolean = false>(options: Options<GetTeamSeasonShootingStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").SeasonShootingStats[], unknown, ThrowOnError>;
/**
 * Returns player statistics by season
 */
export declare const getPlayerSeasonStats: <ThrowOnError extends boolean = false>(options: Options<GetPlayerSeasonStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PlayerSeasonStats[], unknown, ThrowOnError>;
/**
 * Retrieves player season shooting statistics
 */
export declare const getPlayerSeasonShootingStats: <ThrowOnError extends boolean = false>(options: Options<GetPlayerSeasonShootingStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PlayerSeasonShootingStats[], unknown, ThrowOnError>;
/**
 * Retrieves historical composite player recruiting ranking and ratings
 */
export declare const getRecruits: <ThrowOnError extends boolean = false>(options?: Options<GetRecruitsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").Recruit[], unknown, ThrowOnError>;
/**
 * Retrieves SRS ratings for the provided season, team, or conference.
 */
export declare const getSrs: <ThrowOnError extends boolean = false>(options?: Options<GetSrsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").SrsInfo[], unknown, ThrowOnError>;
/**
 * Retrieves adjusted efficiency ratings for the provided season, team, or conference.
 */
export declare const getAdjustedEfficiency: <ThrowOnError extends boolean = false>(options?: Options<GetAdjustedEfficiencyData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").AdjustedEfficiencyInfo[], unknown, ThrowOnError>;
/**
 * Retrieves historical poll data
 */
export declare const getRankings: <ThrowOnError extends boolean = false>(options?: Options<GetRankingsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PollTeamInfo[], unknown, ThrowOnError>;
/**
 * Returns all plays for a given game
 */
export declare const getPlays: <ThrowOnError extends boolean = false>(options: Options<GetPlaysData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PlayInfo[], unknown, ThrowOnError>;
/**
 * Retrieve all plays for a given player and season
 */
export declare const getPlaysByPlayerId: <ThrowOnError extends boolean = false>(options: Options<GetPlaysByPlayerIdData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PlayInfo[], unknown, ThrowOnError>;
/**
 * Retrieve all plays for a given team and season
 */
export declare const getPlaysByTeam: <ThrowOnError extends boolean = false>(options: Options<GetPlaysByTeamData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PlayInfo[], unknown, ThrowOnError>;
/**
 * Retrieve all plays for a given UTC date
 */
export declare const getPlaysByDate: <ThrowOnError extends boolean = false>(options: Options<GetPlaysByDateData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PlayInfo[], unknown, ThrowOnError>;
/**
 * Retrieve all plays for a given tournament and season
 */
export declare const getPlaysByTournament: <ThrowOnError extends boolean = false>(options: Options<GetPlaysByTournamentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PlayInfo[], unknown, ThrowOnError>;
/**
 * Retrieve list of play types
 */
export declare const getPlayTypes: <ThrowOnError extends boolean = false>(options?: Options<GetPlayTypesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PlayTypeInfo[], unknown, ThrowOnError>;
/**
 * Queries lineup statistics for a given team and season
 */
export declare const getLineupsByTeamSeason: <ThrowOnError extends boolean = false>(options: Options<GetLineupsByTeamSeasonData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").LineupStats[], unknown, ThrowOnError>;
/**
 * Queries lineup statistics for a specific game
 */
export declare const getLineupStatsByGame: <ThrowOnError extends boolean = false>(options: Options<GetLineupStatsByGameData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").LineupStats[], unknown, ThrowOnError>;
/**
 * Returns betting lines for the first 3000 games that match the provided filters, ordered by start date.
 */
export declare const getLines: <ThrowOnError extends boolean = false>(options?: Options<GetLinesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GameLines[], unknown, ThrowOnError>;
export declare const getProviders: <ThrowOnError extends boolean = false>(options?: Options<GetProvidersData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").LineProviderInfo[], unknown, ThrowOnError>;
/**
 * Returns information on the first 3000 games that match the provided filters, ordered by start date.
 */
export declare const getGames: <ThrowOnError extends boolean = false>(options?: Options<GetGamesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GameInfo[], unknown, ThrowOnError>;
/**
 * Returns broadcast information on the first 3000 games that match the provided filters, ordered by start date.
 */
export declare const getBroadcasts: <ThrowOnError extends boolean = false>(options?: Options<GetBroadcastsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GameMediaInfo[], unknown, ThrowOnError>;
/**
 * Returns team box score statistics and metrics on the first 3000 games that match the provided filters, ordered by start date.
 */
export declare const getGameTeams: <ThrowOnError extends boolean = false>(options?: Options<GetGameTeamsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GameBoxScoreTeam[], unknown, ThrowOnError>;
/**
 * Returns player box score statistics and metrics on the first 1000 games that match the provided filters, ordered by start date.
 */
export declare const getGamePlayers: <ThrowOnError extends boolean = false>(options?: Options<GetGamePlayersData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GameBoxScorePlayers[], unknown, ThrowOnError>;
/**
 * Retrieves list of NBA teams
 */
export declare const getDraftTeams: <ThrowOnError extends boolean = false>(options?: Options<GetDraftTeamsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").DraftTeam[], unknown, ThrowOnError>;
/**
 * Retrieves list of position names for NBA draft prospects
 */
export declare const getDraftPositions: <ThrowOnError extends boolean = false>(options?: Options<GetDraftPositionsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").DraftPosition[], unknown, ThrowOnError>;
/**
 * Retrieves historical NBA draft picks
 */
export declare const getDraftPicks: <ThrowOnError extends boolean = false>(options?: Options<GetDraftPicksData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").DraftPick[], unknown, ThrowOnError>;
/**
 * Retrieves list of available conferences
 */
export declare const getConferences: <ThrowOnError extends boolean = false>(options?: Options<GetConferencesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").ConferenceInfo[], unknown, ThrowOnError>;
/**
 * Retrieves historical conference membership information
 */
export declare const getConferenceHistory: <ThrowOnError extends boolean = false>(options?: Options<GetConferenceHistoryData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").ConferenceHistory[], unknown, ThrowOnError>;