cfbd 5.30.1 → 5.31.1

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, 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, 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';
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,6 +298,21 @@ 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>;
301
316
  /**
302
317
  * Returns historical game data.
303
318
  */
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.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.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;
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,6 +585,33 @@ 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;
588
615
  /**
589
616
  * Returns historical game data.
590
617
  */
@@ -1,3 +1,23 @@
1
+ export type AdjustedGamePreview = {
2
+ assembledAt: string;
3
+ game: GamePreviewMetadata;
4
+ availability: 'pregame' | 'metadata_only';
5
+ reason: PreviewReason;
6
+ analysis: ((AdjustedPreviewAnalysis) | null);
7
+ };
8
+ export type availability = 'pregame' | 'metadata_only';
9
+ export type AdjustedPreviewAnalysis = {
10
+ home: AdjustedPreviewTeam;
11
+ away: AdjustedPreviewTeam;
12
+ };
13
+ export type AdjustedPreviewTeam = {
14
+ teamId: number;
15
+ season: number;
16
+ teamMetrics: PreviewSection_PreviewAdjustedTeamMetrics_;
17
+ passing: PreviewSection_PreviewPlayerWepa_Array_;
18
+ rushing: PreviewSection_PreviewPlayerWepa_Array_;
19
+ kicking: PreviewSection_PreviewKickerPaar_Array_;
20
+ };
1
21
  export type AdjustedTeamMetrics = {
2
22
  year: number;
3
23
  teamId: number;
@@ -637,6 +657,22 @@ export type FieldGoalEP = {
637
657
  distance: number;
638
658
  expectedPoints: number;
639
659
  };
660
+ export type FreePreviewAnalysis = {
661
+ broadcasts: PreviewSection_PreviewBroadcast_Array_;
662
+ odds: PreviewSection_SelectedOdds_;
663
+ home: FreePreviewTeam;
664
+ away: FreePreviewTeam;
665
+ series: PreviewSection_SeriesHistory_;
666
+ };
667
+ export type FreePreviewTeam = {
668
+ teamId: number;
669
+ season: number;
670
+ record: PreviewSection_TeamSeasonOverview_at_record_;
671
+ ratings: PreviewSection_TeamSeasonOverview_at_ratings_;
672
+ statistics: PreviewSection_PreviewTeamStatistics_;
673
+ keyPlayers: PreviewKeyPlayers;
674
+ recentResults: PreviewSection_RecentResult_Array_;
675
+ };
640
676
  export type Game = {
641
677
  id: number;
642
678
  season: number;
@@ -760,6 +796,45 @@ export type GamePlayoff = {
760
796
  awaySeed: (number) | null;
761
797
  bowlName: (string) | null;
762
798
  };
799
+ export type GamePreview = {
800
+ assembledAt: string;
801
+ game: GamePreviewMetadata;
802
+ availability: 'pregame' | 'metadata_only';
803
+ reason: PreviewReason;
804
+ analysis: ((FreePreviewAnalysis) | null);
805
+ };
806
+ export type GamePreviewError = {
807
+ message: string;
808
+ };
809
+ export type GamePreviewMetadata = {
810
+ id: number;
811
+ season: number;
812
+ week: number;
813
+ seasonType: (SeasonType | 'preseason');
814
+ startDate: (string) | null;
815
+ startTimeTBD: (boolean) | null;
816
+ status: GameStatus;
817
+ statusCheckedAt: string;
818
+ neutralSite: boolean;
819
+ conferenceGame: (boolean) | null;
820
+ venue: ((PreviewVenue) | null);
821
+ homeTeam: PreviewTeamIdentity;
822
+ awayTeam: PreviewTeamIdentity;
823
+ playoff: ((GamePlayoff) | null);
824
+ };
825
+ export type GameSchedule = {
826
+ assembledAt: string;
827
+ selection: 'active' | 'next' | 'explicit' | 'none';
828
+ filters: {
829
+ conference: (string) | null;
830
+ classification: 'fbs' | 'fcs';
831
+ };
832
+ window: ((ScheduleWindow) | null);
833
+ followingWindow: ((ScheduleWindow) | null);
834
+ games: Array<ScheduleGame>;
835
+ };
836
+ export type selection = 'active' | 'next' | 'explicit' | 'none';
837
+ export type classification = 'fbs' | 'fcs';
763
838
  export type GameStatus = 'scheduled' | 'in_progress' | 'completed';
764
839
  export type GameTeamStats = {
765
840
  id: number;
@@ -1139,6 +1214,29 @@ export type PassingProduction = {
1139
1214
  export type PassLocation = 'short left' | 'short middle' | 'short right' | 'deep left' | 'deep middle' | 'deep right';
1140
1215
  export type PassOutcome = 'completion' | 'incompletion' | 'interception';
1141
1216
  export type PassParseStatus = 'complete' | 'partial' | 'invalid';
1217
+ /**
1218
+ * From T, pick a set of properties whose keys are in the union K
1219
+ */
1220
+ export type Pick_KickerPAAR_Exclude_keyofKickerPAAR_attempts__ = {
1221
+ team: string;
1222
+ year: number;
1223
+ athleteId: string;
1224
+ athleteName: string;
1225
+ conference: string;
1226
+ paar: number;
1227
+ };
1228
+ /**
1229
+ * From T, pick a set of properties whose keys are in the union K
1230
+ */
1231
+ export type Pick_PlayerWeightedEPA_Exclude_keyofPlayerWeightedEPA_plays__ = {
1232
+ team: string;
1233
+ year: number;
1234
+ athleteId: string;
1235
+ athleteName: string;
1236
+ position: string;
1237
+ conference: string;
1238
+ wepa: number;
1239
+ };
1142
1240
  export type Play = {
1143
1241
  id: string;
1144
1242
  driveId: string;
@@ -1572,6 +1670,14 @@ export type PlayerSeasonSuccessRate = {
1572
1670
  passing: PlayerSuccessRateSplit;
1573
1671
  rushing: PlayerSuccessRateSplit;
1574
1672
  };
1673
+ export type PlayerSourceAvailability = {
1674
+ status: 'available' | 'no_data' | 'unavailable';
1675
+ reason: ('no_data' | 'source_error' | 'invalid_data') | null;
1676
+ assembledAt: string;
1677
+ sourceUpdatedAt: (string) | null;
1678
+ };
1679
+ export type status = 'available' | 'no_data' | 'unavailable';
1680
+ export type reason = 'no_data' | 'source_error' | 'invalid_data';
1575
1681
  export type PlayerStat = {
1576
1682
  season: number;
1577
1683
  playerId: string;
@@ -1791,7 +1897,234 @@ export type PregameWinProbability = {
1791
1897
  spread: number;
1792
1898
  homeWinProbability: number;
1793
1899
  };
1900
+ export type PreviewAdjustedTeamMetrics = {
1901
+ season: number;
1902
+ isPreviousSeason: boolean;
1903
+ metrics: AdjustedTeamMetrics;
1904
+ };
1905
+ export type PreviewBroadcast = {
1906
+ mediaType: MediaType;
1907
+ outlet: string;
1908
+ };
1909
+ export type PreviewKeyPlayer = {
1910
+ athleteId: string;
1911
+ name: (string) | null;
1912
+ position: (string) | null;
1913
+ /**
1914
+ * Pass/rush involvement, not receiving target share.
1915
+ */
1916
+ usage: (number) | null;
1917
+ averagePPA: (number) | null;
1918
+ totalPPA: (number) | null;
1919
+ };
1920
+ export type PreviewKeyPlayers = {
1921
+ season: number;
1922
+ ppa: PlayerSourceAvailability;
1923
+ usage: PlayerSourceAvailability;
1924
+ passing: PreviewSection_PreviewKeyPlayer_Array_;
1925
+ rushing: PreviewSection_PreviewKeyPlayer_Array_;
1926
+ receiving: PreviewSection_PreviewKeyPlayer_Array_;
1927
+ };
1928
+ export type PreviewKickerPaar = {
1929
+ team: string;
1930
+ year: number;
1931
+ athleteId: string;
1932
+ athleteName: string;
1933
+ conference: string;
1934
+ paar: number;
1935
+ attempts: (number) | null;
1936
+ };
1937
+ export type PreviewPlayerWepa = {
1938
+ team: string;
1939
+ year: number;
1940
+ athleteId: string;
1941
+ athleteName: string;
1942
+ position: string;
1943
+ conference: string;
1944
+ wepa: number;
1945
+ plays: (number) | null;
1946
+ };
1947
+ export type PreviewReason = 'game_started' | 'game_completed' | 'kickoff_reached' | 'kickoff_unknown';
1948
+ export type PreviewSection_PreviewAdjustedTeamMetrics_ = {
1949
+ status: 'available' | 'no_data' | 'unavailable';
1950
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
1951
+ assembledAt: string;
1952
+ /**
1953
+ * Snapshot publication time, not a games-through cutoff.
1954
+ */
1955
+ sourceUpdatedAt: (string) | null;
1956
+ data: ((PreviewAdjustedTeamMetrics) | null);
1957
+ };
1958
+ export type reason2 = 'no_data' | 'no_results_yet' | 'source_error' | 'invalid_data';
1959
+ export type PreviewSection_PreviewBroadcast_Array_ = {
1960
+ status: 'available' | 'no_data' | 'unavailable';
1961
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
1962
+ assembledAt: string;
1963
+ /**
1964
+ * Snapshot publication time, not a games-through cutoff.
1965
+ */
1966
+ sourceUpdatedAt: (string) | null;
1967
+ data: Array<PreviewBroadcast> | null;
1968
+ };
1969
+ export type PreviewSection_PreviewKeyPlayer_Array_ = {
1970
+ status: 'available' | 'no_data' | 'unavailable';
1971
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
1972
+ assembledAt: string;
1973
+ /**
1974
+ * Snapshot publication time, not a games-through cutoff.
1975
+ */
1976
+ sourceUpdatedAt: (string) | null;
1977
+ data: Array<PreviewKeyPlayer> | null;
1978
+ };
1979
+ export type PreviewSection_PreviewKickerPaar_Array_ = {
1980
+ status: 'available' | 'no_data' | 'unavailable';
1981
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
1982
+ assembledAt: string;
1983
+ /**
1984
+ * Snapshot publication time, not a games-through cutoff.
1985
+ */
1986
+ sourceUpdatedAt: (string) | null;
1987
+ data: Array<PreviewKickerPaar> | null;
1988
+ };
1989
+ export type PreviewSection_PreviewPlayerWepa_Array_ = {
1990
+ status: 'available' | 'no_data' | 'unavailable';
1991
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
1992
+ assembledAt: string;
1993
+ /**
1994
+ * Snapshot publication time, not a games-through cutoff.
1995
+ */
1996
+ sourceUpdatedAt: (string) | null;
1997
+ data: Array<PreviewPlayerWepa> | null;
1998
+ };
1999
+ export type PreviewSection_PreviewTeamStatistics_ = {
2000
+ status: 'available' | 'no_data' | 'unavailable';
2001
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2002
+ assembledAt: string;
2003
+ /**
2004
+ * Snapshot publication time, not a games-through cutoff.
2005
+ */
2006
+ sourceUpdatedAt: (string) | null;
2007
+ data: ((PreviewTeamStatistics) | null);
2008
+ };
2009
+ export type PreviewSection_RecentResult_Array_ = {
2010
+ status: 'available' | 'no_data' | 'unavailable';
2011
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2012
+ assembledAt: string;
2013
+ /**
2014
+ * Snapshot publication time, not a games-through cutoff.
2015
+ */
2016
+ sourceUpdatedAt: (string) | null;
2017
+ data: Array<RecentResult> | null;
2018
+ };
2019
+ export type PreviewSection_SelectedOdds_ = {
2020
+ status: 'available' | 'no_data' | 'unavailable';
2021
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2022
+ assembledAt: string;
2023
+ /**
2024
+ * Snapshot publication time, not a games-through cutoff.
2025
+ */
2026
+ sourceUpdatedAt: (string) | null;
2027
+ data: ((SelectedOdds) | null);
2028
+ };
2029
+ export type PreviewSection_SeriesHistory_ = {
2030
+ status: 'available' | 'no_data' | 'unavailable';
2031
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2032
+ assembledAt: string;
2033
+ /**
2034
+ * Snapshot publication time, not a games-through cutoff.
2035
+ */
2036
+ sourceUpdatedAt: (string) | null;
2037
+ data: ((SeriesHistory) | null);
2038
+ };
2039
+ export type PreviewSection_TeamSeasonOverview_at_ratings_ = {
2040
+ status: 'available' | 'no_data' | 'unavailable';
2041
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2042
+ assembledAt: string;
2043
+ /**
2044
+ * Snapshot publication time, not a games-through cutoff.
2045
+ */
2046
+ sourceUpdatedAt: (string) | null;
2047
+ data: {
2048
+ sp: {
2049
+ specialTeams: TeamSeasonRankedRating;
2050
+ defense: TeamSeasonRankedRating;
2051
+ offense: TeamSeasonRankedRating;
2052
+ overall: TeamSeasonRankedRating;
2053
+ } | null;
2054
+ srs: ((TeamSeasonRankedRating) | null);
2055
+ /**
2056
+ * Latest available postgame Elo from a completed game in this season.
2057
+ */
2058
+ elo: (number) | null;
2059
+ core: {
2060
+ defense: TeamSeasonRankedRating;
2061
+ offense: TeamSeasonRankedRating;
2062
+ overall: TeamSeasonRankedRating;
2063
+ } | null;
2064
+ /**
2065
+ * FPI efficiencies (higher is better for all four), not the FPI points rating.
2066
+ */
2067
+ fpi: {
2068
+ specialTeams: TeamSeasonRankedRating;
2069
+ defense: TeamSeasonRankedRating;
2070
+ offense: TeamSeasonRankedRating;
2071
+ overall: TeamSeasonRankedRating;
2072
+ } | null;
2073
+ } | null;
2074
+ };
2075
+ export type PreviewSection_TeamSeasonOverview_at_record_ = {
2076
+ status: 'available' | 'no_data' | 'unavailable';
2077
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2078
+ assembledAt: string;
2079
+ /**
2080
+ * Snapshot publication time, not a games-through cutoff.
2081
+ */
2082
+ sourceUpdatedAt: (string) | null;
2083
+ data: {
2084
+ ties: number;
2085
+ losses: number;
2086
+ wins: number;
2087
+ games: number;
2088
+ } | null;
2089
+ };
2090
+ export type PreviewTeamIdentity = {
2091
+ id: number;
2092
+ name: string;
2093
+ conference: (string) | null;
2094
+ conferenceAbbreviation: (string) | null;
2095
+ classification: ((DivisionClassification) | null);
2096
+ points: (number) | null;
2097
+ };
2098
+ export type PreviewTeamStatistics = {
2099
+ season: number;
2100
+ isPreviousSeason: boolean;
2101
+ advanced: TeamSeasonAdvancedStats;
2102
+ passing: ((TeamPassingSeason) | null);
2103
+ rushing: ((TeamRushingSeason) | null);
2104
+ };
2105
+ export type PreviewVenue = {
2106
+ id: number;
2107
+ name: (string) | null;
2108
+ city: (string) | null;
2109
+ state: (string) | null;
2110
+ };
1794
2111
  export type RankingPoll = 'cfp';
2112
+ export type RecentResult = {
2113
+ gameId: number;
2114
+ season: number;
2115
+ startDate: string;
2116
+ opponent: {
2117
+ name: string;
2118
+ id: number;
2119
+ };
2120
+ homeAway: 'home' | 'away';
2121
+ neutralSite: boolean;
2122
+ venue: ((PreviewVenue) | null);
2123
+ teamPoints: (number) | null;
2124
+ opponentPoints: (number) | null;
2125
+ result: 'win' | 'loss' | 'tie' | 'unknown';
2126
+ };
2127
+ export type result = 'win' | 'loss' | 'tie' | 'unknown';
1795
2128
  export type Recruit = {
1796
2129
  id: string;
1797
2130
  athleteId: (string) | null;
@@ -1913,6 +2246,35 @@ export type RushingPlayClock = {
1913
2246
  seconds: number;
1914
2247
  };
1915
2248
  export type RushParseStatus = 'complete' | 'partial' | 'invalid';
2249
+ export type ScheduleGame = {
2250
+ id: number;
2251
+ season: number;
2252
+ week: number;
2253
+ seasonType: (SeasonType | 'preseason');
2254
+ startDate: (string) | null;
2255
+ startTimeTBD: (boolean) | null;
2256
+ status: GameStatus;
2257
+ statusCheckedAt: string;
2258
+ neutralSite: boolean;
2259
+ conferenceGame: (boolean) | null;
2260
+ venue: ((PreviewVenue) | null);
2261
+ homeTeam: PreviewTeamIdentity;
2262
+ awayTeam: PreviewTeamIdentity;
2263
+ playoff: ((GamePlayoff) | null);
2264
+ broadcasts: PreviewSection_PreviewBroadcast_Array_;
2265
+ odds: PreviewSection_SelectedOdds_;
2266
+ };
2267
+ export type ScheduleWindow = {
2268
+ year: number;
2269
+ seasonType: 'regular' | 'postseason';
2270
+ week: number;
2271
+ startDate: string;
2272
+ /**
2273
+ * Exclusive UTC bound.
2274
+ */
2275
+ endDate: string;
2276
+ };
2277
+ export type seasonType = 'regular' | 'postseason';
1916
2278
  export type ScoreboardGame = {
1917
2279
  id: number;
1918
2280
  startDate: string;
@@ -1964,6 +2326,52 @@ export type ScoreboardGame = {
1964
2326
  };
1965
2327
  export type SeasonType = 'regular' | 'postseason' | 'both' | 'allstar' | 'spring_regular' | 'spring_postseason';
1966
2328
  export type SeasonTypeDB = 'allstar' | 'postseason' | 'preseason' | 'regular' | 'spring_postseason' | 'spring_regular';
2329
+ export type SelectedOdds = {
2330
+ providerId: number;
2331
+ provider: 'DraftKings' | 'Bovada';
2332
+ /**
2333
+ * Home-relative spread; negative favors home.
2334
+ */
2335
+ spread: (number) | null;
2336
+ overUnder: (number) | null;
2337
+ homeMoneyline: (number) | null;
2338
+ awayMoneyline: (number) | null;
2339
+ };
2340
+ export type provider = 'DraftKings' | 'Bovada';
2341
+ export type SeriesHistory = {
2342
+ homeTeamId: number;
2343
+ awayTeamId: number;
2344
+ meetings: number;
2345
+ knownResults: number;
2346
+ unknownResults: number;
2347
+ homeWins: number;
2348
+ awayWins: number;
2349
+ ties: number;
2350
+ firstSeason: (number) | null;
2351
+ lastSeason: (number) | null;
2352
+ latestMeeting: ((SeriesMeeting) | null);
2353
+ streak: {
2354
+ wins: number;
2355
+ teamId: number;
2356
+ } | null;
2357
+ recentMeetings: Array<SeriesMeeting>;
2358
+ };
2359
+ export type SeriesMeeting = {
2360
+ gameId: number;
2361
+ season: number;
2362
+ startDate: string;
2363
+ homeTeamId: number;
2364
+ homeTeam: string;
2365
+ awayTeamId: number;
2366
+ awayTeam: string;
2367
+ neutralSite: boolean;
2368
+ venue: ((PreviewVenue) | null);
2369
+ homePoints: (number) | null;
2370
+ awayPoints: (number) | null;
2371
+ winnerTeamId: (number) | null;
2372
+ result: 'win' | 'tie' | 'unknown';
2373
+ };
2374
+ export type result2 = 'win' | 'tie' | 'unknown';
1967
2375
  export type StatsByQuarter = {
1968
2376
  total: number;
1969
2377
  quarter1: (number) | null;
@@ -4173,6 +4581,37 @@ export type GetUsageData = {
4173
4581
  };
4174
4582
  export type GetUsageResponse = (((UserUsage) | null));
4175
4583
  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);
4176
4615
  export type GetGamesData = {
4177
4616
  query?: {
4178
4617
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cfbd",
3
- "version": "5.30.1",
3
+ "version": "5.31.1",
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, 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, 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';
5
5
 
6
6
  export const client = createClient(createConfig({ baseUrl: 'https://api.collegefootballdata.com' }));
7
7
 
@@ -710,6 +710,39 @@ 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
+
713
746
  /**
714
747
  * Returns historical game data.
715
748
  */
package/src/types.gen.ts CHANGED
@@ -1,5 +1,29 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
 
3
+ export type AdjustedGamePreview = {
4
+ assembledAt: string;
5
+ game: GamePreviewMetadata;
6
+ availability: 'pregame' | 'metadata_only';
7
+ reason: PreviewReason;
8
+ analysis: ((AdjustedPreviewAnalysis) | null);
9
+ };
10
+
11
+ export type availability = 'pregame' | 'metadata_only';
12
+
13
+ export type AdjustedPreviewAnalysis = {
14
+ home: AdjustedPreviewTeam;
15
+ away: AdjustedPreviewTeam;
16
+ };
17
+
18
+ export type AdjustedPreviewTeam = {
19
+ teamId: number;
20
+ season: number;
21
+ teamMetrics: PreviewSection_PreviewAdjustedTeamMetrics_;
22
+ passing: PreviewSection_PreviewPlayerWepa_Array_;
23
+ rushing: PreviewSection_PreviewPlayerWepa_Array_;
24
+ kicking: PreviewSection_PreviewKickerPaar_Array_;
25
+ };
26
+
3
27
  export type AdjustedTeamMetrics = {
4
28
  year: number;
5
29
  teamId: number;
@@ -682,6 +706,24 @@ export type FieldGoalEP = {
682
706
  expectedPoints: number;
683
707
  };
684
708
 
709
+ export type FreePreviewAnalysis = {
710
+ broadcasts: PreviewSection_PreviewBroadcast_Array_;
711
+ odds: PreviewSection_SelectedOdds_;
712
+ home: FreePreviewTeam;
713
+ away: FreePreviewTeam;
714
+ series: PreviewSection_SeriesHistory_;
715
+ };
716
+
717
+ export type FreePreviewTeam = {
718
+ teamId: number;
719
+ season: number;
720
+ record: PreviewSection_TeamSeasonOverview_at_record_;
721
+ ratings: PreviewSection_TeamSeasonOverview_at_ratings_;
722
+ statistics: PreviewSection_PreviewTeamStatistics_;
723
+ keyPlayers: PreviewKeyPlayers;
724
+ recentResults: PreviewSection_RecentResult_Array_;
725
+ };
726
+
685
727
  export type Game = {
686
728
  id: number;
687
729
  season: number;
@@ -816,6 +858,51 @@ export type GamePlayoff = {
816
858
  bowlName: (string) | null;
817
859
  };
818
860
 
861
+ export type GamePreview = {
862
+ assembledAt: string;
863
+ game: GamePreviewMetadata;
864
+ availability: 'pregame' | 'metadata_only';
865
+ reason: PreviewReason;
866
+ analysis: ((FreePreviewAnalysis) | null);
867
+ };
868
+
869
+ export type GamePreviewError = {
870
+ message: string;
871
+ };
872
+
873
+ export type GamePreviewMetadata = {
874
+ id: number;
875
+ season: number;
876
+ week: number;
877
+ seasonType: (SeasonType | 'preseason');
878
+ startDate: (string) | null;
879
+ startTimeTBD: (boolean) | null;
880
+ status: GameStatus;
881
+ statusCheckedAt: string;
882
+ neutralSite: boolean;
883
+ conferenceGame: (boolean) | null;
884
+ venue: ((PreviewVenue) | null);
885
+ homeTeam: PreviewTeamIdentity;
886
+ awayTeam: PreviewTeamIdentity;
887
+ playoff: ((GamePlayoff) | null);
888
+ };
889
+
890
+ export type GameSchedule = {
891
+ assembledAt: string;
892
+ selection: 'active' | 'next' | 'explicit' | 'none';
893
+ filters: {
894
+ conference: (string) | null;
895
+ classification: 'fbs' | 'fcs';
896
+ };
897
+ window: ((ScheduleWindow) | null);
898
+ followingWindow: ((ScheduleWindow) | null);
899
+ games: Array<ScheduleGame>;
900
+ };
901
+
902
+ export type selection = 'active' | 'next' | 'explicit' | 'none';
903
+
904
+ export type classification = 'fbs' | 'fcs';
905
+
819
906
  export type GameStatus = 'scheduled' | 'in_progress' | 'completed';
820
907
 
821
908
  export type GameTeamStats = {
@@ -1220,6 +1307,31 @@ export type PassOutcome = 'completion' | 'incompletion' | 'interception';
1220
1307
 
1221
1308
  export type PassParseStatus = 'complete' | 'partial' | 'invalid';
1222
1309
 
1310
+ /**
1311
+ * From T, pick a set of properties whose keys are in the union K
1312
+ */
1313
+ export type Pick_KickerPAAR_Exclude_keyofKickerPAAR_attempts__ = {
1314
+ team: string;
1315
+ year: number;
1316
+ athleteId: string;
1317
+ athleteName: string;
1318
+ conference: string;
1319
+ paar: number;
1320
+ };
1321
+
1322
+ /**
1323
+ * From T, pick a set of properties whose keys are in the union K
1324
+ */
1325
+ export type Pick_PlayerWeightedEPA_Exclude_keyofPlayerWeightedEPA_plays__ = {
1326
+ team: string;
1327
+ year: number;
1328
+ athleteId: string;
1329
+ athleteName: string;
1330
+ position: string;
1331
+ conference: string;
1332
+ wepa: number;
1333
+ };
1334
+
1223
1335
  export type Play = {
1224
1336
  id: string;
1225
1337
  driveId: string;
@@ -1671,6 +1783,17 @@ export type PlayerSeasonSuccessRate = {
1671
1783
  rushing: PlayerSuccessRateSplit;
1672
1784
  };
1673
1785
 
1786
+ export type PlayerSourceAvailability = {
1787
+ status: 'available' | 'no_data' | 'unavailable';
1788
+ reason: ('no_data' | 'source_error' | 'invalid_data') | null;
1789
+ assembledAt: string;
1790
+ sourceUpdatedAt: (string) | null;
1791
+ };
1792
+
1793
+ export type status = 'available' | 'no_data' | 'unavailable';
1794
+
1795
+ export type reason = 'no_data' | 'source_error' | 'invalid_data';
1796
+
1674
1797
  export type PlayerStat = {
1675
1798
  season: number;
1676
1799
  playerId: string;
@@ -1920,8 +2043,259 @@ export type PregameWinProbability = {
1920
2043
  homeWinProbability: number;
1921
2044
  };
1922
2045
 
2046
+ export type PreviewAdjustedTeamMetrics = {
2047
+ season: number;
2048
+ isPreviousSeason: boolean;
2049
+ metrics: AdjustedTeamMetrics;
2050
+ };
2051
+
2052
+ export type PreviewBroadcast = {
2053
+ mediaType: MediaType;
2054
+ outlet: string;
2055
+ };
2056
+
2057
+ export type PreviewKeyPlayer = {
2058
+ athleteId: string;
2059
+ name: (string) | null;
2060
+ position: (string) | null;
2061
+ /**
2062
+ * Pass/rush involvement, not receiving target share.
2063
+ */
2064
+ usage: (number) | null;
2065
+ averagePPA: (number) | null;
2066
+ totalPPA: (number) | null;
2067
+ };
2068
+
2069
+ export type PreviewKeyPlayers = {
2070
+ season: number;
2071
+ ppa: PlayerSourceAvailability;
2072
+ usage: PlayerSourceAvailability;
2073
+ passing: PreviewSection_PreviewKeyPlayer_Array_;
2074
+ rushing: PreviewSection_PreviewKeyPlayer_Array_;
2075
+ receiving: PreviewSection_PreviewKeyPlayer_Array_;
2076
+ };
2077
+
2078
+ export type PreviewKickerPaar = {
2079
+ team: string;
2080
+ year: number;
2081
+ athleteId: string;
2082
+ athleteName: string;
2083
+ conference: string;
2084
+ paar: number;
2085
+ attempts: (number) | null;
2086
+ };
2087
+
2088
+ export type PreviewPlayerWepa = {
2089
+ team: string;
2090
+ year: number;
2091
+ athleteId: string;
2092
+ athleteName: string;
2093
+ position: string;
2094
+ conference: string;
2095
+ wepa: number;
2096
+ plays: (number) | null;
2097
+ };
2098
+
2099
+ export type PreviewReason = 'game_started' | 'game_completed' | 'kickoff_reached' | 'kickoff_unknown';
2100
+
2101
+ export type PreviewSection_PreviewAdjustedTeamMetrics_ = {
2102
+ status: 'available' | 'no_data' | 'unavailable';
2103
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2104
+ assembledAt: string;
2105
+ /**
2106
+ * Snapshot publication time, not a games-through cutoff.
2107
+ */
2108
+ sourceUpdatedAt: (string) | null;
2109
+ data: ((PreviewAdjustedTeamMetrics) | null);
2110
+ };
2111
+
2112
+ export type reason2 = 'no_data' | 'no_results_yet' | 'source_error' | 'invalid_data';
2113
+
2114
+ export type PreviewSection_PreviewBroadcast_Array_ = {
2115
+ status: 'available' | 'no_data' | 'unavailable';
2116
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2117
+ assembledAt: string;
2118
+ /**
2119
+ * Snapshot publication time, not a games-through cutoff.
2120
+ */
2121
+ sourceUpdatedAt: (string) | null;
2122
+ data: Array<PreviewBroadcast> | null;
2123
+ };
2124
+
2125
+ export type PreviewSection_PreviewKeyPlayer_Array_ = {
2126
+ status: 'available' | 'no_data' | 'unavailable';
2127
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2128
+ assembledAt: string;
2129
+ /**
2130
+ * Snapshot publication time, not a games-through cutoff.
2131
+ */
2132
+ sourceUpdatedAt: (string) | null;
2133
+ data: Array<PreviewKeyPlayer> | null;
2134
+ };
2135
+
2136
+ export type PreviewSection_PreviewKickerPaar_Array_ = {
2137
+ status: 'available' | 'no_data' | 'unavailable';
2138
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2139
+ assembledAt: string;
2140
+ /**
2141
+ * Snapshot publication time, not a games-through cutoff.
2142
+ */
2143
+ sourceUpdatedAt: (string) | null;
2144
+ data: Array<PreviewKickerPaar> | null;
2145
+ };
2146
+
2147
+ export type PreviewSection_PreviewPlayerWepa_Array_ = {
2148
+ status: 'available' | 'no_data' | 'unavailable';
2149
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2150
+ assembledAt: string;
2151
+ /**
2152
+ * Snapshot publication time, not a games-through cutoff.
2153
+ */
2154
+ sourceUpdatedAt: (string) | null;
2155
+ data: Array<PreviewPlayerWepa> | null;
2156
+ };
2157
+
2158
+ export type PreviewSection_PreviewTeamStatistics_ = {
2159
+ status: 'available' | 'no_data' | 'unavailable';
2160
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2161
+ assembledAt: string;
2162
+ /**
2163
+ * Snapshot publication time, not a games-through cutoff.
2164
+ */
2165
+ sourceUpdatedAt: (string) | null;
2166
+ data: ((PreviewTeamStatistics) | null);
2167
+ };
2168
+
2169
+ export type PreviewSection_RecentResult_Array_ = {
2170
+ status: 'available' | 'no_data' | 'unavailable';
2171
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2172
+ assembledAt: string;
2173
+ /**
2174
+ * Snapshot publication time, not a games-through cutoff.
2175
+ */
2176
+ sourceUpdatedAt: (string) | null;
2177
+ data: Array<RecentResult> | null;
2178
+ };
2179
+
2180
+ export type PreviewSection_SelectedOdds_ = {
2181
+ status: 'available' | 'no_data' | 'unavailable';
2182
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2183
+ assembledAt: string;
2184
+ /**
2185
+ * Snapshot publication time, not a games-through cutoff.
2186
+ */
2187
+ sourceUpdatedAt: (string) | null;
2188
+ data: ((SelectedOdds) | null);
2189
+ };
2190
+
2191
+ export type PreviewSection_SeriesHistory_ = {
2192
+ status: 'available' | 'no_data' | 'unavailable';
2193
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2194
+ assembledAt: string;
2195
+ /**
2196
+ * Snapshot publication time, not a games-through cutoff.
2197
+ */
2198
+ sourceUpdatedAt: (string) | null;
2199
+ data: ((SeriesHistory) | null);
2200
+ };
2201
+
2202
+ export type PreviewSection_TeamSeasonOverview_at_ratings_ = {
2203
+ status: 'available' | 'no_data' | 'unavailable';
2204
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2205
+ assembledAt: string;
2206
+ /**
2207
+ * Snapshot publication time, not a games-through cutoff.
2208
+ */
2209
+ sourceUpdatedAt: (string) | null;
2210
+ data: {
2211
+ sp: {
2212
+ specialTeams: TeamSeasonRankedRating;
2213
+ defense: TeamSeasonRankedRating;
2214
+ offense: TeamSeasonRankedRating;
2215
+ overall: TeamSeasonRankedRating;
2216
+ } | null;
2217
+ srs: ((TeamSeasonRankedRating) | null);
2218
+ /**
2219
+ * Latest available postgame Elo from a completed game in this season.
2220
+ */
2221
+ elo: (number) | null;
2222
+ core: {
2223
+ defense: TeamSeasonRankedRating;
2224
+ offense: TeamSeasonRankedRating;
2225
+ overall: TeamSeasonRankedRating;
2226
+ } | null;
2227
+ /**
2228
+ * FPI efficiencies (higher is better for all four), not the FPI points rating.
2229
+ */
2230
+ fpi: {
2231
+ specialTeams: TeamSeasonRankedRating;
2232
+ defense: TeamSeasonRankedRating;
2233
+ offense: TeamSeasonRankedRating;
2234
+ overall: TeamSeasonRankedRating;
2235
+ } | null;
2236
+ } | null;
2237
+ };
2238
+
2239
+ export type PreviewSection_TeamSeasonOverview_at_record_ = {
2240
+ status: 'available' | 'no_data' | 'unavailable';
2241
+ reason: ('no_data' | 'no_results_yet' | 'source_error' | 'invalid_data') | null;
2242
+ assembledAt: string;
2243
+ /**
2244
+ * Snapshot publication time, not a games-through cutoff.
2245
+ */
2246
+ sourceUpdatedAt: (string) | null;
2247
+ data: {
2248
+ ties: number;
2249
+ losses: number;
2250
+ wins: number;
2251
+ games: number;
2252
+ } | null;
2253
+ };
2254
+
2255
+ export type PreviewTeamIdentity = {
2256
+ id: number;
2257
+ name: string;
2258
+ conference: (string) | null;
2259
+ conferenceAbbreviation: (string) | null;
2260
+ classification: ((DivisionClassification) | null);
2261
+ points: (number) | null;
2262
+ };
2263
+
2264
+ export type PreviewTeamStatistics = {
2265
+ season: number;
2266
+ isPreviousSeason: boolean;
2267
+ advanced: TeamSeasonAdvancedStats;
2268
+ passing: ((TeamPassingSeason) | null);
2269
+ rushing: ((TeamRushingSeason) | null);
2270
+ };
2271
+
2272
+ export type PreviewVenue = {
2273
+ id: number;
2274
+ name: (string) | null;
2275
+ city: (string) | null;
2276
+ state: (string) | null;
2277
+ };
2278
+
1923
2279
  export type RankingPoll = 'cfp';
1924
2280
 
2281
+ export type RecentResult = {
2282
+ gameId: number;
2283
+ season: number;
2284
+ startDate: string;
2285
+ opponent: {
2286
+ name: string;
2287
+ id: number;
2288
+ };
2289
+ homeAway: 'home' | 'away';
2290
+ neutralSite: boolean;
2291
+ venue: ((PreviewVenue) | null);
2292
+ teamPoints: (number) | null;
2293
+ opponentPoints: (number) | null;
2294
+ result: 'win' | 'loss' | 'tie' | 'unknown';
2295
+ };
2296
+
2297
+ export type result = 'win' | 'loss' | 'tie' | 'unknown';
2298
+
1925
2299
  export type Recruit = {
1926
2300
  id: string;
1927
2301
  athleteId: (string) | null;
@@ -2053,6 +2427,38 @@ export type RushingPlayClock = {
2053
2427
 
2054
2428
  export type RushParseStatus = 'complete' | 'partial' | 'invalid';
2055
2429
 
2430
+ export type ScheduleGame = {
2431
+ id: number;
2432
+ season: number;
2433
+ week: number;
2434
+ seasonType: (SeasonType | 'preseason');
2435
+ startDate: (string) | null;
2436
+ startTimeTBD: (boolean) | null;
2437
+ status: GameStatus;
2438
+ statusCheckedAt: string;
2439
+ neutralSite: boolean;
2440
+ conferenceGame: (boolean) | null;
2441
+ venue: ((PreviewVenue) | null);
2442
+ homeTeam: PreviewTeamIdentity;
2443
+ awayTeam: PreviewTeamIdentity;
2444
+ playoff: ((GamePlayoff) | null);
2445
+ broadcasts: PreviewSection_PreviewBroadcast_Array_;
2446
+ odds: PreviewSection_SelectedOdds_;
2447
+ };
2448
+
2449
+ export type ScheduleWindow = {
2450
+ year: number;
2451
+ seasonType: 'regular' | 'postseason';
2452
+ week: number;
2453
+ startDate: string;
2454
+ /**
2455
+ * Exclusive UTC bound.
2456
+ */
2457
+ endDate: string;
2458
+ };
2459
+
2460
+ export type seasonType = 'regular' | 'postseason';
2461
+
2056
2462
  export type ScoreboardGame = {
2057
2463
  id: number;
2058
2464
  startDate: string;
@@ -2107,6 +2513,57 @@ export type SeasonType = 'regular' | 'postseason' | 'both' | 'allstar' | 'spring
2107
2513
 
2108
2514
  export type SeasonTypeDB = 'allstar' | 'postseason' | 'preseason' | 'regular' | 'spring_postseason' | 'spring_regular';
2109
2515
 
2516
+ export type SelectedOdds = {
2517
+ providerId: number;
2518
+ provider: 'DraftKings' | 'Bovada';
2519
+ /**
2520
+ * Home-relative spread; negative favors home.
2521
+ */
2522
+ spread: (number) | null;
2523
+ overUnder: (number) | null;
2524
+ homeMoneyline: (number) | null;
2525
+ awayMoneyline: (number) | null;
2526
+ };
2527
+
2528
+ export type provider = 'DraftKings' | 'Bovada';
2529
+
2530
+ export type SeriesHistory = {
2531
+ homeTeamId: number;
2532
+ awayTeamId: number;
2533
+ meetings: number;
2534
+ knownResults: number;
2535
+ unknownResults: number;
2536
+ homeWins: number;
2537
+ awayWins: number;
2538
+ ties: number;
2539
+ firstSeason: (number) | null;
2540
+ lastSeason: (number) | null;
2541
+ latestMeeting: ((SeriesMeeting) | null);
2542
+ streak: {
2543
+ wins: number;
2544
+ teamId: number;
2545
+ } | null;
2546
+ recentMeetings: Array<SeriesMeeting>;
2547
+ };
2548
+
2549
+ export type SeriesMeeting = {
2550
+ gameId: number;
2551
+ season: number;
2552
+ startDate: string;
2553
+ homeTeamId: number;
2554
+ homeTeam: string;
2555
+ awayTeamId: number;
2556
+ awayTeam: string;
2557
+ neutralSite: boolean;
2558
+ venue: ((PreviewVenue) | null);
2559
+ homePoints: (number) | null;
2560
+ awayPoints: (number) | null;
2561
+ winnerTeamId: (number) | null;
2562
+ result: 'win' | 'tie' | 'unknown';
2563
+ };
2564
+
2565
+ export type result2 = 'win' | 'tie' | 'unknown';
2566
+
2110
2567
  export type StatsByQuarter = {
2111
2568
  total: number;
2112
2569
  quarter1: (number) | null;
@@ -4560,6 +5017,46 @@ export type GetUsageResponse = (((UserUsage) | null));
4560
5017
 
4561
5018
  export type GetUsageError = unknown;
4562
5019
 
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
+
4563
5060
  export type GetGamesData = {
4564
5061
  query?: {
4565
5062
  /**
package/cfbd-5.30.1.tgz DELETED
Binary file