cfbd 5.24.2 → 5.26.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cfbd",
-  "version": "5.24.2",
+  "version": "5.26.0",
   "description": "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 CollegeFootballData.com website.",
   "repository": {
     "type": "git",

package/src/sdk.gen.ts

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import { createClient, createConfig, type OptionsLegacyParser } from '@hey-api/client-fetch';
-import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsError, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsError, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsError, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarError, GetKickerPaarResponse, GetTeamsData, GetTeamsError, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsError, GetFbsTeamsResponse, GetMatchupData, GetMatchupError, GetMatchupResponse, GetTeamsAtsData, GetTeamsAtsError, GetTeamsAtsResponse, GetRosterData, GetRosterError, GetRosterResponse, GetConferencesData, GetConferencesError, GetConferencesResponse, GetTeamConferenceChangesData, GetTeamConferenceChangesError, GetTeamConferenceChangesResponse, GetTeamConferenceAffiliationsData, GetTeamConferenceAffiliationsError, GetTeamConferenceAffiliationsResponse, GetTalentData, GetTalentError, GetTalentResponse, GetVenuesError, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsError, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesError, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesError, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsError, GetTeamStatsResponse, GetCategoriesError, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsError, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsError, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsError, GetGameHavocStatsResponse, GetRecruitsData, GetRecruitsError, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsError, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsError, GetAggregatedTeamRecruitingRatingsResponse, GetCoreData, GetCoreError, GetCoreResponse, GetSpData, GetSpError, GetSpResponse, GetConferenceSpData, GetConferenceSpError, GetConferenceSpResponse, GetSrsData, GetSrsError, GetSrsResponse, GetExpandedSrsData, GetExpandedSrsError, GetExpandedSrsResponse, GetEloData, GetEloError, GetEloResponse, GetFpiData, GetFpiError, GetFpiResponse, GetRankingsData, GetRankingsError, GetRankingsResponse, GetPlaysData, GetPlaysError, GetPlaysResponse, GetPlayTypesError, GetPlayTypesResponse, GetPlayStatsData, GetPlayStatsError, GetPlayStatsResponse, GetPlayStatTypesError, GetPlayStatTypesResponse, GetCfpPlayoffData, GetCfpPlayoffError, GetCfpPlayoffResponse, GetCfpParticipantsData, GetCfpParticipantsError, GetCfpParticipantsResponse, GetCfpGamesData, GetCfpGamesError, GetCfpGamesResponse, SearchPlayersData, SearchPlayersError, SearchPlayersResponse, GetPlayerUsageData, GetPlayerUsageError, GetPlayerUsageResponse, GetPlayerSeasonOverviewData, GetPlayerSeasonOverviewError, GetPlayerSeasonOverviewResponse, GetReturningProductionData, GetReturningProductionError, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalError, GetTransferPortalResponse, GetPredictedPointsData, GetPredictedPointsError, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamError, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameError, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameError, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonError, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityError, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesError, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsError, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLivePlaysError, GetLivePlaysResponse, GetLinesData, GetLinesError, GetLinesResponse, GetUserInfoError, GetUserInfoResponse, GetUsageData, GetUsageError, GetUsageResponse, GetGamesData, GetGamesError, GetGamesResponse, GetGameTeamStatsData, GetGameTeamStatsError, GetGameTeamStatsResponse, GetGamePlayerStatsData, GetGamePlayerStatsError, GetGamePlayerStatsResponse, GetMediaData, GetMediaError, GetMediaResponse, GetWeatherData, GetWeatherError, GetWeatherResponse, GetRecordsData, GetRecordsError, GetRecordsResponse, GetCalendarData, GetCalendarError, GetCalendarResponse, GetScoreboardData, GetScoreboardError, GetScoreboardResponse, GetDrivesData, GetDrivesError, GetDrivesResponse, GetDraftTeamsError, GetDraftTeamsResponse, GetDraftPositionsError, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksError, GetDraftPicksResponse, GetCoachesData, GetCoachesError, GetCoachesResponse, GetCoachProfileData, GetCoachProfileError, GetCoachProfileResponse, GetCoachSeasonsData, GetCoachSeasonsError, GetCoachSeasonsResponse, GetCoachTenuresData, GetCoachTenuresError, GetCoachTenuresResponse, GetAdvancedBoxScoreData, GetAdvancedBoxScoreError, GetAdvancedBoxScoreResponse } from './types.gen';
+import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsError, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsError, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsError, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarError, GetKickerPaarResponse, GetTeamsData, GetTeamsError, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsError, GetFbsTeamsResponse, GetMatchupData, GetMatchupError, GetMatchupResponse, GetTeamsAtsData, GetTeamsAtsError, GetTeamsAtsResponse, GetRosterData, GetRosterError, GetRosterResponse, GetConferencesData, GetConferencesError, GetConferencesResponse, GetTeamConferenceChangesData, GetTeamConferenceChangesError, GetTeamConferenceChangesResponse, GetTeamConferenceAffiliationsData, GetTeamConferenceAffiliationsError, GetTeamConferenceAffiliationsResponse, GetTalentData, GetTalentError, GetTalentResponse, GetVenuesError, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsError, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesError, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesError, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsError, GetTeamStatsResponse, GetCategoriesError, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsError, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsError, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsError, GetGameHavocStatsResponse, GetRushingPlaysData, GetRushingPlaysError, GetRushingPlaysResponse, GetPlayerRushingBySeasonData, GetPlayerRushingBySeasonError, GetPlayerRushingBySeasonResponse, GetPlayerRushingByGameData, GetPlayerRushingByGameError, GetPlayerRushingByGameResponse, GetTeamRushingBySeasonData, GetTeamRushingBySeasonError, GetTeamRushingBySeasonResponse, GetTeamRushingByGameData, GetTeamRushingByGameError, GetTeamRushingByGameResponse, GetRecruitsData, GetRecruitsError, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsError, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsError, GetAggregatedTeamRecruitingRatingsResponse, GetCoreData, GetCoreError, GetCoreResponse, GetSpData, GetSpError, GetSpResponse, GetConferenceSpData, GetConferenceSpError, GetConferenceSpResponse, GetSrsData, GetSrsError, GetSrsResponse, GetExpandedSrsData, GetExpandedSrsError, GetExpandedSrsResponse, GetEloData, GetEloError, GetEloResponse, GetFpiData, GetFpiError, GetFpiResponse, GetRankingsData, GetRankingsError, GetRankingsResponse, GetPlaysData, GetPlaysError, GetPlaysResponse, GetPlayTypesError, GetPlayTypesResponse, GetPlayStatsData, GetPlayStatsError, GetPlayStatsResponse, GetPlayStatTypesError, GetPlayStatTypesResponse, GetCfpPlayoffData, GetCfpPlayoffError, GetCfpPlayoffResponse, GetCfpParticipantsData, GetCfpParticipantsError, GetCfpParticipantsResponse, GetCfpGamesData, GetCfpGamesError, GetCfpGamesResponse, SearchPlayersData, SearchPlayersError, SearchPlayersResponse, GetPlayerUsageData, GetPlayerUsageError, GetPlayerUsageResponse, GetPlayerSeasonOverviewData, GetPlayerSeasonOverviewError, GetPlayerSeasonOverviewResponse, GetReturningProductionData, GetReturningProductionError, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalError, GetTransferPortalResponse, GetPassingPlaysData, GetPassingPlaysError, GetPassingPlaysResponse, GetPlayerPassingBySeasonData, GetPlayerPassingBySeasonError, GetPlayerPassingBySeasonResponse, GetPlayerPassingByGameData, GetPlayerPassingByGameError, GetPlayerPassingByGameResponse, GetTeamPassingBySeasonData, GetTeamPassingBySeasonError, GetTeamPassingBySeasonResponse, GetTeamPassingByGameData, GetTeamPassingByGameError, GetTeamPassingByGameResponse, GetPredictedPointsData, GetPredictedPointsError, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamError, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameError, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameError, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonError, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityError, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesError, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsError, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLivePlaysError, GetLivePlaysResponse, GetLinesData, GetLinesError, GetLinesResponse, GetUserInfoError, GetUserInfoResponse, GetUsageData, GetUsageError, GetUsageResponse, GetGamesData, GetGamesError, GetGamesResponse, GetGameTeamStatsData, GetGameTeamStatsError, GetGameTeamStatsResponse, GetGamePlayerStatsData, GetGamePlayerStatsError, GetGamePlayerStatsResponse, GetMediaData, GetMediaError, GetMediaResponse, GetWeatherData, GetWeatherError, GetWeatherResponse, GetRecordsData, GetRecordsError, GetRecordsResponse, GetCalendarData, GetCalendarError, GetCalendarResponse, GetScoreboardData, GetScoreboardError, GetScoreboardResponse, GetDrivesData, GetDrivesError, GetDrivesResponse, GetDraftTeamsError, GetDraftTeamsResponse, GetDraftPositionsError, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksError, GetDraftPicksResponse, GetCoachesData, GetCoachesError, GetCoachesResponse, GetCoachProfileData, GetCoachProfileError, GetCoachProfileResponse, GetCoachSeasonsData, GetCoachSeasonsError, GetCoachSeasonsResponse, GetCoachTenuresData, GetCoachTenuresError, GetCoachTenuresResponse, GetAdvancedBoxScoreData, GetAdvancedBoxScoreError, GetAdvancedBoxScoreResponse } from './types.gen';
 
 export const client = createClient(createConfig({ baseUrl: 'https://api.collegefootballdata.com' }));
 
