cfbd 5.30.1 → 5.31.0

package/dist/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import { type OptionsLegacyParser } from '@hey-api/client-fetch';
-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, GetRecordsData, GetRecordsResponse, GetCalendarData, GetCalendarResponse, GetScoreboardData, GetScoreboardResponse, GetDrivesData, GetDrivesResponse, GetDraftTeamsResponse, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksResponse, GetCoachesData, GetCoachesResponse, GetCoachProfileData, GetCoachProfileError, GetCoachSeasonsData, GetCoachSeasonsError, GetCoachSeasonsResponse, GetCoachTenuresData, GetCoachTenuresError, GetCoachTenuresResponse, GetAdvancedBoxScoreData } from './types.gen';
+import type { GetAdjustedTeamSeasonStatsData, GetAdjustedTeamSeasonStatsResponse, GetAdjustedPlayerPassingStatsData, GetAdjustedPlayerPassingStatsResponse, GetAdjustedPlayerRushingStatsData, GetAdjustedPlayerRushingStatsResponse, GetKickerPaarData, GetKickerPaarResponse, 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';
 export declare const client: import("@hey-api/client-fetch").Client<Request, Response, unknown, import("@hey-api/client-fetch").RequestOptions<boolean, string>>;
 /**
  * Returns opponent-adjusted team statistics by season.
@@ -298,6 +298,21 @@ export declare const getUserInfo: <ThrowOnError extends boolean = false>(options
  * pool. Returns `null` when the request is not authenticated.
  */
 export declare const getUsage: <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetUsageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetUsageResponse, unknown, ThrowOnError>;
+/**
+ * Returns the active or next calendar slate, including completed games.
+ * Explicit windows require year, seasonType, and week together.
+ */
+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>;
+/**
+ * Returns pregame team comparisons and key players. Started games return metadata only.
+ * Team statistics may use the previous season; players and context stay in the game season.
+ */
+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>;
+/**
+ * Returns stored adjusted team and player metrics. Requires Patreon Tier 1.
+ * Team metrics may use the previous season; players remain current-season.
+ */
+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>;
 /**
  * Returns historical game data.
  */

package/dist/sdk.gen.js

@@ -13,7 +13,7 @@ var __assign = (this && this.__assign) || function () {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 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;
-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.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;
+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;
 var client_fetch_1 = require("@hey-api/client-fetch");
 exports.client = (0, client_fetch_1.createClient)((0, client_fetch_1.createConfig)({ baseUrl: 'https://api.collegefootballdata.com' }));
 /**
@@ -585,6 +585,33 @@ var getUsage = function (options) {
     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' }));
 };
 exports.getUsage = getUsage;
+/**
+ * Returns the active or next calendar slate, including completed games.
+ * Explicit windows require year, seasonType, and week together.
+ */
+var getGameSchedule = function (options) {
+    var _a;
+    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' }));
+};
+exports.getGameSchedule = getGameSchedule;
+/**
+ * Returns pregame team comparisons and key players. Started games return metadata only.
+ * Team statistics may use the previous season; players and context stay in the game season.
+ */
+var getGamePreview = function (options) {
+    var _a;
+    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' }));
+};
+exports.getGamePreview = getGamePreview;
+/**
+ * Returns stored adjusted team and player metrics. Requires Patreon Tier 1.
+ * Team metrics may use the previous season; players remain current-season.
+ */
+var getAdjustedGamePreview = function (options) {
+    var _a;
+    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' }));
+};
+exports.getAdjustedGamePreview = getAdjustedGamePreview;
 /**
  * Returns historical game data.
  */

package/dist/types.gen.d.ts

@@ -1,3 +1,23 @@
+export type AdjustedGamePreview = {
+    assembledAt: string;
+    game: GamePreviewMetadata;
+    availability: 'pregame' | 'metadata_only';
+    reason: PreviewReason;
+    analysis: ((AdjustedPreviewAnalysis) | null);
+};
+export type availability = 'pregame' | 'metadata_only';
+export type AdjustedPreviewAnalysis = {
+    home: AdjustedPreviewTeam;
+    away: AdjustedPreviewTeam;
+};
+export type AdjustedPreviewTeam = {
+    teamId: number;
+    season: number;
+    teamMetrics: PreviewSection_PreviewAdjustedTeamMetrics_;
+    passing: PreviewSection_PreviewPlayerWepa_Array_;
+    rushing: PreviewSection_PreviewPlayerWepa_Array_;
+    kicking: PreviewSection_PreviewKickerPaar_Array_;
+};
 export type AdjustedTeamMetrics = {
     year: number;
     teamId: number;
@@ -637,6 +657,22 @@ export type FieldGoalEP = {
     distance: number;
     expectedPoints: number;
 };
+export type FreePreviewAnalysis = {
+    broadcasts: PreviewSection_PreviewBroadcast_Array_;
+    odds: PreviewSection_SelectedOdds_;
+    home: FreePreviewTeam;
+    away: FreePreviewTeam;
+    series: PreviewSection_SeriesHistory_;
+};
+export type FreePreviewTeam = {
+    teamId: number;
+    season: number;
+    record: PreviewSection_TeamSeasonOverview_at_record_;
+    ratings: PreviewSection_TeamSeasonOverview_at_ratings_;
+    statistics: PreviewSection_PreviewTeamStatistics_;
+    keyPlayers: PreviewKeyPlayers;
+    recentResults: PreviewSection_RecentResult_Array_;
+};
 export type Game = {
     id: number;
     season: number;
@@ -760,6 +796,45 @@ export type GamePlayoff = {
     awaySeed: (number) | null;
     bowlName: (string) | null;
 };
+export type GamePreview = {
+    assembledAt: string;
+    game: GamePreviewMetadata;
+    availability: 'pregame' | 'metadata_only';
+    reason: PreviewReason;
+    analysis: ((FreePreviewAnalysis) | null);
+};
+export type GamePreviewError = {
+    message: string;
+};
+export type GamePreviewMetadata = {
+    id: number;
+    season: number;
+    week: number;
+    seasonType: (SeasonType | 'preseason');
+    startDate: (string) | null;
+    startTimeTBD: (boolean) | null;
+    status: GameStatus;
+    statusCheckedAt: string;
+    neutralSite: boolean;
+    conferenceGame: (boolean) | null;
+    venue: ((PreviewVenue) | null);
+    homeTeam: PreviewTeamIdentity;
+    awayTeam: PreviewTeamIdentity;
+    playoff: ((GamePlayoff) | null);
+};
+export type GameSchedule = {
+    assembledAt: string;
+    selection: 'active' | 'next' | 'explicit' | 'none';
+    filters: {
+        conference: (string) | null;
+        classification: 'fbs' | 'fcs';
+    };
+    window: ((ScheduleWindow) | null);
+    followingWindow: ((ScheduleWindow) | null);
+    games: Array<ScheduleGame>;
+};
+export type selection = 'active' | 'next' | 'explicit' | 'none';
+export type classification = 'fbs' | 'fcs';
 export type GameStatus = 'scheduled' | 'in_progress' | 'completed';
 export type GameTeamStats = {
     id: number;
@@ -1139,6 +1214,29 @@ export type PassingProduction = {
 export type PassLocation = 'short left' | 'short middle' | 'short right' | 'deep left' | 'deep middle' | 'deep right';
 export type PassOutcome = 'completion' | 'incompletion' | 'interception';
 export type PassParseStatus = 'complete' | 'partial' | 'invalid';
+/**
+ * From T, pick a set of properties whose keys are in the union K
+ */
+export type Pick_KickerPAAR_Exclude_keyofKickerPAAR_attempts__ = {
+    team: string;
+    year: number;
+    athleteId: string;
+    athleteName: string;
+    conference: string;
+    paar: number;
+};
+/**
+ * From T, pick a set of properties whose keys are in the union K
+ */
+export type Pick_PlayerWeightedEPA_Exclude_keyofPlayerWeightedEPA_plays__ = {
+    team: string;
+    year: number;
+    athleteId: string;
+    athleteName: string;
+    position: string;
+    conference: string;
+    wepa: number;
+};
 export type Play = {
     id: string;
     driveId: string;
@@ -1572,6 +1670,14 @@ export type PlayerSeasonSuccessRate = {
     passing: PlayerSuccessRateSplit;
     rushing: PlayerSuccessRateSplit;
 };
+export type PlayerSourceAvailability = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    sourceUpdatedAt: (string) | null;
+};
+export type status = 'available' | 'no_data' | 'unavailable';
+export type reason = 'no_data' | 'source_error' | 'invalid_data';
 export type PlayerStat = {
     season: number;
     playerId: string;
@@ -1791,7 +1897,234 @@ export type PregameWinProbability = {
     spread: number;
     homeWinProbability: number;
 };
+export type PreviewAdjustedTeamMetrics = {
+    season: number;
+    isPreviousSeason: boolean;
+    metrics: AdjustedTeamMetrics;
+};
+export type PreviewBroadcast = {
+    mediaType: MediaType;
+    outlet: string;
+};
+export type PreviewKeyPlayer = {
+    athleteId: string;
+    name: (string) | null;
+    position: (string) | null;
+    /**
+     * Pass/rush involvement, not receiving target share.
+     */
+    usage: (number) | null;
+    averagePPA: (number) | null;
+    totalPPA: (number) | null;
+};
+export type PreviewKeyPlayers = {
+    season: number;
+    ppa: PlayerSourceAvailability;
+    usage: PlayerSourceAvailability;
+    passing: PreviewSection_PreviewKeyPlayer_Array_;
+    rushing: PreviewSection_PreviewKeyPlayer_Array_;
+    receiving: PreviewSection_PreviewKeyPlayer_Array_;
+};
+export type PreviewKickerPaar = {
+    team: string;
+    year: number;
+    athleteId: string;
+    athleteName: string;
+    conference: string;
+    paar: number;
+    attempts: (number) | null;
+};
+export type PreviewPlayerWepa = {
+    team: string;
+    year: number;
+    athleteId: string;
+    athleteName: string;
+    position: string;
+    conference: string;
+    wepa: number;
+    plays: (number) | null;
+};
+export type PreviewReason = 'game_started' | 'game_completed' | 'kickoff_reached' | 'kickoff_unknown';
+export type PreviewSection_PreviewAdjustedTeamMetrics_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: ((PreviewAdjustedTeamMetrics) | null);
+};
+export type reason2 = 'no_data' | 'no_results_yet' | 'source_error' | 'invalid_data';
+export type PreviewSection_PreviewBroadcast_Array_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: Array<PreviewBroadcast> | null;
+};
+export type PreviewSection_PreviewKeyPlayer_Array_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: Array<PreviewKeyPlayer> | null;
+};
+export type PreviewSection_PreviewKickerPaar_Array_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: Array<PreviewKickerPaar> | null;
+};
+export type PreviewSection_PreviewPlayerWepa_Array_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: Array<PreviewPlayerWepa> | null;
+};
+export type PreviewSection_PreviewTeamStatistics_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: ((PreviewTeamStatistics) | null);
+};
+export type PreviewSection_RecentResult_Array_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: Array<RecentResult> | null;
+};
+export type PreviewSection_SelectedOdds_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: ((SelectedOdds) | null);
+};
+export type PreviewSection_SeriesHistory_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: ((SeriesHistory) | null);
+};
+export type PreviewSection_TeamSeasonOverview_at_ratings_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: {
+        sp: {
+            specialTeams: TeamSeasonRankedRating;
+            defense: TeamSeasonRankedRating;
+            offense: TeamSeasonRankedRating;
+            overall: TeamSeasonRankedRating;
+        } | null;
+        srs: ((TeamSeasonRankedRating) | null);
+        /**
+         * Latest available postgame Elo from a completed game in this season.
+         */
+        elo: (number) | null;
+        core: {
+            defense: TeamSeasonRankedRating;
+            offense: TeamSeasonRankedRating;
+            overall: TeamSeasonRankedRating;
+        } | null;
+        /**
+         * FPI efficiencies (higher is better for all four), not the FPI points rating.
+         */
+        fpi: {
+            specialTeams: TeamSeasonRankedRating;
+            defense: TeamSeasonRankedRating;
+            offense: TeamSeasonRankedRating;
+            overall: TeamSeasonRankedRating;
+        } | null;
+    } | null;
+};
+export type PreviewSection_TeamSeasonOverview_at_record_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: {
+        ties: number;
+        losses: number;
+        wins: number;
+        games: number;
+    } | null;
+};
+export type PreviewTeamIdentity = {
+    id: number;
+    name: string;
+    conference: (string) | null;
+    conferenceAbbreviation: (string) | null;
+    classification: ((DivisionClassification) | null);
+    points: (number) | null;
+};
+export type PreviewTeamStatistics = {
+    season: number;
+    isPreviousSeason: boolean;
+    advanced: TeamSeasonAdvancedStats;
+    passing: ((TeamPassingSeason) | null);
+    rushing: ((TeamRushingSeason) | null);
+};
+export type PreviewVenue = {
+    id: number;
+    name: (string) | null;
+    city: (string) | null;
+    state: (string) | null;
+};
 export type RankingPoll = 'cfp';
