cfbd 5.21.0 → 5.23.0

package/dist/sdk.gen.d.ts

@@ -1,288 +1,295 @@
 import { type OptionsLegacyParser } from '@hey-api/client-fetch';
-import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarResponse, GetTeamsData, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsResponse, GetMatchupData, GetTeamsAtsData, GetTeamsAtsResponse, GetRosterData, GetRosterResponse, GetConferencesResponse, GetTalentData, GetTalentResponse, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsResponse, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsResponse, GetRecruitsData, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsResponse, GetSpData, GetSpResponse, GetConferenceSpData, GetConferenceSpResponse, GetSrsData, GetSrsResponse, GetExpandedSrsData, GetExpandedSrsResponse, GetEloData, GetEloResponse, GetFpiData, GetFpiResponse, GetRankingsData, GetRankingsError, GetRankingsResponse, GetPlaysData, GetPlaysResponse, GetPlayTypesResponse, GetPlayStatsData, GetPlayStatsResponse, GetPlayStatTypesResponse, GetCfpPlayoffData, GetCfpPlayoffError, GetCfpParticipantsData, GetCfpParticipantsError, GetCfpParticipantsResponse, GetCfpGamesData, GetCfpGamesError, GetCfpGamesResponse, SearchPlayersData, SearchPlayersResponse, GetPlayerUsageData, GetPlayerUsageResponse, GetPlayerSeasonOverviewData, GetReturningProductionData, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalResponse, GetPredictedPointsData, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLinesData, GetLinesResponse, GetUserInfoResponse, GetUsageData, GetUsageResponse, GetGamesData, GetGamesError, GetGamesResponse, GetGameTeamStatsData, GetGameTeamStatsResponse, GetGamePlayerStatsData, GetGamePlayerStatsResponse, GetMediaData, GetMediaResponse, GetWeatherData, GetWeatherResponse, GetRecordsData, GetRecordsResponse, GetCalendarData, GetCalendarResponse, GetScoreboardData, GetScoreboardResponse, GetDrivesData, GetDrivesResponse, GetDraftTeamsResponse, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksResponse, GetCoachesData, GetCoachesResponse, GetCoachProfileData, GetCoachProfileError, GetCoachSeasonsData, GetCoachSeasonsError, GetCoachSeasonsResponse, GetCoachTenuresData, GetCoachTenuresError, GetCoachTenuresResponse, GetAdvancedBoxScoreData } from './types.gen';
+import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarResponse, GetTeamsData, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsResponse, GetMatchupData, GetTeamsAtsData, GetTeamsAtsResponse, GetRosterData, GetRosterResponse, GetConferencesResponse, GetTalentData, GetTalentResponse, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsResponse, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsResponse, GetRecruitsData, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsResponse, GetCoreData, GetCoreResponse, GetSpData, GetSpResponse, GetConferenceSpData, GetConferenceSpResponse, GetSrsData, GetSrsResponse, GetExpandedSrsData, GetExpandedSrsResponse, GetEloData, GetEloResponse, GetFpiData, GetFpiResponse, GetRankingsData, GetRankingsError, GetRankingsResponse, GetPlaysData, GetPlaysResponse, GetPlayTypesResponse, GetPlayStatsData, GetPlayStatsResponse, GetPlayStatTypesResponse, GetCfpPlayoffData, GetCfpPlayoffError, GetCfpParticipantsData, GetCfpParticipantsError, GetCfpParticipantsResponse, GetCfpGamesData, GetCfpGamesError, GetCfpGamesResponse, SearchPlayersData, SearchPlayersResponse, GetPlayerUsageData, GetPlayerUsageResponse, GetPlayerSeasonOverviewData, GetReturningProductionData, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalResponse, GetPredictedPointsData, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLinesData, GetLinesResponse, GetUserInfoResponse, GetUsageData, GetUsageResponse, GetGamesData, GetGamesError, GetGamesResponse, GetGameTeamStatsData, GetGameTeamStatsResponse, GetGamePlayerStatsData, GetGamePlayerStatsResponse, GetMediaData, GetMediaResponse, GetWeatherData, GetWeatherResponse, GetRecordsData, GetRecordsResponse, GetCalendarData, GetCalendarResponse, GetScoreboardData, GetScoreboardResponse, GetDrivesData, GetDrivesResponse, GetDraftTeamsResponse, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksResponse, GetCoachesData, GetCoachesResponse, GetCoachProfileData, GetCoachProfileError, GetCoachSeasonsData, GetCoachSeasonsError, GetCoachSeasonsResponse, GetCoachTenuresData, GetCoachTenuresError, GetCoachTenuresResponse, GetAdvancedBoxScoreData } from './types.gen';
 export declare const client: import("@hey-api/client-fetch").Client<Request, Response, unknown, import("@hey-api/client-fetch").RequestOptions<boolean, string>>;
 /**
- * Retrieve opponent-adjusted team season statistics
+ * Returns opponent-adjusted team statistics by season.
  */
 export declare const getAdjustedTeamSeasonStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdjustedTeamSeasonStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAdjustedTeamSeasonStatsResponse, unknown, ThrowOnError>;
 /**
- * Retrieve opponent-adjusted player passing statistics
+ * Returns opponent-adjusted player passing metrics.
  */
 export declare const getAdjustedPlayerPassingStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdjustedPlayerPassingStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAdjustedPlayerPassingStatsResponse, unknown, ThrowOnError>;
 /**
- * Retrieve opponent-adjusted player rushing statistics
+ * Returns opponent-adjusted player rushing metrics.
  */
 export declare const getAdjustedPlayerRushingStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdjustedPlayerRushingStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAdjustedPlayerRushingStatsResponse, unknown, ThrowOnError>;
 /**
- * Retrieve Points Added Above Replacement (PAAR) ratings for kickers
+ * Returns Points Added Above Replacement (PAAR) ratings for kickers.
  */
 export declare const getKickerPaar: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetKickerPaarData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetKickerPaarResponse, unknown, ThrowOnError>;
 /**
- * Retrieves team information
+ * Returns team information and conference affiliations.
  */
 export declare const getTeams: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTeamsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves information on teams playing in the highest division of CFB
