cfbd 5.31.1 → 5.32.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Binary file
package/dist/sdk.gen.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { type OptionsLegacyParser } from '@hey-api/client-fetch';
2
- import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarResponse, GetTeamSeasonOverviewData, GetTeamSeasonOverviewError, GetTeamsData, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsResponse, GetMatchupData, GetTeamsAtsData, GetTeamsAtsResponse, GetRosterData, GetRosterResponse, GetConferencesData, GetConferencesResponse, GetTeamConferenceChangesData, GetTeamConferenceChangesResponse, GetTeamConferenceAffiliationsData, GetTeamConferenceAffiliationsResponse, GetTalentData, GetTalentResponse, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsResponse, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsResponse, GetRushingPlaysData, GetRushingPlaysResponse, GetPlayerRushingBySeasonData, GetPlayerRushingBySeasonResponse, GetPlayerRushingByGameData, GetPlayerRushingByGameResponse, GetTeamRushingBySeasonData, GetTeamRushingBySeasonResponse, GetTeamRushingByGameData, GetTeamRushingByGameResponse, 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, GetPassingPlaysData, GetPassingPlaysResponse, GetPlayerPassingBySeasonData, GetPlayerPassingBySeasonResponse, GetPlayerPassingByGameData, GetPlayerPassingByGameResponse, GetTeamPassingBySeasonData, GetTeamPassingBySeasonResponse, GetTeamPassingByGameData, GetTeamPassingByGameResponse, GetPredictedPointsData, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLinesData, GetLinesResponse, GetUserInfoResponse, GetUsageData, GetUsageResponse, GetGameScheduleData, GetGamePreviewData, GetAdjustedGamePreviewData, 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';
2
+ import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarResponse, GetTeamSeasonOverviewData, GetTeamSeasonOverviewError, GetTeamsData, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsResponse, GetMatchupData, GetTeamsAtsData, GetTeamsAtsResponse, GetRosterData, GetRosterResponse, GetConferencesData, GetConferencesResponse, GetTeamConferenceChangesData, GetTeamConferenceChangesResponse, GetTeamConferenceAffiliationsData, GetTeamConferenceAffiliationsResponse, GetTalentData, GetTalentResponse, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsResponse, GetPlayerSeasonSuccessRatesData, GetPlayerSeasonSuccessRatesResponse, GetPlayerGameSuccessRatesData, GetPlayerGameSuccessRatesResponse, GetTeamStatsData, GetTeamStatsResponse, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsResponse, GetGameHavocStatsData, GetGameHavocStatsResponse, GetRushingPlaysData, GetRushingPlaysResponse, GetPlayerRushingBySeasonData, GetPlayerRushingBySeasonResponse, GetPlayerRushingByGameData, GetPlayerRushingByGameResponse, GetTeamRushingBySeasonData, GetTeamRushingBySeasonResponse, GetTeamRushingByGameData, GetTeamRushingByGameResponse, 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, GetPassingPlaysData, GetPassingPlaysResponse, GetPlayerPassingBySeasonData, GetPlayerPassingBySeasonResponse, GetPlayerPassingByGameData, GetPlayerPassingByGameResponse, GetTeamPassingBySeasonData, GetTeamPassingBySeasonResponse, GetTeamPassingByGameData, GetTeamPassingByGameResponse, 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, GetGameScheduleData, GetGamePreviewData, GetAdjustedGamePreviewData, 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';
3
3
  export declare const client: import("@hey-api/client-fetch").Client<Request, Response, unknown, import("@hey-api/client-fetch").RequestOptions<boolean, string>>;
4
4
  /**
5
5
  * Returns opponent-adjusted team statistics by season.
@@ -298,21 +298,6 @@ export declare const getUserInfo: <ThrowOnError extends boolean = false>(options
298
298
  * pool. Returns `null` when the request is not authenticated.
299
299
  */
300
300
  export declare const getUsage: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetUsageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetUsageResponse, unknown, ThrowOnError>;
301
- /**
302
- * Returns the active or next calendar slate, including completed games.
303
- * Explicit windows require year, seasonType, and week together.
304
- */
305
- export declare const getGameSchedule: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGameScheduleData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GameSchedule, import("./types.gen").GamePreviewError, ThrowOnError>;
306
- /**
307
- * Returns pregame team comparisons and key players. Analysis remains available until the game is completed.
308
- * Team statistics may use the previous season; players and context stay in the game season.
309
- */
310
- export declare const getGamePreview: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetGamePreviewData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GamePreview, import("./types.gen").GamePreviewError, ThrowOnError>;
311
- /**
312
- * Returns stored adjusted team and player metrics until game completion. Requires Patreon Tier 1.
313
- * Team metrics may use the previous season; players remain current-season.
314
- */
315
- export declare const getAdjustedGamePreview: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdjustedGamePreviewData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").AdjustedGamePreview, import("./types.gen").GamePreviewError, ThrowOnError>;
316
301
  /**
317
302
  * Returns historical game data.
318
303
  */