+export type RecentResult = {
+    gameId: number;
+    season: number;
+    startDate: string;
+    opponent: {
+        name: string;
+        id: number;
+    };
+    homeAway: 'home' | 'away';
+    neutralSite: boolean;
+    venue: ((PreviewVenue) | null);
+    teamPoints: (number) | null;
+    opponentPoints: (number) | null;
+    result: 'win' | 'loss' | 'tie' | 'unknown';
+};
+export type result = 'win' | 'loss' | 'tie' | 'unknown';
 export type Recruit = {
     id: string;
     athleteId: (string) | null;
@@ -1913,6 +2246,35 @@ export type RushingPlayClock = {
     seconds: number;
 };
 export type RushParseStatus = 'complete' | 'partial' | 'invalid';
+export type ScheduleGame = {
+    id: number;
+    season: number;
+    week: number;
+    seasonType: (SeasonType | 'preseason');
+    startDate: (string) | null;
+    startTimeTBD: (boolean) | null;
+    status: GameStatus;
+    statusCheckedAt: string;
+    neutralSite: boolean;
+    conferenceGame: (boolean) | null;
+    venue: ((PreviewVenue) | null);
+    homeTeam: PreviewTeamIdentity;
+    awayTeam: PreviewTeamIdentity;
+    playoff: ((GamePlayoff) | null);
+    broadcasts: PreviewSection_PreviewBroadcast_Array_;
+    odds: PreviewSection_SelectedOdds_;
+};
+export type ScheduleWindow = {
+    year: number;
+    seasonType: 'regular' | 'postseason';
+    week: number;
+    startDate: string;
+    /**
+     * Exclusive UTC bound.
+     */
+    endDate: string;
+};
+export type seasonType = 'regular' | 'postseason';
 export type ScoreboardGame = {
     id: number;
     startDate: string;
@@ -1964,6 +2326,52 @@ export type ScoreboardGame = {
 };
 export type SeasonType = 'regular' | 'postseason' | 'both' | 'allstar' | 'spring_regular' | 'spring_postseason';
 export type SeasonTypeDB = 'allstar' | 'postseason' | 'preseason' | 'regular' | 'spring_postseason' | 'spring_regular';
+export type SelectedOdds = {
+    providerId: number;
+    provider: 'DraftKings' | 'Bovada';
+    /**
+     * Home-relative spread; negative favors home.
+     */
+    spread: (number) | null;
+    overUnder: (number) | null;
+    homeMoneyline: (number) | null;
+    awayMoneyline: (number) | null;
+};
+export type provider = 'DraftKings' | 'Bovada';
+export type SeriesHistory = {
+    homeTeamId: number;
+    awayTeamId: number;
+    meetings: number;
+    knownResults: number;
+    unknownResults: number;
+    homeWins: number;
+    awayWins: number;
+    ties: number;
+    firstSeason: (number) | null;
+    lastSeason: (number) | null;
+    latestMeeting: ((SeriesMeeting) | null);
+    streak: {
+        wins: number;
+        teamId: number;
+    } | null;
+    recentMeetings: Array<SeriesMeeting>;
+};
+export type SeriesMeeting = {
+    gameId: number;
+    season: number;
+    startDate: string;
+    homeTeamId: number;
+    homeTeam: string;
+    awayTeamId: number;
+    awayTeam: string;
+    neutralSite: boolean;
+    venue: ((PreviewVenue) | null);
+    homePoints: (number) | null;
+    awayPoints: (number) | null;
+    winnerTeamId: (number) | null;
+    result: 'win' | 'tie' | 'unknown';
+};
+export type result2 = 'win' | 'tie' | 'unknown';
 export type StatsByQuarter = {
     total: number;
     quarter1: (number) | null;
@@ -4173,6 +4581,37 @@ export type GetUsageData = {
 };
 export type GetUsageResponse = (((UserUsage) | null));
 export type GetUsageError = unknown;
+export type GetGameScheduleData = {
+    query?: {
+        /**
+         * Division of either participant. Defaults to fbs.
+         */
+        classification?: 'fbs' | 'fcs';
+        /**
+         * Conference abbreviation of either participant.
+         */
+        conference?: string;
+        seasonType?: 'regular' | 'postseason';
+        week?: number;
+        year?: number;
+    };
+};
+export type GetGameScheduleResponse = (GameSchedule);
+export type GetGameScheduleError = (GamePreviewError);
+export type GetGamePreviewData = {
+    path: {
+        gameId: number;
+    };
+};
+export type GetGamePreviewResponse = (GamePreview);
+export type GetGamePreviewError = (GamePreviewError);
+export type GetAdjustedGamePreviewData = {
+    path: {
+        gameId: number;
+    };
+};
+export type GetAdjustedGamePreviewResponse = (AdjustedGamePreview);
+export type GetAdjustedGamePreviewError = (GamePreviewError);
 export type GetGamesData = {
     query?: {
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cfbd",
-  "version": "5.30.1",
+  "version": "5.31.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, 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, 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, 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';
 
 export const client = createClient(createConfig({ baseUrl: 'https://api.collegefootballdata.com' }));
 
@@ -710,6 +710,39 @@ export const getUsage = <ThrowOnError extends boolean = false>(options?: Options
     });
 };
 
+/**
+ * Returns the active or next calendar slate, including completed games.
+ * Explicit windows require year, seasonType, and week together.
+ */
+export const getGameSchedule = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<GetGameScheduleData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetGameScheduleResponse, GetGameScheduleError, ThrowOnError>({
+        ...options,
+        url: '/games/schedule'
+    });
+};
+
+/**
+ * Returns pregame team comparisons and key players. Started games return metadata only.
+ * Team statistics may use the previous season; players and context stay in the game season.
+ */
+export const getGamePreview = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetGamePreviewData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetGamePreviewResponse, GetGamePreviewError, ThrowOnError>({
+        ...options,
+        url: '/games/{gameId}/preview'
+    });
+};
+
+/**
+ * Returns stored adjusted team and player metrics. Requires Patreon Tier 1.
+ * Team metrics may use the previous season; players remain current-season.
+ */
+export const getAdjustedGamePreview = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdjustedGamePreviewData, ThrowOnError>) => {
+    return (options?.client ?? client).get<GetAdjustedGamePreviewResponse, GetAdjustedGamePreviewError, ThrowOnError>({
+        ...options,
+        url: '/games/{gameId}/preview/adjusted'
+    });
+};
+
 /**
  * Returns historical game data.
  */