+ * Returns Football Bowl Subdivision (FBS) teams for a season.
  */
 export declare const getFbsTeams: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetFbsTeamsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFbsTeamsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves historical matchup details for two given teams
+ * Returns historical matchup results between two teams.
  */
 export declare const getMatchup: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetMatchupData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").Matchup, unknown, ThrowOnError>;
 /**
- * Retrieves against-the-spread (ATS) summary by team
+ * Returns against-the-spread (ATS) records by team.
  */
 export declare const getTeamsAts: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTeamsAtsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTeamsAtsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves historical roster data
+ * Returns historical roster data.
  */
 export declare const getRoster: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetRosterData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRosterResponse, unknown, ThrowOnError>;
 /**
- * Retrieves list of conferences
+ * Returns the available conferences.
  */
 export declare const getConferences: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetConferencesResponse, unknown, ThrowOnError>;
 /**
- * Retrieve 247 Team Talent Composite for a given year
+ * Returns 247Sports Team Talent Composite ratings for a season.
  */
 export declare const getTalent: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTalentData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTalentResponse, unknown, ThrowOnError>;
 /**
- * Retrieve list of venues
+ * Returns college football venues.
  */
 export declare const getVenues: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetVenuesResponse, unknown, ThrowOnError>;
 /**
- * Retrieves aggregated player statistics for a given season
+ * Returns player statistics aggregated by season.
  */
 export declare const getPlayerSeasonStats: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerSeasonStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerSeasonStatsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves player passing and rushing success rates by season
+ * Returns player passing and rushing success rates by season.
  */
 export declare const getPlayerSeasonSuccessRates: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPlayerSeasonSuccessRatesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerSeasonSuccessRatesResponse, unknown, ThrowOnError>;
 /**
- * Retrieves player passing and rushing success rates by game
+ * Returns player passing and rushing success rates by game.
  */
 export declare const getPlayerGameSuccessRates: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerGameSuccessRatesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerGameSuccessRatesResponse, unknown, ThrowOnError>;
 /**
- * Retrieves aggregated team season statistics
+ * Returns team statistics aggregated by season.
  */
 export declare const getTeamStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTeamStatsResponse, unknown, ThrowOnError>;
 /**
- * Gets team statistical categories
+ * Returns the available team statistical categories.
  */
 export declare const getCategories: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCategoriesResponse, unknown, ThrowOnError>;
 /**
- * Retrieves advanced season statistics for teams
+ * Returns advanced team statistics aggregated by season.
  */
 export declare const getAdvancedSeasonStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdvancedSeasonStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAdvancedSeasonStatsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves advanced statistics aggregated by game