@@ -225,6 +225,74 @@ export const getGameHavocStats = <ThrowOnError extends boolean = false>(options?
     });
 };
 
+/**
+ * Returns enriched rushing attempts.
+ *
+ * Team results include sacks, kneels, team-only attempts, and unresolved
+ * attribution. Direction eligibility identifies the ordinary-rush analysis
+ * population; eligible attempts can still have an unknown direction.
+ */
+export const getRushingPlays = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetRushingPlaysData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetRushingPlaysResponse, GetRushingPlaysError, ThrowOnError>({
+        ...options,
+        url: '/rushing/plays'
+    });
+};
+
+/**
+ * Returns individually attributed rusher production by season.
+ *
+ * Player totals include only guarded rusher attribution, including
+ * individually attributed sacks. They do not include team-only or unresolved
+ * attempts and therefore are not expected to sum to team totals.
+ */
+export const getPlayerRushingBySeason = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPlayerRushingBySeasonData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetPlayerRushingBySeasonResponse, GetPlayerRushingBySeasonError, ThrowOnError>({
+        ...options,
+        url: '/rushing/players/season'
+    });
+};
+
+/**
+ * Returns individually attributed rusher production by game.
+ *
+ * Player totals include only guarded rusher attribution, including
+ * individually attributed sacks. They do not include team-only or unresolved
+ * attempts and therefore are not expected to sum to team totals.
+ */
+export const getPlayerRushingByGame = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPlayerRushingByGameData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetPlayerRushingByGameResponse, GetPlayerRushingByGameError, ThrowOnError>({
+        ...options,
+        url: '/rushing/players/games'
+    });
+};
+
+/**
+ * Returns team rushing production by season.
+ *
+ * Team totals include sacks, kneels, team-only attempts, and unresolved
+ * attribution. Defense contains rushing production allowed.
+ */
+export const getTeamRushingBySeason = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamRushingBySeasonData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetTeamRushingBySeasonResponse, GetTeamRushingBySeasonError, ThrowOnError>({
+        ...options,
+        url: '/rushing/teams/season'
+    });
+};
+
+/**
+ * Returns team rushing production by game.
+ *
+ * Team totals include sacks, kneels, team-only attempts, and unresolved
+ * attribution. Defense contains rushing production allowed.
+ */
+export const getTeamRushingByGame = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTeamRushingByGameData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetTeamRushingByGameResponse, GetTeamRushingByGameError, ThrowOnError>({
+        ...options,
+        url: '/rushing/teams/games'
+    });
+};
+
 /**
  * Returns player recruiting rankings.
  */
