cfbd 5.21.0 → 5.22.0

package/dist/types.gen.d.ts

@@ -1741,15 +1741,15 @@ export type Venue = {
 export type GetAdjustedTeamSeasonStatsData = {
     query?: {
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional year filter
+         * Season year.
          */
         year?: number;
     };
@@ -1759,19 +1759,19 @@ export type GetAdjustedTeamSeasonStatsError = unknown;
 export type GetAdjustedPlayerPassingStatsData = {
     query?: {
         /**
-         * Optional conference abbreviation filter
+         * Conference abbreviation.
          */
         conference?: string;
         /**
-         * Optional position abbreviation filter
+         * Player position abbreviation.
          */
         position?: string;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional year filter
+         * Season year.
          */
         year?: number;
     };
@@ -1781,19 +1781,19 @@ export type GetAdjustedPlayerPassingStatsError = unknown;
 export type GetAdjustedPlayerRushingStatsData = {
     query?: {
         /**
-         * Optional conference abbreviation filter
+         * Conference abbreviation.
          */
         conference?: string;
         /**
-         * Optional position abbreviation filter
+         * Player position abbreviation.
          */
         position?: string;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional year filter
+         * Season year.
          */
         year?: number;
     };
@@ -1803,15 +1803,15 @@ export type GetAdjustedPlayerRushingStatsError = unknown;
 export type GetKickerPaarData = {
     query?: {
         /**
-         * Optional conference abbreviation filter
+         * Conference abbreviation.
          */
         conference?: string;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional year filter
+         * Season year.
          */
         year?: number;
     };
@@ -1821,11 +1821,11 @@ export type GetKickerPaarError = unknown;
 export type GetTeamsData = {
     query?: {
         /**
-         * Optional conference abbreviation filter
+         * Conference abbreviation.
          */
         conference?: string;
         /**
-         * Optional year filter to get historical conference affiliations
+         * Season year for historical conference affiliations.
          */
         year?: number;
     };
@@ -1835,7 +1835,7 @@ export type GetTeamsError = unknown;
 export type GetFbsTeamsData = {
     query?: {
         /**
-         * Year or season
+         * Season year.
          */
         year?: number;
     };
@@ -1845,19 +1845,19 @@ export type GetFbsTeamsError = unknown;
 export type GetMatchupData = {
     query: {
         /**
-         * Optional ending year
+         * Latest season year to include.
          */
         maxYear?: number;
         /**
-         * Optional starting year
+         * Earliest season year to include.
          */
         minYear?: number;
         /**
-         * First team to compare
+         * First team name.
          */
         team1: string;
         /**
-         * Second team to compare
+         * Second team name.
          */
         team2: string;
     };
@@ -1867,15 +1867,15 @@ export type GetMatchupError = unknown;
 export type GetTeamsAtsData = {
     query: {
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -1885,15 +1885,15 @@ export type GetTeamsAtsError = unknown;
 export type GetRosterData = {
     query?: {
         /**
-         * Optional filter to only include players from FBS or FCS teams
+         * Division classification: `fbs` or `fcs`.
          */
         classification?: DivisionClassification;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional year filter, defaults to 2025
+         * Season year. Defaults to 2025.
          */
         year?: number;
     };
@@ -1905,7 +1905,7 @@ export type GetConferencesError = unknown;
 export type GetTalentData = {
     query: {
         /**
-         * Year filter
+         * Season year.
          */
         year: number;
     };
@@ -1917,31 +1917,31 @@ export type GetVenuesError = unknown;
 export type GetPlayerSeasonStatsData = {
     query: {
         /**
-         * Optional category filter
+         * Statistical category.
          */
         category?: string;
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Optional ending week range
+         * Latest week to include.
          */
         endWeek?: number;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional starting week range
+         * Earliest week to include.
          */
         startWeek?: number;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -1951,39 +1951,39 @@ export type GetPlayerSeasonStatsError = unknown;
 export type GetPlayerSeasonSuccessRatesData = {
     query?: {
         /**
-         * Optional conference abbreviation filter
+         * Conference abbreviation.
          */
         conference?: string;
         /**
-         * Optional ending week range
+         * Latest week to include.
          */
         endWeek?: number;
         /**
-         * Optional flag to exclude garbage time plays
+         * Excludes garbage-time plays when `true`.
          */
         excludeGarbageTime?: boolean;
         /**
-         * Player ID filter, required if year not specified
+         * Player ID. Required unless `year` is specified.
          */
         playerId?: number;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional starting week range
+         * Earliest week to include.
          */
         startWeek?: number;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional minimum credited passing plus rushing plays
+         * Minimum credited passing and rushing plays.
          */
         threshold?: number;
         /**
-         * Year filter, required if playerId not specified
+         * Season year. Required unless `playerId` is specified.
          */
         year?: number;
     };
@@ -1993,35 +1993,35 @@ export type GetPlayerSeasonSuccessRatesError = unknown;
 export type GetPlayerGameSuccessRatesData = {
     query: {
         /**
-         * Optional conference abbreviation filter
+         * Conference abbreviation.
          */
         conference?: string;
         /**
-         * Optional flag to exclude garbage time plays
+         * Excludes garbage-time plays when `true`.
          */
         excludeGarbageTime?: boolean;
         /**
-         * Optional player ID filter
+         * Player ID.
          */
         playerId?: number;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional minimum credited passing plus rushing plays
+         * Minimum credited passing and rushing plays.
          */
         threshold?: number;
         /**
-         * Week filter, required if team and playerId not specified
+         * Week number. Required unless `team` or `playerId` is specified.
          */
         week?: number;
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -2031,27 +2031,27 @@ export type GetPlayerGameSuccessRatesError = unknown;
 export type GetTeamStatsData = {
     query?: {
         /**
-         * Optional division classification filter, defaults to fbs
+         * Division classification. Defaults to `fbs`.
          */
         classification?: DivisionClassification;
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Optional week end range filter
+         * Latest week to include.
          */
         endWeek?: number;
         /**
-         * Optional week start range filter
+         * Earliest week to include.
          */
         startWeek?: number;
         /**
-         * Team filter, required if year not specified
+         * Team name. Required unless `year` is specified.
          */
         team?: string;
         /**
-         * Year filter, required if team not specified
+         * Season year. Required unless `team` is specified.
          */
         year?: number;
     };
@@ -2063,27 +2063,28 @@ export type GetCategoriesError = unknown;
 export type GetAdvancedSeasonStatsData = {
     query?: {
         /**
-         * Optional division classification filter, defaults to fbs
+         * Division classification. Defaults to `fbs`.
          */
         classification?: DivisionClassification;
         /**
-         * Optional end week range filter
+         * Latest week to include.
          */
         endWeek?: number;
         /**
-         * Garbage time exclusion filter, defaults to false
+         * Excludes garbage-time plays when `true`. Defaults
+         * to `false`.
          */
         excludeGarbageTime?: boolean;
         /**
-         * Optional start week range filter
+         * Earliest week to include.
          */
         startWeek?: number;
         /**
-         * Team filter, required if year not specified
+         * Team name. Required unless `year` is specified.
          */
         team?: string;
         /**
-         * Year filter, required if team not specified
+         * Season year. Required unless `team` is specified.
          */
         year?: number;
     };
@@ -2093,27 +2094,28 @@ export type GetAdvancedSeasonStatsError = unknown;
 export type GetAdvancedGameStatsData = {
     query?: {
         /**
-         * Garbage time exclusion filter, defaults to false
+         * Excludes garbage-time plays when `true`. Defaults
+         * to `false`.
          */
         excludeGarbageTime?: boolean;
         /**
-         * Optional opponent filter
+         * Opponent team name.
          */
         opponent?: string;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Team filter, required if year not specified
+         * Team name. Required unless `year` is specified.
          */
         team?: string;
         /**
-         * Optional week filter
+         * Week number.
          */
         week?: number;
         /**
-         * Year filter, required if team not specified
+         * Season year. Required unless `team` is specified.
          */
         year?: number;
     };
@@ -2123,23 +2125,23 @@ export type GetAdvancedGameStatsError = unknown;
 export type GetGameHavocStatsData = {
     query?: {
         /**
-         * Optional opponent filter
+         * Opponent team name.
          */
         opponent?: string;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Team filter, required if year not specified
+         * Team name. Required unless `year` is specified.
          */
         team?: string;
         /**
-         * Optional week filter
+         * Week number.
          */
         week?: number;
         /**
-         * Year filter, required if team not specified
+         * Season year. Required unless `team` is specified.
          */
         year?: number;
     };
@@ -2149,23 +2151,23 @@ export type GetGameHavocStatsError = unknown;
 export type GetRecruitsData = {
     query?: {
         /**
-         * Optional recruit type classification filter, defaults to HighSchool
+         * Recruit classification. Defaults to `HighSchool`.
          */
         classification?: RecruitClassification;
         /**
-         * Optional position categorization filter
+         * Position category.
          */
         position?: string;
         /**
-         * Optional state/province filter
+         * State or province abbreviation.
          */
         state?: string;
         /**
-         * Team filter, required when no team specified
+         * Team name. Required unless `year` is specified.
          */
         team?: string;
         /**
-         * Year filter, required when no team specified
+         * Recruiting class year. Required unless `team` is specified.
          */
         year?: number;
     };
@@ -2175,11 +2177,11 @@ export type GetRecruitsError = unknown;
 export type GetTeamRecruitingRankingsData = {
     query?: {
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional year filter
+         * Recruiting class year.
          */
         year?: number;
     };
@@ -2189,23 +2191,23 @@ export type GetTeamRecruitingRankingsError = unknown;
 export type GetAggregatedTeamRecruitingRatingsData = {
     query?: {
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Optional end year range, defaults to current year
+         * Latest recruiting class year. Defaults to the current year.
          */
         endYear?: number;
         /**
-         * Optional recruit type filter, defaults to HighSchool
+         * Recruit classification. Defaults to `HighSchool`.
          */
         recruitType?: RecruitClassification;
         /**
-         * Optional start year range, defaults to 2000
+         * Earliest recruiting class year. Defaults to 2000.
          */
         startYear?: number;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
     };
@@ -2215,11 +2217,11 @@ export type GetAggregatedTeamRecruitingRatingsError = unknown;
 export type GetSpData = {
     query?: {
         /**
-         * Team filter, required if year not specified
+         * Team name. Required unless `year` is specified.
          */
         team?: string;
         /**
-         * Year filter, required if team not specified
+         * Season year. Required unless `team` is specified.
          */
         year?: number;
     };
@@ -2229,15 +2231,15 @@ export type GetSpError = unknown;
 export type GetConferenceSpData = {
     query?: {
         /**
-         * Optional division classification filter, defaults to fbs
+         * Division classification. Defaults to `fbs`.
          */
         classification?: DivisionClassification;
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Optional year filter
+         * Season year.
          */
         year?: number;
     };
@@ -2247,15 +2249,15 @@ export type GetConferenceSpError = unknown;
 export type GetSrsData = {
     query?: {
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Team filter, required if year not specified
+         * Team name. Required unless `year` is specified.
          */
         team?: string;
         /**
-         * Year filter, required if team not specified
+         * Season year. Required unless `team` is specified.
          */
         year?: number;
     };
@@ -2265,19 +2267,19 @@ export type GetSrsError = unknown;
 export type GetExpandedSrsData = {
     query?: {
         /**
-         * Optional division classification filter (fbs or fcs)
+         * Division classification: `fbs` or `fcs`.
          */
         classification?: DivisionClassification;
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Team filter, required if year not specified
+         * Team name. Required unless `year` is specified.
          */
         team?: string;
         /**
-         * Year filter, required if team not specified
+         * Season year. Required unless `team` is specified.
          */
         year?: number;
     };
@@ -2287,23 +2289,24 @@ export type GetExpandedSrsError = unknown;
 export type GetEloData = {
     query?: {
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional week filter, defaults to last available week in the season
+         * Week number. Defaults to the latest available week in the
+         * season.
          */
         week?: number;
         /**
-         * Optional year filter
+         * Season year.
          */
         year?: number;
     };
@@ -2313,15 +2316,15 @@ export type GetEloError = unknown;
 export type GetFpiData = {
     query?: {
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * team filter, required if year not specified
+         * Team name. Required unless `year` is specified.
          */
         team?: string;
         /**
-         * year filter, required if team not specified
+         * Season year. Required unless `team` is specified.
          */
         year?: number;
     };
@@ -2331,27 +2334,30 @@ export type GetFpiError = unknown;
 export type GetRankingsData = {
     query: {
         /**
-         * Return the marked final CFP snapshot
+         * Returns the CFP snapshot marked as final when `true`. Requires
+         * `poll=cfp` and cannot be combined with `latest`.
          */
         final?: boolean;
         /**
-         * Return the latest CFP snapshot, preferring the marked final
+         * Returns the latest CFP snapshot when `true`, preferring the
+         * snapshot marked as final. Requires `poll=cfp` and cannot be combined with
+         * `final`.
          */
         latest?: boolean;
         /**
-         * Optional poll filter
+         * Poll name.
          */
         poll?: RankingPoll;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional week filter
+         * Poll week.
          */
         week?: number;
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -2363,47 +2369,47 @@ export type GetRankingsError = ({
 export type GetPlaysData = {
     query: {
         /**
-         * Optional division classification filter
+         * Division classification of either team.
          */
         classification?: DivisionClassification;
         /**
-         * Optional conference filter
+         * Conference of either team.
          */
         conference?: string;
         /**
-         * Optional defensive team filter
+         * Defensive team name.
          */
         defense?: string;
         /**
-         * Optional defensive conference filter
+         * Defensive team conference.
          */
         defenseConference?: string;
         /**
-         * Optional offensive team filter
+         * Offensive team name.
          */
         offense?: string;
         /**
-         * Optional offensive conference filter
+         * Offensive team conference.
          */
         offenseConference?: string;
         /**
-         * Optoinal play type abbreviation filter
+         * Play type abbreviation.
          */
         playType?: string;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional team filter
+         * Team name on either side of the play.
          */
         team?: string;
         /**
-         * Required week filter
+         * Week number.
          */
         week: number;
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -2415,35 +2421,35 @@ export type GetPlayTypesError = unknown;
 export type GetPlayStatsData = {
     query?: {
         /**
-         * Optional athleteId filter
+         * Athlete ID.
          */
         athleteId?: number;
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Optional gameId filter
+         * Game ID.
          */
         gameId?: number;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional statTypeId filter
+         * Play stat type ID.
          */
         statTypeId?: number;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional week filter
+         * Week number.
          */
         week?: number;
         /**
-         * Optional year filter
+         * Season year.
          */
         year?: number;
     };
@@ -2455,7 +2461,7 @@ export type GetPlayStatTypesError = unknown;
 export type GetCfpPlayoffData = {
     query: {
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -2467,7 +2473,7 @@ export type GetCfpPlayoffError = ({
 export type GetCfpParticipantsData = {
     query: {
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -2479,11 +2485,11 @@ export type GetCfpParticipantsError = ({
 export type GetCfpGamesData = {
     query: {
         /**
-         * Optional playoff round filter
+         * Playoff round.
          */
         round?: PlayoffRound;
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -2495,19 +2501,19 @@ export type GetCfpGamesError = ({
 export type SearchPlayersData = {
     query: {
         /**
-         * Optional position abbreviation filter
+         * Player position abbreviation.
          */
         position?: string;
         /**
-         * Search term for matching player name
+         * Full or partial player name.
          */
         searchTerm: string;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional year filter
+         * Season year.
          */
         year?: number;
     };
@@ -2517,27 +2523,28 @@ export type SearchPlayersError = unknown;
 export type GetPlayerUsageData = {
     query: {
         /**
-         * Optional conference abbreviation filter
+         * Conference abbreviation.
          */
         conference?: string;
         /**
-         * Optional exclude garbage time flag, defaults to false
+         * Excludes garbage-time plays when `true`. Defaults
+         * to `false`.
          */
         excludeGarbageTime?: boolean;
         /**
-         * Optional player id filter
+         * Player ID.
          */
         playerId?: number;
         /**
-         * Optional position abbreivation filter
+         * Player position abbreviation.
          */
         position?: string;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -2547,11 +2554,11 @@ export type GetPlayerUsageError = unknown;
 export type GetPlayerSeasonOverviewData = {
     query: {
         /**
-         * Required player id filter
+         * Player ID.
          */
         playerId: number;
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -2561,15 +2568,15 @@ export type GetPlayerSeasonOverviewError = unknown;
 export type GetReturningProductionData = {
     query?: {
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Team filter, required if year not specified
+         * Team name. Required unless `year` is specified.
          */
         team?: string;
         /**
-         * Year filter, required if team not specified
+         * Season year. Required unless `team` is specified.
          */
         year?: number;
     };
@@ -2579,7 +2586,7 @@ export type GetReturningProductionError = unknown;
 export type GetTransferPortalData = {
     query: {
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -2589,11 +2596,11 @@ export type GetTransferPortalError = unknown;
 export type GetPredictedPointsData = {
     query: {
         /**
-         * Distance value
+         * Distance to gain, in yards.
          */
         distance: number;
         /**
-         * Down value
+         * Down number.
          */
         down: number;
     };
@@ -2603,23 +2610,23 @@ export type GetPredictedPointsError = unknown;
 export type GetPredictedPointsAddedByTeamData = {
     query?: {
         /**
-         * Optional division classification filter, defaults to fbs
+         * Division classification. Defaults to `fbs`.
          */
         classification?: DivisionClassification;
         /**
-         * Conference abbreviation filter
+         * Conference abbreviation.
          */
         conference?: string;
         /**
-         * Exclude garbage time plays
+         * Excludes garbage-time plays when `true`.
          */
         excludeGarbageTime?: boolean;
         /**
-         * Team filter, required if year not specified
+         * Team name. Required unless `year` is specified.
          */
         team?: string;
         /**
-         * Year filter, required if team not specified
+         * Season year. Required unless `team` is specified.
          */
         year?: number;
     };
@@ -2629,31 +2636,31 @@ export type GetPredictedPointsAddedByTeamError = unknown;
 export type GetPredictedPointsAddedByGameData = {
     query: {
         /**
-         * Optional division classification filter, defaults to fbs
+         * Division classification. Defaults to `fbs`.
          */
         classification?: DivisionClassification;
         /**
-         * Optional conference abbreviation filter
+         * Conference abbreviation.
          */
         conference?: string;
         /**
-         * Optional flag to exclude garbage time plays
+         * Excludes garbage-time plays when `true`.
          */
         excludeGarbageTime?: boolean;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional week filter
+         * Week number.
          */
         week?: number;
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -2663,35 +2670,35 @@ export type GetPredictedPointsAddedByGameError = unknown;
 export type GetPredictedPointsAddedByPlayerGameData = {
     query: {
         /**
-         * Optional flag to exclude garbage time plays
+         * Excludes garbage-time plays when `true`.
          */
         excludeGarbageTime?: boolean;
         /**
-         * Optional player ID filter
+         * Player ID.
          */
         playerId?: string;
         /**
-         * Optional player position abbreviation filter
+         * Player position abbreviation.
          */
         position?: string;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Team filter, required if week not specified
+         * Team name. Required unless `week` is specified.
          */
         team?: string;
         /**
-         * Threshold value for minimum number of plays
+         * Minimum number of plays.
          */
         threshold?: number;
         /**
-         * Week filter, required if team not specified
+         * Week number. Required unless `team` is specified.
          */
         week?: number;
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -2701,31 +2708,31 @@ export type GetPredictedPointsAddedByPlayerGameError = unknown;
 export type GetPredictedPointsAddedByPlayerSeasonData = {
     query?: {
         /**
-         * Optional conference abbreviation filter
+         * Conference abbreviation.
          */
         conference?: string;
         /**
-         * Optional flag to exclude garbage time plays
+         * Excludes garbage-time plays when `true`.
          */
         excludeGarbageTime?: boolean;
         /**
-         * Player ID filter, required if year not specified
+         * Player ID. Required unless `year` is specified.
          */
         playerId?: string;
         /**
-         * Optional position abbreviation filter
+         * Player position abbreviation.
          */
         position?: string;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Threshold value for minimum number of plays
+         * Minimum number of plays.
          */
         threshold?: number;
         /**
-         * Year filter, required if playerId not specified
+         * Season year. Required unless `playerId` is specified.
          */
         year?: number;
     };
@@ -2735,7 +2742,7 @@ export type GetPredictedPointsAddedByPlayerSeasonError = unknown;
 export type GetWinProbabilityData = {
     query: {
         /**
-         * Required game ID filter
+         * Game ID.
          */
         gameId: number;
     };
@@ -2745,19 +2752,19 @@ export type GetWinProbabilityError = unknown;
 export type GetPregameWinProbabilitiesData = {
     query?: {
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional week filter
+         * Week number.
          */
         week?: number;
         /**
-         * Optional year filter
+         * Season year.
          */
         year?: number;
     };
@@ -2769,7 +2776,7 @@ export type GetFieldGoalExpectedPointsError = unknown;
 export type GetLivePlaysData = {
     query: {
         /**
-         * Game Id filter
+         * Game ID.
          */
         gameId: number;
     };
@@ -2779,39 +2786,39 @@ export type GetLivePlaysError = unknown;
 export type GetLinesData = {
     query?: {
         /**
-         * Optional away team filter
+         * Away team name.
          */
         away?: string;
         /**
-         * Optional conference filter
+         * Conference of either team.
          */
         conference?: string;
         /**
-         * Optional gameId filter
+         * Game ID.
          */
         gameId?: number;
         /**
-         * Optional home team filter
+         * Home team name.
          */
         home?: string;
         /**
-         * Optional provider name filter
+         * Betting line provider.
          */
         provider?: string;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional team filter
+         * Team name on either side of the game.
          */
         team?: string;
         /**
-         * Optional week filter
+         * Week number.
          */
         week?: number;
         /**
-         * Year filter, required if game id not specified
+         * Season year. Required unless `gameId` is specified.
          */
         year?: number;
     };
@@ -2823,15 +2830,16 @@ export type GetUserInfoError = unknown;
 export type GetUsageData = {
     query?: {
         /**
-         * Optional API filter: all, cfb, or cbb
+         * API to include: `all`, `cfb`, or `cbb`.
          */
         api?: UserUsageApi;
         /**
-         * Number of trailing days to include, defaults to 7 and is capped at 31
+         * Trailing days to include. Defaults to 7; maximum 31.
          */
         days?: number;
         /**
-         * Number of endpoint and recent request rows to return, defaults to 10 and is capped at 50
+         * Maximum endpoint and request rows to return. Defaults to 10;
+         * maximum 50.
          */
         limit?: number;
     };
@@ -2841,47 +2849,47 @@ export type GetUsageError = unknown;
 export type GetGamesData = {
     query?: {
         /**
-         * Optional away team filter
+         * Away team name.
          */
         away?: string;
         /**
-         * Optional division classification filter
+         * Division classification.
          */
         classification?: DivisionClassification;
         /**
-         * Optional playoff competition filter
+         * Playoff competition.
          */
         competition?: PlayoffCompetition;
         /**
-         * Optional conference filter
+         * Conference of either team.
          */
         conference?: string;
         /**
-         * Optional home team filter
+         * Home team name.
          */
         home?: string;
         /**
-         * Game id filter to retrieve a single game
+         * Game ID. When specified, returns data for that game.
          */
         id?: number;
         /**
-         * Optional playoff round filter; requires competition
+         * Playoff round. Requires `competition`.
          */
         round?: PlayoffRound;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional team filter
+         * Team name on either side of the game.
          */
         team?: string;
         /**
-         * Optional week filter
+         * Week number.
          */
         week?: number;
         /**
-         * Required year filter (except when id is specified)
+         * Season year. Required unless `id` is specified.
          */
         year?: number;
     };
@@ -2893,31 +2901,34 @@ export type GetGamesError = ({
 export type GetGameTeamStatsData = {
     query?: {
         /**
-         * Optional division classification filter
+         * Division classification.
          */
         classification?: DivisionClassification;
         /**
-         * Optional conference filter, required if week and team not specified
+         * Conference name or abbreviation. One of `week`, `team`,
+         * or `conference` is required when filtering by year.
          */
         conference?: string;
         /**
-         * Optional id filter to retrieve a single game
+         * Game ID. When specified, returns statistics for that game.
          */
         id?: number;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional team filter, required if week and conference not specified
+         * Team name. One of `week`, `team`, or `conference` is required
+         * when filtering by year.
          */
         team?: string;
         /**
-         * Optional week filter, required if team and conference not specified
+         * Week number. One of `week`, `team`, or `conference` is required
+         * when filtering by year.
          */
         week?: number;
         /**
-         * Required year filter (along with one of week, team, or conference), unless id is specified
+         * Season year. Required unless `id` is specified.
          */
         year?: number;
     };
@@ -2927,35 +2938,38 @@ export type GetGameTeamStatsError = unknown;
 export type GetGamePlayerStatsData = {
     query?: {
         /**
-         * Optional player statistical category filter
+         * Player statistical category.
          */
         category?: string;
         /**
-         * Optional division classification filter
+         * Division classification.
          */
         classification?: DivisionClassification;
         /**
-         * Optional conference filter, required if week and team not specified
+         * Conference name or abbreviation. One of `week`, `team`,
+         * or `conference` is required when filtering by year.
          */
         conference?: string;
         /**
-         * Optional id filter to retrieve a single game
+         * Game ID. When specified, returns statistics for that game.
          */
         id?: number;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional team filter, required if week and conference not specified
+         * Team name. One of `week`, `team`, or `conference` is required
+         * when filtering by year.
          */
         team?: string;
         /**
-         * Optional week filter, required if team and conference not specified
+         * Week number. One of `week`, `team`, or `conference` is required
+         * when filtering by year.
          */
         week?: number;
         /**
-         * Required year filter (along with one of week, team, or conference), unless id is specified
+         * Season year. Required unless `id` is specified.
          */
         year?: number;
     };
@@ -2965,31 +2979,31 @@ export type GetGamePlayerStatsError = unknown;
 export type GetMediaData = {
     query: {
         /**
-         * Optional division classification filter
+         * Division classification.
          */
         classification?: DivisionClassification;
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Optional media type filter
+         * Media type.
          */
         mediaType?: MediaType;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional week filter
+         * Week number.
          */
         week?: number;
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -2999,31 +3013,31 @@ export type GetMediaError = unknown;
 export type GetWeatherData = {
     query?: {
         /**
-         * Optional division classification filter
+         * Division classification.
          */
         classification?: DivisionClassification;
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Filter for retrieving a single game
+         * Game ID. When specified, returns weather for that game.
          */
         gameId?: number;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional week filter
+         * Week number.
          */
         week?: number;
         /**
-         * Year filter, required if game id not specified
+         * Season year. Required unless `gameId` is specified.
          */
         year?: number;
     };
@@ -3033,15 +3047,15 @@ export type GetWeatherError = unknown;
 export type GetRecordsData = {
     query?: {
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Team filter, required if year not specified
+         * Team name. Required unless `year` is specified.
          */
         team?: string;
         /**
-         * Year filter, required if team not specified
+         * Season year. Required unless `team` is specified.
          */
         year?: number;
     };
@@ -3051,7 +3065,7 @@ export type GetRecordsError = unknown;
 export type GetCalendarData = {
     query: {
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -3061,11 +3075,11 @@ export type GetCalendarError = unknown;
 export type GetScoreboardData = {
     query?: {
         /**
-         * Optional division classification filter, defaults to fbs
+         * Division classification. Defaults to `fbs`.
          */
         classification?: DivisionClassification;
         /**
-         * Optional conference filter
+         * Conference name or abbreviation.
          */
         conference?: string;
     };
@@ -3075,43 +3089,43 @@ export type GetScoreboardError = unknown;
 export type GetDrivesData = {
     query: {
         /**
-         * Optional division classification filter
+         * Division classification of either team.
          */
         classification?: DivisionClassification;
         /**
-         * Optional conference filter
+         * Conference of either team.
          */
         conference?: string;
         /**
-         * Optional defensive team filter
+         * Defensive team name.
          */
         defense?: string;
         /**
-         * Optional defensive team conference filter
+         * Defensive team conference.
          */
         defenseConference?: string;
         /**
-         * Optional offensive team filter
+         * Offensive team name.
          */
         offense?: string;
         /**
-         * Optional offensive team conference filter
+         * Offensive team conference.
          */
         offenseConference?: string;
         /**
-         * Optional season type filter
+         * Season type.
          */
         seasonType?: SeasonType;
         /**
-         * Optional team filter
+         * Team name on either side of the drive.
          */
         team?: string;
         /**
-         * Optional week filter
+         * Week number.
          */
         week?: number;
         /**
-         * Required year filter
+         * Season year.
          */
         year: number;
     };
@@ -3125,23 +3139,23 @@ export type GetDraftPositionsError = unknown;
 export type GetDraftPicksData = {
     query?: {
         /**
-         * Optional college conference filter
+         * College conference name or abbreviation.
          */
         conference?: string;
         /**
-         * Optional position classification filter
+         * Position category.
          */
         position?: string;
         /**
-         * Optional college team filter
+         * College team name.
          */
         school?: string;
         /**
-         * Optional NFL team filter
+         * NFL team name.
          */
         team?: string;
         /**
-         * Optional year filter
+         * Draft year.
          */
         year?: number;
     };
@@ -3151,27 +3165,27 @@ export type GetDraftPicksError = unknown;
 export type GetCoachesData = {
     query?: {
         /**
-         * Optional first name filter
+         * Coach first name.
          */
         firstName?: string;
         /**
-         * Optional last name filter
+         * Coach last name.
          */
         lastName?: string;
         /**
-         * Optional end year range filter
+         * Latest season year to include.
          */
         maxYear?: number;
         /**
-         * Optional start year range filter
+         * Earliest season year to include.
          */
         minYear?: number;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional year filter
+         * Season year.
          */
         year?: number;
     };
@@ -3181,7 +3195,7 @@ export type GetCoachesError = unknown;
 export type GetCoachProfileData = {
     query: {
         /**
-         * Required coach ID
+         * Coach ID.
          */
         coachId: number;
     };
@@ -3193,23 +3207,23 @@ export type GetCoachProfileError = ({
 export type GetCoachSeasonsData = {
     query?: {
         /**
-         * Optional coach ID
+         * Coach ID.
          */
         coachId?: number;
         /**
-         * Optional end year range filter
+         * Latest season year to include.
          */
         maxYear?: number;
         /**
-         * Optional start year range filter
+         * Earliest season year to include.
          */
         minYear?: number;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional exact season year
+         * Exact season year.
          */
         year?: number;
     };
@@ -3221,19 +3235,19 @@ export type GetCoachSeasonsError = ({
 export type GetCoachTenuresData = {
     query?: {
         /**
-         * Optional active-tenure filter
+         * Filters by active status when specified.
          */
         active?: boolean;
         /**
-         * Optional coach ID
+         * Coach ID.
          */
         coachId?: number;
         /**
-         * Optional team filter
+         * Team name.
          */
         team?: string;
         /**
-         * Optional season year contained by the tenure
+         * Season year contained within the tenure.
          */
         year?: number;
     };
@@ -3245,7 +3259,7 @@ export type GetCoachTenuresError = ({
 export type GetAdvancedBoxScoreData = {
     query: {
         /**
-         * Required game id filter
+         * Game ID.
          */
         id: number;
     };