+ * Returns advanced team statistics aggregated by game.
  */
 export declare const getAdvancedGameStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAdvancedGameStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAdvancedGameStatsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves havoc statistics aggregated by game
+ * Returns team havoc statistics aggregated by game.
  */
 export declare const getGameHavocStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGameHavocStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetGameHavocStatsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves player recruiting rankings
+ * Returns player recruiting rankings.
  */
 export declare const getRecruits: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetRecruitsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRecruitsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves team recruiting rankings
+ * Returns team recruiting rankings.
  */
 export declare const getTeamRecruitingRankings: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamRecruitingRankingsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTeamRecruitingRankingsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves aggregated recruiting statistics by team and position grouping
+ * Returns recruiting ratings aggregated by team and position group.
  */
 export declare const getAggregatedTeamRecruitingRatings: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetAggregatedTeamRecruitingRatingsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetAggregatedTeamRecruitingRatingsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves SP+ ratings for a given year or school
+ * Returns Context & Opponent-Relative Efficiency (CORE) ratings.
+ * At least one of `year` or `team` is required.
+ */
+export declare const getCore: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetCoreData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCoreResponse, unknown, ThrowOnError>;
+/**
+ * Returns SP+ ratings by team and season.
  */
 export declare const getSp: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetSpData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSpResponse, unknown, ThrowOnError>;
 /**
- * Retrieves aggregated historical conference SP+ data
+ * Returns conference-level SP+ ratings by season.
  */
 export declare const getConferenceSp: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetConferenceSpData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetConferenceSpResponse, unknown, ThrowOnError>;
 /**
- * Retrieves historical SRS for a year or team
+ * Returns Simple Rating System (SRS) ratings by team and season.
  */
 export declare const getSrs: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetSrsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSrsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves expanded historical SRS (including FCS) for a year or team
+ * Returns expanded Simple Rating System (SRS) ratings, including FCS teams.
  */
 export declare const getExpandedSrs: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetExpandedSrsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetExpandedSrsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves historical Elo ratings
+ * Returns historical Elo ratings.
  */
 export declare const getElo: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetEloData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetEloResponse, unknown, ThrowOnError>;
 /**
- * Retrieves historical Football Power Index (FPI) ratings
+ * Returns historical Football Power Index (FPI) ratings.
  */
 export declare const getFpi: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetFpiData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFpiResponse, unknown, ThrowOnError>;
 /**
- * Retrieves historical poll data
+ * Returns historical poll rankings.
  */
 export declare const getRankings: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetRankingsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRankingsResponse, GetRankingsError, ThrowOnError>;
 /**
- * Retrieves historical play data
+ * Returns historical play-by-play data.
  */
 export declare const getPlays: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlaysData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlaysResponse, unknown, ThrowOnError>;
 /**
- * Retrieves available play types
+ * Returns the available play types.
  */
 export declare const getPlayTypes: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayTypesResponse, unknown, ThrowOnError>;
 /**
- * Retrieve player-play associations (limit 2000)
+ * Returns player and play-stat associations, limited to 2,000 records.
  */
 export declare const getPlayStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPlayStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayStatsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves available play stat types