package/src/types.gen.ts

@@ -1,5 +1,29 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
+export type AdjustedGamePreview = {
+    assembledAt: string;
+    game: GamePreviewMetadata;
+    availability: 'pregame' | 'metadata_only';
+    reason: PreviewReason;
+    analysis: ((AdjustedPreviewAnalysis) | null);
+};
+
+export type availability = 'pregame' | 'metadata_only';
+
+export type AdjustedPreviewAnalysis = {
+    home: AdjustedPreviewTeam;
+    away: AdjustedPreviewTeam;
+};
+
+export type AdjustedPreviewTeam = {
+    teamId: number;
+    season: number;
+    teamMetrics: PreviewSection_PreviewAdjustedTeamMetrics_;
+    passing: PreviewSection_PreviewPlayerWepa_Array_;
+    rushing: PreviewSection_PreviewPlayerWepa_Array_;
+    kicking: PreviewSection_PreviewKickerPaar_Array_;
+};
+
 export type AdjustedTeamMetrics = {
     year: number;
     teamId: number;
@@ -682,6 +706,24 @@ export type FieldGoalEP = {
     expectedPoints: number;
 };
 
+export type FreePreviewAnalysis = {
+    broadcasts: PreviewSection_PreviewBroadcast_Array_;
+    odds: PreviewSection_SelectedOdds_;
+    home: FreePreviewTeam;
+    away: FreePreviewTeam;
+    series: PreviewSection_SeriesHistory_;
+};
+
+export type FreePreviewTeam = {
+    teamId: number;
+    season: number;
+    record: PreviewSection_TeamSeasonOverview_at_record_;
+    ratings: PreviewSection_TeamSeasonOverview_at_ratings_;
+    statistics: PreviewSection_PreviewTeamStatistics_;
+    keyPlayers: PreviewKeyPlayers;
+    recentResults: PreviewSection_RecentResult_Array_;
+};
+
 export type Game = {
     id: number;
     season: number;
@@ -816,6 +858,51 @@ export type GamePlayoff = {
     bowlName: (string) | null;
 };
 
+export type GamePreview = {
+    assembledAt: string;
+    game: GamePreviewMetadata;
+    availability: 'pregame' | 'metadata_only';
+    reason: PreviewReason;
+    analysis: ((FreePreviewAnalysis) | null);
+};
+
+export type GamePreviewError = {
+    message: string;
+};
+
+export type GamePreviewMetadata = {
+    id: number;
+    season: number;
+    week: number;
+    seasonType: (SeasonType | 'preseason');
+    startDate: (string) | null;
+    startTimeTBD: (boolean) | null;
+    status: GameStatus;
+    statusCheckedAt: string;
+    neutralSite: boolean;
+    conferenceGame: (boolean) | null;
+    venue: ((PreviewVenue) | null);
+    homeTeam: PreviewTeamIdentity;
+    awayTeam: PreviewTeamIdentity;
+    playoff: ((GamePlayoff) | null);
+};
+
+export type GameSchedule = {
+    assembledAt: string;
+    selection: 'active' | 'next' | 'explicit' | 'none';
+    filters: {
+        conference: (string) | null;
+        classification: 'fbs' | 'fcs';
+    };
+    window: ((ScheduleWindow) | null);
+    followingWindow: ((ScheduleWindow) | null);
+    games: Array<ScheduleGame>;
+};
+
+export type selection = 'active' | 'next' | 'explicit' | 'none';
+
+export type classification = 'fbs' | 'fcs';
+
 export type GameStatus = 'scheduled' | 'in_progress' | 'completed';
 
 export type GameTeamStats = {
@@ -1220,6 +1307,31 @@ export type PassOutcome = 'completion' | 'incompletion' | 'interception';
 
 export type PassParseStatus = 'complete' | 'partial' | 'invalid';
 
+/**
+ * From T, pick a set of properties whose keys are in the union K
+ */
+export type Pick_KickerPAAR_Exclude_keyofKickerPAAR_attempts__ = {
+    team: string;
+    year: number;
+    athleteId: string;
+    athleteName: string;
+    conference: string;
+    paar: number;
+};
+
+/**
+ * From T, pick a set of properties whose keys are in the union K
+ */
+export type Pick_PlayerWeightedEPA_Exclude_keyofPlayerWeightedEPA_plays__ = {
+    team: string;
+    year: number;
+    athleteId: string;
+    athleteName: string;
+    position: string;
+    conference: string;
+    wepa: number;
+};
+
 export type Play = {
     id: string;
     driveId: string;
@@ -1671,6 +1783,17 @@ export type PlayerSeasonSuccessRate = {
     rushing: PlayerSuccessRateSplit;
 };
 
+export type PlayerSourceAvailability = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    sourceUpdatedAt: (string) | null;
+};
+
+export type status = 'available' | 'no_data' | 'unavailable';
+
+export type reason = 'no_data' | 'source_error' | 'invalid_data';
+
 export type PlayerStat = {
     season: number;
     playerId: string;
@@ -1920,8 +2043,259 @@ export type PregameWinProbability = {
     homeWinProbability: number;
 };
 
+export type PreviewAdjustedTeamMetrics = {
+    season: number;
+    isPreviousSeason: boolean;
+    metrics: AdjustedTeamMetrics;
+};
+
+export type PreviewBroadcast = {
+    mediaType: MediaType;
+    outlet: string;
+};
+
+export type PreviewKeyPlayer = {
+    athleteId: string;
+    name: (string) | null;
+    position: (string) | null;
+    /**
+     * Pass/rush involvement, not receiving target share.
+     */
+    usage: (number) | null;
+    averagePPA: (number) | null;
+    totalPPA: (number) | null;
+};
+
+export type PreviewKeyPlayers = {
+    season: number;
+    ppa: PlayerSourceAvailability;
+    usage: PlayerSourceAvailability;
+    passing: PreviewSection_PreviewKeyPlayer_Array_;
+    rushing: PreviewSection_PreviewKeyPlayer_Array_;
+    receiving: PreviewSection_PreviewKeyPlayer_Array_;
+};
+
+export type PreviewKickerPaar = {
+    team: string;
+    year: number;
+    athleteId: string;
+    athleteName: string;
+    conference: string;
+    paar: number;
+    attempts: (number) | null;
+};
+
+export type PreviewPlayerWepa = {
+    team: string;
+    year: number;
+    athleteId: string;
+    athleteName: string;
+    position: string;
+    conference: string;
+    wepa: number;
+    plays: (number) | null;
+};
+
+export type PreviewReason = 'game_started' | 'game_completed' | 'kickoff_reached' | 'kickoff_unknown';
+
+export type PreviewSection_PreviewAdjustedTeamMetrics_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: ((PreviewAdjustedTeamMetrics) | null);
+};
+
+export type reason2 = 'no_data' | 'no_results_yet' | 'source_error' | 'invalid_data';
+
+export type PreviewSection_PreviewBroadcast_Array_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: Array<PreviewBroadcast> | null;
+};
+
+export type PreviewSection_PreviewKeyPlayer_Array_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: Array<PreviewKeyPlayer> | null;
+};
+
+export type PreviewSection_PreviewKickerPaar_Array_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: Array<PreviewKickerPaar> | null;
+};
+
+export type PreviewSection_PreviewPlayerWepa_Array_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: Array<PreviewPlayerWepa> | null;
+};
+
+export type PreviewSection_PreviewTeamStatistics_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: ((PreviewTeamStatistics) | null);
+};
+
+export type PreviewSection_RecentResult_Array_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: Array<RecentResult> | null;
+};
+
+export type PreviewSection_SelectedOdds_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: ((SelectedOdds) | null);
+};
+
+export type PreviewSection_SeriesHistory_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: ((SeriesHistory) | null);
+};
+
+export type PreviewSection_TeamSeasonOverview_at_ratings_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: {
+        sp: {
+            specialTeams: TeamSeasonRankedRating;
+            defense: TeamSeasonRankedRating;
+            offense: TeamSeasonRankedRating;
+            overall: TeamSeasonRankedRating;
+        } | null;
+        srs: ((TeamSeasonRankedRating) | null);
+        /**
+         * Latest available postgame Elo from a completed game in this season.
+         */
+        elo: (number) | null;
+        core: {
+            defense: TeamSeasonRankedRating;
+            offense: TeamSeasonRankedRating;
+            overall: TeamSeasonRankedRating;
+        } | null;
+        /**
+         * FPI efficiencies (higher is better for all four), not the FPI points rating.
+         */
+        fpi: {
+            specialTeams: TeamSeasonRankedRating;
+            defense: TeamSeasonRankedRating;
+            offense: TeamSeasonRankedRating;
+            overall: TeamSeasonRankedRating;
+        } | null;
+    } | null;
+};
+
+export type PreviewSection_TeamSeasonOverview_at_record_ = {
+    status: 'available' | 'no_data' | 'unavailable';
+    reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
+    assembledAt: string;
+    /**
+     * Snapshot publication time, not a games-through cutoff.
+     */
+    sourceUpdatedAt: (string) | null;
+    data: {
+        ties: number;
+        losses: number;
+        wins: number;
+        games: number;
+    } | null;
+};
+
+export type PreviewTeamIdentity = {
+    id: number;
+    name: string;
+    conference: (string) | null;
+    conferenceAbbreviation: (string) | null;
+    classification: ((DivisionClassification) | null);
+    points: (number) | null;
+};
+
+export type PreviewTeamStatistics = {
+    season: number;
+    isPreviousSeason: boolean;
+    advanced: TeamSeasonAdvancedStats;
+    passing: ((TeamPassingSeason) | null);
+    rushing: ((TeamRushingSeason) | null);
+};
+
+export type PreviewVenue = {
+    id: number;
+    name: (string) | null;
+    city: (string) | null;
+    state: (string) | null;
+};
+
 export type RankingPoll = 'cfp';
 