@@ -333,6 +318,21 @@ export declare const getMedia: <ThrowOnError extends boolean = false>(options: O
333
318
  * Returns historical and forecast weather data for games. Requires Patreon.
334
319
  */
335
320
  export declare const getWeather: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetWeatherData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetWeatherResponse, unknown, ThrowOnError>;
321
+ /**
322
+ * Returns the active or next calendar slate, including completed games.
323
+ * Explicit windows require year, seasonType, and week together.
324
+ */
325
+ export declare const getGameSchedule: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGameScheduleData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GameSchedule, import("./types.gen").GamePreviewError, ThrowOnError>;
326
+ /**
327
+ * Returns pregame team comparisons and key players. Analysis remains available until the game is completed.
328
+ * Team statistics may use the previous season; players and context stay in the game season.
329
+ */
330
+ export declare const getGamePreview: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetGamePreviewData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").GamePreview, import("./types.gen").GamePreviewError, ThrowOnError>;
331
+ /**
332
+ * Returns stored adjusted team and player metrics until game completion. Requires Patreon Tier 1.
333
+ * Team metrics may use the previous season; players remain current-season.
334
+ */
335
+ export declare const getAdjustedGamePreview: <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdjustedGamePreviewData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").AdjustedGamePreview, import("./types.gen").GamePreviewError, ThrowOnError>;
336
336
  /**
337
337
  * Returns historical team records by season.
338
338
  */
package/dist/sdk.gen.js CHANGED
@@ -13,7 +13,7 @@ var __assign = (this && this.__assign) || function () {
13
13
  };
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
15
  exports.getPlayerSeasonOverview = exports.getPlayerUsage = exports.searchPlayers = exports.getCfpGames = exports.getCfpParticipants = exports.getCfpPlayoff = exports.getPlayStatTypes = exports.getPlayStats = exports.getPlayTypes = exports.getPlays = exports.getRankings = exports.getFpi = exports.getElo = exports.getExpandedSrs = exports.getSrs = exports.getConferenceSp = exports.getSp = exports.getCore = exports.getAggregatedTeamRecruitingRatings = exports.getTeamRecruitingRankings = exports.getRecruits = exports.getTeamRushingByGame = exports.getTeamRushingBySeason = exports.getPlayerRushingByGame = exports.getPlayerRushingBySeason = exports.getRushingPlays = exports.getGameHavocStats = exports.getAdvancedGameStats = exports.getAdvancedSeasonStats = exports.getCategories = exports.getTeamStats = exports.getPlayerGameSuccessRates = exports.getPlayerSeasonSuccessRates = exports.getPlayerSeasonStats = exports.getVenues = exports.getTalent = exports.getTeamConferenceAffiliations = exports.getTeamConferenceChanges = exports.getConferences = exports.getRoster = exports.getTeamsAts = exports.getMatchup = exports.getFbsTeams = exports.getTeams = exports.getTeamSeasonOverview = exports.getKickerPaar = exports.getAdjustedPlayerRushingStats = exports.getAdjustedPlayerPassingStats = exports.getAdjustedTeamSeasonStats = exports.client = void 0;
16
- exports.getAdvancedBoxScore = exports.getCoachTenures = exports.getCoachSeasons = exports.getCoachProfile = exports.getCoaches = exports.getDraftPicks = exports.getDraftPositions = exports.getDraftTeams = exports.getDrives = exports.getScoreboard = exports.getCalendar = exports.getRecords = exports.getWeather = exports.getMedia = exports.getGamePlayerStats = exports.getGameTeamStats = exports.getGames = exports.getAdjustedGamePreview = exports.getGamePreview = exports.getGameSchedule = exports.getUsage = exports.getUserInfo = exports.getLines = exports.getLivePlays = exports.getFieldGoalExpectedPoints = exports.getPregameWinProbabilities = exports.getWinProbability = exports.getPredictedPointsAddedByPlayerSeason = exports.getPredictedPointsAddedByPlayerGame = exports.getPredictedPointsAddedByGame = exports.getPredictedPointsAddedByTeam = exports.getPredictedPoints = exports.getTeamPassingByGame = exports.getTeamPassingBySeason = exports.getPlayerPassingByGame = exports.getPlayerPassingBySeason = exports.getPassingPlays = exports.getTransferPortal = exports.getReturningProduction = void 0;
16
+ exports.getAdvancedBoxScore = exports.getCoachTenures = exports.getCoachSeasons = exports.getCoachProfile = exports.getCoaches = exports.getDraftPicks = exports.getDraftPositions = exports.getDraftTeams = exports.getDrives = exports.getScoreboard = exports.getCalendar = exports.getRecords = exports.getAdjustedGamePreview = exports.getGamePreview = exports.getGameSchedule = exports.getWeather = exports.getMedia = exports.getGamePlayerStats = exports.getGameTeamStats = exports.getGames = exports.getUsage = exports.getUserInfo = exports.getLines = exports.getLivePlays = exports.getFieldGoalExpectedPoints = exports.getPregameWinProbabilities = exports.getWinProbability = exports.getPredictedPointsAddedByPlayerSeason = exports.getPredictedPointsAddedByPlayerGame = exports.getPredictedPointsAddedByGame = exports.getPredictedPointsAddedByTeam = exports.getPredictedPoints = exports.getTeamPassingByGame = exports.getTeamPassingBySeason = exports.getPlayerPassingByGame = exports.getPlayerPassingBySeason = exports.getPassingPlays = exports.getTransferPortal = exports.getReturningProduction = void 0;
17
17
  var client_fetch_1 = require("@hey-api/client-fetch");
18
18
  exports.client = (0, client_fetch_1.createClient)((0, client_fetch_1.createConfig)({ baseUrl: 'https://api.collegefootballdata.com' }));
19
19
  /**
@@ -585,33 +585,6 @@ var getUsage = function (options) {
585
585
  return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/info/usage' }));
586
586
  };
587
587
  exports.getUsage = getUsage;
588
- /**
589
- * Returns the active or next calendar slate, including completed games.
590
- * Explicit windows require year, seasonType, and week together.
591
- */
592
- var getGameSchedule = function (options) {
593
- var _a;
594
- return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/games/schedule' }));
595
- };
596
- exports.getGameSchedule = getGameSchedule;
597
- /**
598
- * Returns pregame team comparisons and key players. Analysis remains available until the game is completed.
599
- * Team statistics may use the previous season; players and context stay in the game season.
600
- */
601
- var getGamePreview = function (options) {
602
- var _a;
603
- return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/games/{gameId}/preview' }));
604
- };
605
- exports.getGamePreview = getGamePreview;
606
- /**
607
- * Returns stored adjusted team and player metrics until game completion. Requires Patreon Tier 1.
608
- * Team metrics may use the previous season; players remain current-season.
609
- */
610
- var getAdjustedGamePreview = function (options) {
611
- var _a;
612
- return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/games/{gameId}/preview/adjusted' }));
613
- };
614
- exports.getAdjustedGamePreview = getAdjustedGamePreview;
615
588
  /**
616
589
  * Returns historical game data.
617
590
  */
@@ -652,6 +625,33 @@ var getWeather = function (options) {
652
625
  return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/games/weather' }));
653
626
  };
654
627
  exports.getWeather = getWeather;
628
+ /**
629
+ * Returns the active or next calendar slate, including completed games.
630
+ * Explicit windows require year, seasonType, and week together.
631
+ */
632
+ var getGameSchedule = function (options) {
633
+ var _a;
634
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/games/schedule' }));
635
+ };
636
+ exports.getGameSchedule = getGameSchedule;
637
+ /**
638
+ * Returns pregame team comparisons and key players. Analysis remains available until the game is completed.
639
+ * Team statistics may use the previous season; players and context stay in the game season.
640
+ */
641
+ var getGamePreview = function (options) {
642
+ var _a;
643
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/games/{gameId}/preview' }));
644
+ };
645
+ exports.getGamePreview = getGamePreview;
646
+ /**
647
+ * Returns stored adjusted team and player metrics until game completion. Requires Patreon Tier 1.
648
+ * Team metrics may use the previous season; players remain current-season.
649
+ */
650
+ var getAdjustedGamePreview = function (options) {
651
+ var _a;
652
+ return ((_a = options === null || options === void 0 ? void 0 : options.client) !== null && _a !== void 0 ? _a : exports.client).get(__assign(__assign({}, options), { url: '/games/{gameId}/preview/adjusted' }));
653
+ };
654
+ exports.getAdjustedGamePreview = getAdjustedGamePreview;
655
655
  /**
656
656
  * Returns historical team records by season.
657
657
  */
@@ -562,6 +562,7 @@ export type DetailedCoachSeason = {
562
562
  cfp: CoachCfpContext;
563
563
  draftFollowingSeason: ((CoachDraftContext) | null);
564
564
  };
565
+ export type Division = 'fbs' | 'fcs' | 'ii' | 'ii/iii' | 'iii';
565
566
  export type DivisionClassification = 'fbs' | 'fcs' | 'ii' | 'ii/iii' | 'iii';
566
567
  export type DraftPick = {
567
568
  collegeAthleteId: (number) | null;
@@ -2096,6 +2097,7 @@ export type PreviewTeamIdentity = {
2096
2097
  points: (number) | null;
2097
2098
  };
2098
2099
  export type PreviewTeamStatistics = {
2100
+ statRankings?: ((TeamSeasonStatRankings) | null);
2099
2101
  season: number;
2100
2102
  isPreviousSeason: boolean;
2101
2103
  advanced: TeamSeasonAdvancedStats;
@@ -2125,6 +2127,31 @@ export type RecentResult = {
2125
2127
  result: 'win' | 'loss' | 'tie' | 'unknown';
2126
2128
  };
2127
2129
  export type result = 'win' | 'loss' | 'tie' | 'unknown';
2130
+ /**
2131
+ * Construct a type with a set of properties K of type T
2132
+ */
2133
+ export type Record_StatMetricKey_TeamStatRank_or_null_ = {
2134
+ ppa: TeamStatRank;
2135
+ successRate: TeamStatRank;
2136
+ explosiveness: TeamStatRank;
2137
+ 'standardDowns.successRate': TeamStatRank;
2138
+ 'passingDowns.successRate': TeamStatRank;
2139
+ 'passingPlays.ppa': TeamStatRank;
2140
+ 'rushingPlays.ppa': TeamStatRank;
2141
+ 'passingPlays.explosiveness': TeamStatRank;
2142
+ 'rushingPlays.explosiveness': TeamStatRank;
2143
+ lineYards: TeamStatRank;
2144
+ secondLevelYards: TeamStatRank;
2145
+ openFieldYards: TeamStatRank;
2146
+ stuffRate: TeamStatRank;
2147
+ powerSuccess: TeamStatRank;
2148
+ 'havoc.total': TeamStatRank;
2149
+ 'havoc.frontSeven': TeamStatRank;
2150
+ 'havoc.db': TeamStatRank;
2151
+ pointsPerOpportunity: TeamStatRank;
2152
+ 'fieldPosition.averageStart': TeamStatRank;
2153
+ 'fieldPosition.averagePredictedPoints': TeamStatRank;
2154
+ };
2128
2155
  export type Recruit = {
2129
2156
  id: string;
2130
2157
  athleteId: (string) | null;
@@ -2263,6 +2290,7 @@ export type ScheduleGame = {
2263
2290
  playoff: ((GamePlayoff) | null);
2264
2291
  broadcasts: PreviewSection_PreviewBroadcast_Array_;
2265
2292
  odds: PreviewSection_SelectedOdds_;
2293
+ watchabilityScore: (number) | null;
2266
2294
  };
2267
2295
  export type ScheduleWindow = {
2268
2296
  year: number;
@@ -2689,6 +2717,7 @@ export type TeamSeasonAdvancedStats = {
2689
2717
  lineYards: number;
2690
2718
  stuffRate: number;
2691
2719
  powerSuccess: (number) | null;
2720
+ powerRushAttempts?: number;
2692
2721
  explosiveness: (number) | null;
2693
2722
  successRate: number;
2694
2723
  totalPPA: number;
@@ -2743,6 +2772,7 @@ export type TeamSeasonAdvancedStats = {
2743
2772
  lineYards: number;
2744
2773
  stuffRate: number;
2745
2774
  powerSuccess: (number) | null;
2775
+ powerRushAttempts?: number;
2746
2776
  explosiveness: (number) | null;
2747
2777
  successRate: number;
2748
2778
  totalPPA: number;
@@ -2759,6 +2789,7 @@ export type TeamSeasonOverview = {
2759
2789
  };
2760
2790
  passing: ((TeamPassingSeason) | null);
2761
2791
  rushing: ((TeamRushingSeason) | null);
2792
+ statRankings?: ((TeamSeasonStatRankings) | null);
2762
2793
  /**
2763
2794
  * Completed games for the requested season, including postseason.
2764
2795
  */
@@ -2884,6 +2915,17 @@ export type TeamSeasonRankedRating = {
2884
2915
  */
2885
2916
  rank: (number) | null;
2886
2917
  };
2918
+ export type TeamSeasonStatRankings = {
2919
+ teamId: number;
2920
+ season: number;
2921
+ division: Division;
2922
+ divisionTeamCount: number;
2923
+ calculatedAt: string;
2924
+ expiresAt: string;
2925
+ sourceUpdatedAt: string;
2926
+ offense: Record_StatMetricKey_TeamStatRank_or_null_;
2927
+ defense: Record_StatMetricKey_TeamStatRank_or_null_;
2928
+ };
2887
2929
  export type TeamSP = {
2888
2930
  year: number;
2889
2931
  team: string;
@@ -2938,6 +2980,12 @@ export type TeamStat = {
2938
2980
  statName: string;
2939
2981
  statValue: (string | number);
2940
2982
  };
2983
+ export type TeamStatRank = {
2984
+ rank: number;
2985
+ population: number;
2986
+ tied: boolean;
2987
+ percentile: number;
2988
+ };
2941
2989
  export type TeamSuccessRates = {
2942
2990
  team: string;
2943
2991
  overall: StatsByQuarter;
@@ -4581,37 +4629,6 @@ export type GetUsageData = {
4581
4629
  };
4582
4630
  export type GetUsageResponse = (((UserUsage) | null));
4583
4631
  export type GetUsageError = unknown;
4584
- export type GetGameScheduleData = {
4585
- query?: {
4586
- /**
4587
- * Division of either participant. Defaults to fbs.
4588
- */
4589
- classification?: 'fbs' | 'fcs';
4590
- /**
4591
- * Conference abbreviation of either participant.
4592
- */
4593
- conference?: string;
4594
- seasonType?: 'regular' | 'postseason';
4595
- week?: number;
4596
- year?: number;
4597
- };
4598
- };
4599
- export type GetGameScheduleResponse = (GameSchedule);
4600
- export type GetGameScheduleError = (GamePreviewError);
4601
- export type GetGamePreviewData = {
4602
- path: {
4603
- gameId: number;
4604
- };
4605
- };
4606
- export type GetGamePreviewResponse = (GamePreview);
4607
- export type GetGamePreviewError = (GamePreviewError);
4608
- export type GetAdjustedGamePreviewData = {
4609
- path: {
4610
- gameId: number;
4611
- };
4612
- };
4613
- export type GetAdjustedGamePreviewResponse = (AdjustedGamePreview);
4614
- export type GetAdjustedGamePreviewError = (GamePreviewError);
4615
4632
  export type GetGamesData = {
4616
4633
  query?: {
4617
4634
  /**
@@ -4810,6 +4827,37 @@ export type GetWeatherData = {
4810
4827
  };
4811
4828
  export type GetWeatherResponse = (Array<GameWeather>);
4812
4829
  export type GetWeatherError = unknown;
4830
+ export type GetGameScheduleData = {
4831
+ query?: {
4832
+ /**
4833
+ * Division of either participant. Defaults to fbs.
4834
+ */
4835
+ classification?: 'fbs' | 'fcs';
4836
+ /**
4837
+ * Conference abbreviation of either participant.
4838
+ */
4839
+ conference?: string;
4840
+ seasonType?: 'regular' | 'postseason';
4841
+ week?: number;
4842
+ year?: number;
4843
+ };
4844
+ };
4845
+ export type GetGameScheduleResponse = (GameSchedule);
4846
+ export type GetGameScheduleError = (GamePreviewError);
4847
+ export type GetGamePreviewData = {
4848
+ path: {
4849
+ gameId: number;
4850
+ };
4851
+ };
4852
+ export type GetGamePreviewResponse = (GamePreview);
4853
+ export type GetGamePreviewError = (GamePreviewError);
4854
+ export type GetAdjustedGamePreviewData = {
4855
+ path: {
4856
+ gameId: number;
4857
+ };
4858
+ };
4859
+ export type GetAdjustedGamePreviewResponse = (AdjustedGamePreview);
4860
+ export type GetAdjustedGamePreviewError = (GamePreviewError);
4813
4861
  export type GetRecordsData = {
4814
4862
  query?: {
4815
4863
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cfbd",
3
- "version": "5.31.1",
3
+ "version": "5.32.0",
4
4
  "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.",
5
5
  "repository": {
6
6
  "type": "git",
package/src/sdk.gen.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
3
  import { createClient, createConfig, type OptionsLegacyParser } from '@hey-api/client-fetch';
4
- import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsError, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsError, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsError, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarError, GetKickerPaarResponse, GetTeamSeasonOverviewData, GetTeamSeasonOverviewError, GetTeamSeasonOverviewResponse, 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, GetGameScheduleData, GetGameScheduleError, GetGameScheduleResponse, GetGamePreviewData, GetGamePreviewError, GetGamePreviewResponse, GetAdjustedGamePreviewData, GetAdjustedGamePreviewError, GetAdjustedGamePreviewResponse, 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';
4
+ import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsError, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsError, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsError, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarError, GetKickerPaarResponse, GetTeamSeasonOverviewData, GetTeamSeasonOverviewError, GetTeamSeasonOverviewResponse, 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, GetGameScheduleData, GetGameScheduleError, GetGameScheduleResponse, GetGamePreviewData, GetGamePreviewError, GetGamePreviewResponse, GetAdjustedGamePreviewData, GetAdjustedGamePreviewError, GetAdjustedGamePreviewResponse, 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';
5
5
 
6
6
  export const client = createClient(createConfig({ baseUrl: 'https://api.collegefootballdata.com' }));
7
7
 
@@ -710,39 +710,6 @@ export const getUsage = <ThrowOnError extends boolean = false>(options?: Options
710
710
  });
711
711
  };
712
712
 
713
- /**
714
- * Returns the active or next calendar slate, including completed games.
715
- * Explicit windows require year, seasonType, and week together.
716
- */
717
- export const getGameSchedule = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGameScheduleData, ThrowOnError>) => {
718
- return (options?.client ?? client).get<GetGameScheduleResponse, GetGameScheduleError, ThrowOnError>({
719
- ...options,
720
- url: '/games/schedule'
721
- });
722
- };
723
-
724
- /**
725
- * Returns pregame team comparisons and key players. Analysis remains available until the game is completed.
726
- * Team statistics may use the previous season; players and context stay in the game season.
727
- */
728
- export const getGamePreview = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetGamePreviewData, ThrowOnError>) => {
729
- return (options?.client ?? client).get<GetGamePreviewResponse, GetGamePreviewError, ThrowOnError>({
730
- ...options,
731
- url: '/games/{gameId}/preview'
732
- });
733
- };
734
-
735
- /**
736
- * Returns stored adjusted team and player metrics until game completion. Requires Patreon Tier 1.
737
- * Team metrics may use the previous season; players remain current-season.
738
- */
739
- export const getAdjustedGamePreview = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdjustedGamePreviewData, ThrowOnError>) => {
740
- return (options?.client ?? client).get<GetAdjustedGamePreviewResponse, GetAdjustedGamePreviewError, ThrowOnError>({
741
- ...options,
742
- url: '/games/{gameId}/preview/adjusted'
743
- });
744
- };
745
-
746
713
  /**
747
714
  * Returns historical game data.
748
715
  */
@@ -793,6 +760,39 @@ export const getWeather = <ThrowOnError extends boolean = false>(options?: Optio
793
760
  });
794
761
  };
795
762
 
763
+ /**
764
+ * Returns the active or next calendar slate, including completed games.
765
+ * Explicit windows require year, seasonType, and week together.
766
+ */
767
+ export const getGameSchedule = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGameScheduleData, ThrowOnError>) => {
768
+ return (options?.client ?? client).get<GetGameScheduleResponse, GetGameScheduleError, ThrowOnError>({
769
+ ...options,
770
+ url: '/games/schedule'
771
+ });
772
+ };
773
+
774
+ /**
775
+ * Returns pregame team comparisons and key players. Analysis remains available until the game is completed.
776
+ * Team statistics may use the previous season; players and context stay in the game season.
777
+ */
778
+ export const getGamePreview = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetGamePreviewData, ThrowOnError>) => {
779
+ return (options?.client ?? client).get<GetGamePreviewResponse, GetGamePreviewError, ThrowOnError>({
780
+ ...options,
781
+ url: '/games/{gameId}/preview'
782
+ });
783
+ };
784
+
785
+ /**
786
+ * Returns stored adjusted team and player metrics until game completion. Requires Patreon Tier 1.
787
+ * Team metrics may use the previous season; players remain current-season.
788
+ */
789
+ export const getAdjustedGamePreview = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdjustedGamePreviewData, ThrowOnError>) => {
790
+ return (options?.client ?? client).get<GetAdjustedGamePreviewResponse, GetAdjustedGamePreviewError, ThrowOnError>({
791
+ ...options,
792
+ url: '/games/{gameId}/preview/adjusted'
793
+ });
794
+ };
795
+
796
796
  /**
797
797
  * Returns historical team records by season.
798
798
  */
package/src/types.gen.ts CHANGED
@@ -603,6 +603,8 @@ export type DetailedCoachSeason = {
603
603
  draftFollowingSeason: ((CoachDraftContext) | null);
604
604
  };
605
605
 
606
+ export type Division = 'fbs' | 'fcs' | 'ii' | 'ii/iii' | 'iii';
607
+
606
608
  export type DivisionClassification = 'fbs' | 'fcs' | 'ii' | 'ii/iii' | 'iii';
607
609
 
608
610
  export type DraftPick = {
@@ -2262,6 +2264,7 @@ export type PreviewTeamIdentity = {
2262
2264
  };
2263
2265
 
2264
2266
  export type PreviewTeamStatistics = {
2267
+ statRankings?: ((TeamSeasonStatRankings) | null);
2265
2268
  season: number;
2266
2269
  isPreviousSeason: boolean;
2267
2270
  advanced: TeamSeasonAdvancedStats;
@@ -2296,6 +2299,32 @@ export type RecentResult = {
2296
2299
 
2297
2300
  export type result = 'win' | 'loss' | 'tie' | 'unknown';
2298
2301
 
2302
+ /**
2303
+ * Construct a type with a set of properties K of type T
2304
+ */
2305
+ export type Record_StatMetricKey_TeamStatRank_or_null_ = {
2306
+ ppa: TeamStatRank;
2307
+ successRate: TeamStatRank;
2308
+ explosiveness: TeamStatRank;
2309
+ 'standardDowns.successRate': TeamStatRank;
2310
+ 'passingDowns.successRate': TeamStatRank;
2311
+ 'passingPlays.ppa': TeamStatRank;
2312
+ 'rushingPlays.ppa': TeamStatRank;
2313
+ 'passingPlays.explosiveness': TeamStatRank;
2314
+ 'rushingPlays.explosiveness': TeamStatRank;
2315
+ lineYards: TeamStatRank;
2316
+ secondLevelYards: TeamStatRank;
2317
+ openFieldYards: TeamStatRank;
2318
+ stuffRate: TeamStatRank;
2319
+ powerSuccess: TeamStatRank;
2320
+ 'havoc.total': TeamStatRank;
2321
+ 'havoc.frontSeven': TeamStatRank;
2322
+ 'havoc.db': TeamStatRank;
2323
+ pointsPerOpportunity: TeamStatRank;
2324
+ 'fieldPosition.averageStart': TeamStatRank;
2325
+ 'fieldPosition.averagePredictedPoints': TeamStatRank;
2326
+ };
2327
+
2299
2328
  export type Recruit = {
2300
2329
  id: string;
2301
2330
  athleteId: (string) | null;
@@ -2444,6 +2473,7 @@ export type ScheduleGame = {
2444
2473
  playoff: ((GamePlayoff) | null);
2445
2474
  broadcasts: PreviewSection_PreviewBroadcast_Array_;
2446
2475
  odds: PreviewSection_SelectedOdds_;
2476
+ watchabilityScore: (number) | null;
2447
2477
  };
2448
2478
 
2449
2479
  export type ScheduleWindow = {
@@ -2904,6 +2934,7 @@ export type TeamSeasonAdvancedStats = {
2904
2934
  lineYards: number;
2905
2935
  stuffRate: number;
2906
2936
  powerSuccess: (number) | null;
2937
+ powerRushAttempts?: number;
2907
2938
  explosiveness: (number) | null;
2908
2939
  successRate: number;
2909
2940
  totalPPA: number;
@@ -2958,6 +2989,7 @@ export type TeamSeasonAdvancedStats = {
2958
2989
  lineYards: number;
2959
2990
  stuffRate: number;
2960
2991
  powerSuccess: (number) | null;
2992
+ powerRushAttempts?: number;
2961
2993
  explosiveness: (number) | null;
2962
2994
  successRate: number;
2963
2995
  totalPPA: number;
@@ -2975,6 +3007,7 @@ export type TeamSeasonOverview = {
2975
3007
  };
2976
3008
  passing: ((TeamPassingSeason) | null);
2977
3009
  rushing: ((TeamRushingSeason) | null);
3010
+ statRankings?: ((TeamSeasonStatRankings) | null);
2978
3011
  /**
2979
3012
  * Completed games for the requested season, including postseason.
2980
3013
  */
@@ -3107,6 +3140,18 @@ export type TeamSeasonRankedRating = {
3107
3140
  rank: (number) | null;
3108
3141
  };
3109
3142
 
3143
+ export type TeamSeasonStatRankings = {
3144
+ teamId: number;
3145
+ season: number;
3146
+ division: Division;
3147
+ divisionTeamCount: number;
3148
+ calculatedAt: string;
3149
+ expiresAt: string;
3150
+ sourceUpdatedAt: string;
3151
+ offense: Record_StatMetricKey_TeamStatRank_or_null_;
3152
+ defense: Record_StatMetricKey_TeamStatRank_or_null_;
3153
+ };
3154
+
3110
3155
  export type TeamSP = {
3111
3156
  year: number;
3112
3157
  team: string;
@@ -3164,6 +3209,13 @@ export type TeamStat = {
3164
3209
  statValue: (string | number);
3165
3210
  };
3166
3211
 
3212
+ export type TeamStatRank = {
3213
+ rank: number;
3214
+ population: number;
3215
+ tied: boolean;
3216
+ percentile: number;
3217
+ };
3218
+
3167
3219
  export type TeamSuccessRates = {
3168
3220
  team: string;
3169
3221
  overall: StatsByQuarter;
@@ -5017,46 +5069,6 @@ export type GetUsageResponse = (((UserUsage) | null));
5017
5069
 
5018
5070
  export type GetUsageError = unknown;
5019
5071
 
5020
- export type GetGameScheduleData = {
5021
- query?: {
5022
- /**
5023
- * Division of either participant. Defaults to fbs.
5024
- */
5025
- classification?: 'fbs' | 'fcs';
5026
- /**
5027
- * Conference abbreviation of either participant.
5028
- */
5029
- conference?: string;
5030
- seasonType?: 'regular' | 'postseason';
5031
- week?: number;
5032
- year?: number;
5033
- };
5034
- };
5035
-
5036
- export type GetGameScheduleResponse = (GameSchedule);
5037
-
5038
- export type GetGameScheduleError = (GamePreviewError);
5039
-
5040
- export type GetGamePreviewData = {
5041
- path: {
5042
- gameId: number;
5043
- };
5044
- };
5045
-
5046
- export type GetGamePreviewResponse = (GamePreview);
5047
-
5048
- export type GetGamePreviewError = (GamePreviewError);
5049
-
5050
- export type GetAdjustedGamePreviewData = {
5051
- path: {
5052
- gameId: number;
5053
- };
5054
- };
5055
-
5056
- export type GetAdjustedGamePreviewResponse = (AdjustedGamePreview);
5057
-
5058
- export type GetAdjustedGamePreviewError = (GamePreviewError);
5059
-
5060
5072
  export type GetGamesData = {
5061
5073
  query?: {
5062
5074
  /**
@@ -5270,6 +5282,46 @@ export type GetWeatherResponse = (Array<GameWeather>);
5270
5282
 
5271
5283
  export type GetWeatherError = unknown;
5272
5284
 
5285
+ export type GetGameScheduleData = {
5286
+ query?: {
5287
+ /**
5288
+ * Division of either participant. Defaults to fbs.
5289
+ */
5290
+ classification?: 'fbs' | 'fcs';
5291
+ /**
5292
+ * Conference abbreviation of either participant.
5293
+ */
5294
+ conference?: string;
5295
+ seasonType?: 'regular' | 'postseason';
5296
+ week?: number;
5297
+ year?: number;
5298
+ };
5299
+ };
5300
+
5301
+ export type GetGameScheduleResponse = (GameSchedule);
5302
+
5303
+ export type GetGameScheduleError = (GamePreviewError);
5304
+
5305
+ export type GetGamePreviewData = {
5306
+ path: {
5307
+ gameId: number;
5308
+ };
5309
+ };
5310
+
5311
+ export type GetGamePreviewResponse = (GamePreview);
5312
+
5313
+ export type GetGamePreviewError = (GamePreviewError);
5314
+
5315
+ export type GetAdjustedGamePreviewData = {
5316
+ path: {
5317
+ gameId: number;
5318
+ };
5319
+ };
5320
+
5321
+ export type GetAdjustedGamePreviewResponse = (AdjustedGamePreview);
5322
+
5323
+ export type GetAdjustedGamePreviewError = (GamePreviewError);
5324
+
5273
5325
  export type GetRecordsData = {
5274
5326
  query?: {
5275
5327
  /**
package/cfbd-5.31.1.tgz DELETED
Binary file