+ * Returns the available play stat types.
  */
 export declare const getPlayStatTypes: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayStatTypesResponse, unknown, ThrowOnError>;
 /**
- * Retrieves the complete College Football Playoff bracket for a season
+ * Returns the complete College Football Playoff bracket for a season.
  */
 export declare const getCfpPlayoff: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpPlayoffData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").CfpPlayoff, GetCfpPlayoffError, ThrowOnError>;
 /**
- * Retrieves College Football Playoff participants for a season
+ * Returns College Football Playoff participants for a season.
  */
 export declare const getCfpParticipants: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpParticipantsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCfpParticipantsResponse, GetCfpParticipantsError, ThrowOnError>;
 /**
- * Retrieves College Football Playoff matchups for a season
+ * Returns College Football Playoff matchups for a season.
  */
 export declare const getCfpGames: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCfpGamesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCfpGamesResponse, GetCfpGamesError, ThrowOnError>;
 /**
- * Search for players (lists top 100 results)
+ * Returns up to 100 players whose names match the search term.
  */
 export declare const searchPlayers: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<SearchPlayersData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<SearchPlayersResponse, unknown, ThrowOnError>;
 /**
- * Retrieves player usage data for a given season
+ * Returns player usage metrics for a season.
  */
 export declare const getPlayerUsage: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerUsageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPlayerUsageResponse, unknown, ThrowOnError>;
 /**
- * Retrieves a player season overview with box score, usage, and PPA data
+ * Returns a player season overview with box score, usage, and Predicted
+ * Points Added (PPA) data.
  */
 export declare const getPlayerSeasonOverview: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerSeasonOverviewData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PlayerSeasonOverview, unknown, ThrowOnError>;
 /**
- * Retrieves returning production data. Either a year or team filter must be specified.
+ * Returns returning production metrics by team and season.
  */
 export declare const getReturningProduction: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetReturningProductionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetReturningProductionResponse, unknown, ThrowOnError>;
 /**
- * Retrieves transfer portal data for a given year
+ * Returns transfer portal entries for a season.
  */
 export declare const getTransferPortal: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTransferPortalData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetTransferPortalResponse, unknown, ThrowOnError>;
 /**
- * Query Predicted Points values by down and distance
+ * Returns predicted points values by down and distance.
  */
 export declare const getPredictedPoints: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPredictedPointsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPredictedPointsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves historical team PPA metrics by season
+ * Returns team Predicted Points Added (PPA) metrics by season.
  */
 export declare const getPredictedPointsAddedByTeam: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPredictedPointsAddedByTeamData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPredictedPointsAddedByTeamResponse, unknown, ThrowOnError>;
 /**
- * Retrieves historical team PPA metrics by game
+ * Returns team Predicted Points Added (PPA) metrics by game.
  */
 export declare const getPredictedPointsAddedByGame: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPredictedPointsAddedByGameData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPredictedPointsAddedByGameResponse, unknown, ThrowOnError>;
 /**
- * Queries player PPA statistics by game
+ * Returns player Predicted Points Added (PPA) metrics by game.
  */
 export declare const getPredictedPointsAddedByPlayerGame: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPredictedPointsAddedByPlayerGameData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPredictedPointsAddedByPlayerGameResponse, unknown, ThrowOnError>;
 /**
- * Queries player PPA statistics by season
+ * Returns player Predicted Points Added (PPA) metrics by season.
  */
 export declare const getPredictedPointsAddedByPlayerSeason: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPredictedPointsAddedByPlayerSeasonData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPredictedPointsAddedByPlayerSeasonResponse, unknown, ThrowOnError>;
 /**
- * Query play win probabilities by game
+ * Returns play-by-play win probabilities for a game.
  */
 export declare const getWinProbability: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetWinProbabilityData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetWinProbabilityResponse, unknown, ThrowOnError>;
 /**
- * Queries pregame win probabilities
+ * Returns pregame win probabilities.
  */
 export declare const getPregameWinProbabilities: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPregameWinProbabilitiesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetPregameWinProbabilitiesResponse, unknown, ThrowOnError>;
 /**
- * Queries field goal expected points values
+ * Returns expected points values for field goal attempts.
  */
 export declare const getFieldGoalExpectedPoints: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetFieldGoalExpectedPointsResponse, unknown, ThrowOnError>;
 /**
- * Queries live play-by-play data and advanced stats
+ * Returns live play-by-play data and advanced metrics for a game.
  */
 export declare const getLivePlays: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetLivePlaysData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").LiveGame, unknown, ThrowOnError>;
 /**
- * Retrieves historical betting data
+ * Returns historical betting lines and results.
  */
 export declare const getLines: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetLinesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetLinesResponse, unknown, ThrowOnError>;
 /**
- * Retrieves information about the user, including their Patreon level and remaining API calls.
+ * Returns the authenticated user's Patreon level and remaining API calls.
+ * Returns `null` when the request is not authenticated.
  */
 export declare const getUserInfo: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetUserInfoResponse, unknown, ThrowOnError>;
 /**
- * Retrieves bounded API usage for the authenticated user's shared CFB/CBB call pool.
+ * Returns recent usage for the authenticated user's shared CFB and CBB call
+ * pool. Returns `null` when the request is not authenticated.
  */
 export declare const getUsage: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetUsageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetUsageResponse, unknown, ThrowOnError>;
 /**
- * Retrieves historical game data
+ * Returns historical game data.
  */
 export declare const getGames: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGamesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetGamesResponse, GetGamesError, ThrowOnError>;
 /**
- * Retrieves team box score statistics
+ * Returns team box score statistics by game.
  */
 export declare const getGameTeamStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGameTeamStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetGameTeamStatsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves player box score statistics