+export type RecentResult = {
+    gameId: number;
+    season: number;
+    startDate: string;
+    opponent: {
+        name: string;
+        id: number;
+    };
+    homeAway: 'home' | 'away';
+    neutralSite: boolean;
+    venue: ((PreviewVenue) | null);
+    teamPoints: (number) | null;
+    opponentPoints: (number) | null;
+    result: 'win' | 'loss' | 'tie' | 'unknown';
+};
+
+export type result = 'win' | 'loss' | 'tie' | 'unknown';
+
 export type Recruit = {
     id: string;
     athleteId: (string) | null;
@@ -2053,6 +2427,38 @@ export type RushingPlayClock = {
 
 export type RushParseStatus = 'complete' | 'partial' | 'invalid';
 
+export type ScheduleGame = {
+    id: number;
+    season: number;
+    week: number;
+    seasonType: (SeasonType | 'preseason');
+    startDate: (string) | null;
+    startTimeTBD: (boolean) | null;
+    status: GameStatus;
+    statusCheckedAt: string;
+    neutralSite: boolean;
+    conferenceGame: (boolean) | null;
+    venue: ((PreviewVenue) | null);
+    homeTeam: PreviewTeamIdentity;
+    awayTeam: PreviewTeamIdentity;
+    playoff: ((GamePlayoff) | null);
+    broadcasts: PreviewSection_PreviewBroadcast_Array_;
+    odds: PreviewSection_SelectedOdds_;
+};
+
+export type ScheduleWindow = {
+    year: number;
+    seasonType: 'regular' | 'postseason';
+    week: number;
+    startDate: string;
+    /**
+     * Exclusive UTC bound.
+     */
+    endDate: string;
+};
+
+export type seasonType = 'regular' | 'postseason';
+
 export type ScoreboardGame = {
     id: number;
     startDate: string;
@@ -2107,6 +2513,57 @@ export type SeasonType = 'regular' | 'postseason' | 'both' | 'allstar' | 'spring
 
 export type SeasonTypeDB = 'allstar' | 'postseason' | 'preseason' | 'regular' | 'spring_postseason' | 'spring_regular';
 
+export type SelectedOdds = {
+    providerId: number;
+    provider: 'DraftKings' | 'Bovada';
+    /**
+     * Home-relative spread; negative favors home.
+     */
+    spread: (number) | null;
+    overUnder: (number) | null;
+    homeMoneyline: (number) | null;
+    awayMoneyline: (number) | null;
+};
+
+export type provider = 'DraftKings' | 'Bovada';
+
+export type SeriesHistory = {
+    homeTeamId: number;
+    awayTeamId: number;
+    meetings: number;
+    knownResults: number;
+    unknownResults: number;
+    homeWins: number;
+    awayWins: number;
+    ties: number;
+    firstSeason: (number) | null;
+    lastSeason: (number) | null;
+    latestMeeting: ((SeriesMeeting) | null);
+    streak: {
+        wins: number;
+        teamId: number;
+    } | null;
+    recentMeetings: Array<SeriesMeeting>;
+};
+
+export type SeriesMeeting = {
+    gameId: number;
+    season: number;
+    startDate: string;
+    homeTeamId: number;
+    homeTeam: string;
+    awayTeamId: number;
+    awayTeam: string;
+    neutralSite: boolean;
+    venue: ((PreviewVenue) | null);
+    homePoints: (number) | null;
+    awayPoints: (number) | null;
+    winnerTeamId: (number) | null;
+    result: 'win' | 'tie' | 'unknown';
+};
+
+export type result2 = 'win' | 'tie' | 'unknown';
+
 export type StatsByQuarter = {
     total: number;
     quarter1: (number) | null;
@@ -4560,6 +5017,46 @@ export type GetUsageResponse = (((UserUsage) | null));
 
 export type GetUsageError = unknown;
 
+export type GetGameScheduleData = {
+    query?: {
+        /**
+         * Division of either participant. Defaults to fbs.
+         */
+        classification?: 'fbs' | 'fcs';
+        /**
+         * Conference abbreviation of either participant.
+         */
+        conference?: string;
+        seasonType?: 'regular' | 'postseason';
+        week?: number;
+        year?: number;
+    };
+};
+
+export type GetGameScheduleResponse = (GameSchedule);
+
+export type GetGameScheduleError = (GamePreviewError);
+
+export type GetGamePreviewData = {
+    path: {
+        gameId: number;
+    };
+};
+
+export type GetGamePreviewResponse = (GamePreview);
+
+export type GetGamePreviewError = (GamePreviewError);
+
+export type GetAdjustedGamePreviewData = {
+    path: {
+        gameId: number;
+    };
+};
+
+export type GetAdjustedGamePreviewResponse = (AdjustedGamePreview);
+
+export type GetAdjustedGamePreviewError = (GamePreviewError);
+
 export type GetGamesData = {
     query?: {
         /**