@@ -457,6 +525,56 @@ export const getTransferPortal = <ThrowOnError extends boolean = false>(options:
     });
 };
 
+/**
+ * Returns enriched pass attempts.
+ */
+export const getPassingPlays = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPassingPlaysData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetPassingPlaysResponse, GetPassingPlaysError, ThrowOnError>({
+        ...options,
+        url: '/passing/plays'
+    });
+};
+
+/**
+ * Returns passer production by season.
+ */
+export const getPlayerPassingBySeason = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetPlayerPassingBySeasonData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetPlayerPassingBySeasonResponse, GetPlayerPassingBySeasonError, ThrowOnError>({
+        ...options,
+        url: '/passing/players/season'
+    });
+};
+
+/**
+ * Returns passer production by game.
+ */
+export const getPlayerPassingByGame = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetPlayerPassingByGameData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetPlayerPassingByGameResponse, GetPlayerPassingByGameError, ThrowOnError>({
+        ...options,
+        url: '/passing/players/games'
+    });
+};
+
+/**
+ * Returns team passing production by season.
+ */
+export const getTeamPassingBySeason = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetTeamPassingBySeasonData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetTeamPassingBySeasonResponse, GetTeamPassingBySeasonError, ThrowOnError>({
+        ...options,
+        url: '/passing/teams/season'
+    });
+};
+
+/**
+ * Returns team passing production by game.
+ */
+export const getTeamPassingByGame = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTeamPassingByGameData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetTeamPassingByGameResponse, GetTeamPassingByGameError, ThrowOnError>({
+        ...options,
+        url: '/passing/teams/games'
+    });
+};
+
 /**
  * Returns predicted points values by down and distance.
  */