+ * Returns player box score statistics by game.
  */
 export declare const getGamePlayerStats: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGamePlayerStatsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetGamePlayerStatsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves media information for games
+ * Returns broadcast and media information for games.
  */
 export declare const getMedia: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetMediaData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetMediaResponse, unknown, ThrowOnError>;
 /**
- * Retrieve historical and future weather data (Patreon only)
+ * Returns historical and forecast weather data for games. Requires Patreon.
  */
 export declare const getWeather: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetWeatherData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetWeatherResponse, unknown, ThrowOnError>;
 /**
- * Retrieves historical team records
+ * Returns historical team records by season.
  */
 export declare const getRecords: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetRecordsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetRecordsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves calendar information
+ * Returns the week-by-week season calendar.
  */
 export declare const getCalendar: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCalendarData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCalendarResponse, unknown, ThrowOnError>;
 /**
- * Retrieves live scoreboard data
+ * Returns current scoreboard data.
  */
 export declare const getScoreboard: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetScoreboardData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetScoreboardResponse, unknown, ThrowOnError>;
 /**
- * Retrieves historical drive data
+ * Returns historical drive data.
  */
 export declare const getDrives: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetDrivesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetDrivesResponse, unknown, ThrowOnError>;
 /**
- * Retrieves list of NFL teams
+ * Returns the NFL teams represented in draft data.
  */
 export declare const getDraftTeams: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetDraftTeamsResponse, unknown, ThrowOnError>;
 /**
- * Retrieves list of player position categories for the NFL Draft
+ * Returns the player position categories used in NFL Draft data.
  */
 export declare const getDraftPositions: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<unknown, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetDraftPositionsResponse, unknown, ThrowOnError>;
 /**
- * Retrieve historical NFL draft data
+ * Returns historical NFL Draft picks.
  */
 export declare const getDraftPicks: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetDraftPicksData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetDraftPicksResponse, unknown, ThrowOnError>;
 /**
- * Retrieves historical head coach information and records
+ * Returns historical head coach records.
  */
 export declare const getCoaches: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetCoachesData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCoachesResponse, unknown, ThrowOnError>;
 /**
- * Retrieves canonical coach identity and complete career totals
+ * Returns a coach profile with canonical identity and career totals.
  */
 export declare const getCoachProfile: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetCoachProfileData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").CoachProfile, GetCoachProfileError, ThrowOnError>;
 /**
- * Retrieves detailed coach-season records with attributed results and
- * whole-team season context
+ * Returns coach-season records with attributed results and team context.
  */
 export declare const getCoachSeasons: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetCoachSeasonsData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCoachSeasonsResponse, GetCoachSeasonsError, ThrowOnError>;
 /**
- * Retrieves continuous head-coaching stints and attributed records
+ * Returns continuous head-coaching tenures and their attributed records.
  */
 export declare const getCoachTenures: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetCoachTenuresData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetCoachTenuresResponse, GetCoachTenuresError, ThrowOnError>;
 /**
- * Retrieves an advanced box score for a game
+ * Returns an advanced box score for a game.
  */
 export declare const getAdvancedBoxScore: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdvancedBoxScoreData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").AdvancedBoxScore, unknown, ThrowOnError>;